Class: Google::Cloud::Dialogflow::CX::V3::Experiment

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb

Overview

Represents an experiment in an environment.

Defined Under Namespace

Modules: State Classes: Definition, Result

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Creation time of this experiment.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#definition ⇒ ::Google::Cloud::Dialogflow::CX::V3::Experiment::Definition

Returns The definition of the experiment.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#description ⇒ ::String

Returns The human-readable description of the experiment.

Returns:

  • (::String) —

    The human-readable description of the experiment.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

Returns:

  • (::String) —

    Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns End time of this experiment.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#experiment_length ⇒ ::Google::Protobuf::Duration

Returns Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.

Returns:

  • (::Google::Protobuf::Duration) —

    Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#last_update_time ⇒ ::Google::Protobuf::Timestamp

Returns Last update time of this experiment.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#name ⇒ ::String

Returns The name of the experiment. Format: projects//locations//agents//environments//experiments/.

Returns:

  • (::String) —

    The name of the experiment. Format: projects//locations//agents//environments//experiments/.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#result ⇒ ::Google::Cloud::Dialogflow::CX::V3::Experiment::Result

Returns Inference result of the experiment.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#rollout_config ⇒ ::Google::Cloud::Dialogflow::CX::V3::RolloutConfig

Returns The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.

Returns:

  • (::Google::Cloud::Dialogflow::CX::V3::RolloutConfig) —

    The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#rollout_failure_reason ⇒ ::String

Returns The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

Returns:

  • (::String) —

    The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#rollout_state ⇒ ::Google::Cloud::Dialogflow::CX::V3::RolloutState

Returns State of the auto rollout process.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns Start time of this experiment.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#state ⇒ ::Google::Cloud::Dialogflow::CX::V3::Experiment::State

Returns The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end

#variants_history ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::VariantsHistory>

Returns The history of updates to the experiment variants.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb', line 84

class Experiment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of the experiment.
  # @!attribute [rw] condition
  #   @return [::String]
  #     The condition defines which subset of sessions are selected for
  #     this experiment. If not specified, all sessions are eligible. E.g.
  #     "query_input.language_code=en" See the [conditions
  #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
  # @!attribute [rw] version_variants
  #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
  #     The flow versions as the variants of this experiment.
  class Definition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The inference result which includes an objective metric to optimize and the
  # confidence interval.
  # @!attribute [rw] version_metrics
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
  #     Version variants and metrics.
  # @!attribute [rw] last_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time the experiment's stats data was updated. Will have default
  #     value if stats have never been computed for this experiment.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A confidence interval is a range of possible values for the experiment
    # objective you are trying to measure.
    # @!attribute [rw] confidence_level
    #   @return [::Float]
    #     The confidence level used to construct the interval, i.e. there is X%
    #     chance that the true value is within this interval.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     The percent change between an experiment metric's value and the value
    #     for its control.
    # @!attribute [rw] lower_bound
    #   @return [::Float]
    #     Lower bound of the interval.
    # @!attribute [rw] upper_bound
    #   @return [::Float]
    #     Upper bound of the interval.
    class ConfidenceInterval
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Metric and corresponding confidence intervals.
    # @!attribute [rw] type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
    #     Ratio-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] count_type
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
    #     Count-based metric type. Only one of type or count_type is specified in
    #     each Metric.
    # @!attribute [rw] ratio
    #   @return [::Float]
    #     Ratio value of a metric.
    # @!attribute [rw] count
    #   @return [::Float]
    #     Count value of a metric.
    # @!attribute [rw] confidence_interval
    #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
    #     The probability that the treatment is better than all other treatments
    #     in the experiment
    class Metric
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Version variant and associated metrics.
    # @!attribute [rw] version
    #   @return [::String]
    #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
    #     Format:
    #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
    # @!attribute [rw] metrics
    #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
    #     The metrics and corresponding confidence intervals in the inference
    #     result.
    # @!attribute [rw] session_count
    #   @return [::Integer]
    #     Number of sessions that were allocated to this version.
    class VersionMetrics
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Types of ratio-based metric for Dialogflow experiment.
    module MetricType
      # Metric unspecified.
      METRIC_UNSPECIFIED = 0

      # Percentage of contained sessions without user calling back in 24 hours.
      CONTAINED_SESSION_NO_CALLBACK_RATE = 1

      # Percentage of sessions that were handed to a human agent.
      LIVE_AGENT_HANDOFF_RATE = 2

      # Percentage of sessions with the same user calling back.
      CALLBACK_SESSION_RATE = 3

      # Percentage of sessions where user hung up.
      ABANDONED_SESSION_RATE = 4

      # Percentage of sessions reached Dialogflow 'END_PAGE' or
      # 'END_SESSION'.
      SESSION_END_RATE = 5
    end

    # Types of count-based metric for Dialogflow experiment.
    module CountType
      # Count type unspecified.
      COUNT_TYPE_UNSPECIFIED = 0

      # Total number of occurrences of a 'NO_MATCH'.
      TOTAL_NO_MATCH_COUNT = 1

      # Total number of turn counts.
      TOTAL_TURN_COUNT = 2

      # Average turn count in a session.
      AVERAGE_TURN_COUNT = 3
    end
  end

  # The state of the experiment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The experiment is created but not started yet.
    DRAFT = 1

    # The experiment is running.
    RUNNING = 2

    # The experiment is done.
    DONE = 3

    # The experiment with auto-rollout enabled has failed.
    ROLLOUT_FAILED = 4
  end
end