Blame - docs/dyn/dialogflow_v3.projects.locations.agents.environments.experiments.html - platform/external/python/google-api-python-client

2021-08-10 00:22:29 -0700

[diff] [blame^]

136

"experimentLength": "A String", # 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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

137

"lastUpdateTime": "A String", # Last update time of this experiment.

138

"name": "A String", # The name of the experiment. Format: projects//locations//agents//environments//experiments/..

139

"result": { # The inference result which includes an objective metric to optimize and the confidence interval. # Inference result of the experiment.

140

"lastUpdateTime": "A String", # The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

141

"versionMetrics": [ # Version variants and metrics.

142

{ # Version variant and associated metrics.

143

"metrics": [ # The metrics and corresponding confidence intervals in the inference result.

144

{ # Metric and corresponding confidence intervals.

145

"confidenceInterval": { # A confidence interval is a range of possible values for the experiment objective you are trying to measure. # The probability that the treatment is better than all other treatments in the experiment

146

"confidenceLevel": 3.14, # The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

147

"lowerBound": 3.14, # Lower bound of the interval.

148

"ratio": 3.14, # The percent change between an experiment metric's value and the value for its control.

149

"upperBound": 3.14, # Upper bound of the interval.

150

},

151

"count": 3.14, # Count value of a metric.

152

"countType": "A String", # Count-based metric type. Only one of type or count_type is specified in each Metric.

153

"ratio": 3.14, # Ratio value of a metric.

154

"type": "A String", # Ratio-based metric type. Only one of type or count_type is specified in each Metric.

155

},

156

],

157

"sessionCount": 42, # Number of sessions that were allocated to this version.

158

"version": "A String", # The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.

159

},

160

],

161

},

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

162

"rolloutConfig": { # The configuration for auto rollout. # 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.

163

"failureCondition": "A String", # The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

164

"rolloutCondition": "A String", # The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

165

"rolloutSteps": [ # Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

166

{ # A single rollout step with specified traffic allocation.

167

"displayName": "A String", # The name of the rollout step;

168

"minDuration": "A String", # The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

169

"trafficPercent": 42, # The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

},

],

},

"rolloutFailureReason": "A String", # The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

174

"rolloutState": { # State of the auto-rollout process. # State of the auto rollout process.

175

"startTime": "A String", # Start time of the current step.

176

"step": "A String", # Display name of the current auto rollout step.

177

"stepIndex": 42, # Index of the current step in the auto rollout steps list.

178

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

179

"startTime": "A String", # Start time of this experiment.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

180

"state": "A String", # The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

181

"variantsHistory": [ # The history of updates to the experiment variants.

182

{ # The history of variants update.

183

"updateTime": "A String", # Update time of the variants.

184

"versionVariants": { # A list of flow version variants. # The flow versions as the variants.

185

"variants": [ # A list of flow version variants.

186

{ # A single flow version with specified traffic allocation.

187

"isControlGroup": True or False, # Whether the variant is for the control group.

188

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

189

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

204

205

{ # Represents an experiment in an environment.

206

"createTime": "A String", # Creation time of this experiment.

207

"definition": { # Definition of the experiment. # The definition of the experiment.

208

"condition": "A 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).

209

"versionVariants": { # A list of flow version variants. # The flow versions as the variants of this experiment.

210

"variants": [ # A list of flow version variants.

211

{ # A single flow version with specified traffic allocation.

212

"isControlGroup": True or False, # Whether the variant is for the control group.

213

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

214

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

"description": "A String", # The human-readable description of the experiment.

220

"displayName": "A String", # Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

221

"endTime": "A String", # End time of this experiment.

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

222

"experimentLength": "A String", # 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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

223

"lastUpdateTime": "A String", # Last update time of this experiment.

224

"name": "A String", # The name of the experiment. Format: projects//locations//agents//environments//experiments/..

225

"result": { # The inference result which includes an objective metric to optimize and the confidence interval. # Inference result of the experiment.

226

"lastUpdateTime": "A String", # The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

227

"versionMetrics": [ # Version variants and metrics.

228

{ # Version variant and associated metrics.

229

"metrics": [ # The metrics and corresponding confidence intervals in the inference result.

230

{ # Metric and corresponding confidence intervals.

231

"confidenceInterval": { # A confidence interval is a range of possible values for the experiment objective you are trying to measure. # The probability that the treatment is better than all other treatments in the experiment

232

"confidenceLevel": 3.14, # The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

233

"lowerBound": 3.14, # Lower bound of the interval.

234

"ratio": 3.14, # The percent change between an experiment metric's value and the value for its control.

235

"upperBound": 3.14, # Upper bound of the interval.

236

},

237

"count": 3.14, # Count value of a metric.

238

"countType": "A String", # Count-based metric type. Only one of type or count_type is specified in each Metric.

239

"ratio": 3.14, # Ratio value of a metric.

240

"type": "A String", # Ratio-based metric type. Only one of type or count_type is specified in each Metric.

241

},

242

],

243

"sessionCount": 42, # Number of sessions that were allocated to this version.

244

"version": "A String", # The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.

245

},

246

],

247

},

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

248

"rolloutConfig": { # The configuration for auto rollout. # 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.

249

"failureCondition": "A String", # The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

250

"rolloutCondition": "A String", # The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

251

"rolloutSteps": [ # Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

252

{ # A single rollout step with specified traffic allocation.

253

"displayName": "A String", # The name of the rollout step;

254

"minDuration": "A String", # The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

255

"trafficPercent": 42, # The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

},

],

},

"rolloutFailureReason": "A String", # The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

260

"rolloutState": { # State of the auto-rollout process. # State of the auto rollout process.

261

"startTime": "A String", # Start time of the current step.

262

"step": "A String", # Display name of the current auto rollout step.

263

"stepIndex": 42, # Index of the current step in the auto rollout steps list.

264

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

265

"startTime": "A String", # Start time of this experiment.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

266

"state": "A String", # The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

267

"variantsHistory": [ # The history of updates to the experiment variants.

268

{ # The history of variants update.

269

"updateTime": "A String", # Update time of the variants.

270

"versionVariants": { # A list of flow version variants. # The flow versions as the variants.

271

"variants": [ # A list of flow version variants.

272

{ # A single flow version with specified traffic allocation.

273

"isControlGroup": True or False, # Whether the variant is for the control group.

274

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

275

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

],

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

286

<pre>Deletes the specified Experiment.

287

288

Args:

289

name: string, Required. The name of the Environment to delete. Format: `projects//locations//agents//environments//experiments/`. (required)

290

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

297

298

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

304

<pre>Retrieves the specified Experiment.

305

306

Args:

307

name: string, Required. The name of the Environment. Format: `projects//locations//agents//environments//experiments/`. (required)

308

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

315

316

{ # Represents an experiment in an environment.

317

"createTime": "A String", # Creation time of this experiment.

318

"definition": { # Definition of the experiment. # The definition of the experiment.

319

"condition": "A 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).

320

"versionVariants": { # A list of flow version variants. # The flow versions as the variants of this experiment.

321

"variants": [ # A list of flow version variants.

322

{ # A single flow version with specified traffic allocation.

323

"isControlGroup": True or False, # Whether the variant is for the control group.

324

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

325

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

"description": "A String", # The human-readable description of the experiment.

331

"displayName": "A String", # Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

332

"endTime": "A String", # End time of this experiment.

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

333

"experimentLength": "A String", # 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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

334

"lastUpdateTime": "A String", # Last update time of this experiment.

335

"name": "A String", # The name of the experiment. Format: projects//locations//agents//environments//experiments/..

336

"result": { # The inference result which includes an objective metric to optimize and the confidence interval. # Inference result of the experiment.

337

"lastUpdateTime": "A String", # The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

338

"versionMetrics": [ # Version variants and metrics.

339

{ # Version variant and associated metrics.

340

"metrics": [ # The metrics and corresponding confidence intervals in the inference result.

341

{ # Metric and corresponding confidence intervals.

342

"confidenceInterval": { # A confidence interval is a range of possible values for the experiment objective you are trying to measure. # The probability that the treatment is better than all other treatments in the experiment

343

"confidenceLevel": 3.14, # The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

344

"lowerBound": 3.14, # Lower bound of the interval.

345

"ratio": 3.14, # The percent change between an experiment metric's value and the value for its control.

346

"upperBound": 3.14, # Upper bound of the interval.

347

},

348

"count": 3.14, # Count value of a metric.

349

"countType": "A String", # Count-based metric type. Only one of type or count_type is specified in each Metric.

350

"ratio": 3.14, # Ratio value of a metric.

351

"type": "A String", # Ratio-based metric type. Only one of type or count_type is specified in each Metric.

352

},

353

],

354

"sessionCount": 42, # Number of sessions that were allocated to this version.

355

"version": "A String", # The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.

356

},

357

],

358

},

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

359

"rolloutConfig": { # The configuration for auto rollout. # 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.

360

"failureCondition": "A String", # The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

361

"rolloutCondition": "A String", # The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

362

"rolloutSteps": [ # Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

363

{ # A single rollout step with specified traffic allocation.

364

"displayName": "A String", # The name of the rollout step;

365

"minDuration": "A String", # The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

366

"trafficPercent": 42, # The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

},

],

},

"rolloutFailureReason": "A String", # The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

371

"rolloutState": { # State of the auto-rollout process. # State of the auto rollout process.

372

"startTime": "A String", # Start time of the current step.

373

"step": "A String", # Display name of the current auto rollout step.

374

"stepIndex": 42, # Index of the current step in the auto rollout steps list.

375

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

376

"startTime": "A String", # Start time of this experiment.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

377

"state": "A String", # The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

378

"variantsHistory": [ # The history of updates to the experiment variants.

379

{ # The history of variants update.

380

"updateTime": "A String", # Update time of the variants.

381

"versionVariants": { # A list of flow version variants. # The flow versions as the variants.

382

"variants": [ # A list of flow version variants.

383

{ # A single flow version with specified traffic allocation.

384

"isControlGroup": True or False, # Whether the variant is for the control group.

385

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

386

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

],

}</pre>

</div>

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>

397

<pre>Returns the list of all experiments in the specified Environment.

398

399

Args:

400

parent: string, Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`. (required)

401

pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.

402

pageToken: string, The next_page_token value returned from a previous list request.

403

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

410

411

{ # The response message for Experiments.ListExperiments.

412

"experiments": [ # The list of experiments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page.

413

{ # Represents an experiment in an environment.

414

"createTime": "A String", # Creation time of this experiment.

415

"definition": { # Definition of the experiment. # The definition of the experiment.

416

"condition": "A 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).

417

"versionVariants": { # A list of flow version variants. # The flow versions as the variants of this experiment.

418

"variants": [ # A list of flow version variants.

419

{ # A single flow version with specified traffic allocation.

420

"isControlGroup": True or False, # Whether the variant is for the control group.

421

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

422

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

"description": "A String", # The human-readable description of the experiment.

428

"displayName": "A String", # Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

429

"endTime": "A String", # End time of this experiment.

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

430

"experimentLength": "A String", # 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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

431

"lastUpdateTime": "A String", # Last update time of this experiment.

432

"name": "A String", # The name of the experiment. Format: projects//locations//agents//environments//experiments/..

433

"result": { # The inference result which includes an objective metric to optimize and the confidence interval. # Inference result of the experiment.

434

"lastUpdateTime": "A String", # The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

435

"versionMetrics": [ # Version variants and metrics.

436

{ # Version variant and associated metrics.

437

"metrics": [ # The metrics and corresponding confidence intervals in the inference result.

438

{ # Metric and corresponding confidence intervals.

439

"confidenceInterval": { # A confidence interval is a range of possible values for the experiment objective you are trying to measure. # The probability that the treatment is better than all other treatments in the experiment

440

"confidenceLevel": 3.14, # The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

441

"lowerBound": 3.14, # Lower bound of the interval.

442

"ratio": 3.14, # The percent change between an experiment metric's value and the value for its control.

443

"upperBound": 3.14, # Upper bound of the interval.

444

},

445

"count": 3.14, # Count value of a metric.

446

"countType": "A String", # Count-based metric type. Only one of type or count_type is specified in each Metric.

447

"ratio": 3.14, # Ratio value of a metric.

448

"type": "A String", # Ratio-based metric type. Only one of type or count_type is specified in each Metric.

449

},

450

],

451

"sessionCount": 42, # Number of sessions that were allocated to this version.

452

"version": "A String", # The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.

453

},

454

],

455

},

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

456

"rolloutConfig": { # The configuration for auto rollout. # 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.

457

"failureCondition": "A String", # The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

458

"rolloutCondition": "A String", # The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

459

"rolloutSteps": [ # Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

460

{ # A single rollout step with specified traffic allocation.

461

"displayName": "A String", # The name of the rollout step;

462

"minDuration": "A String", # The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

463

"trafficPercent": 42, # The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

},

],

},

"rolloutFailureReason": "A String", # The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

468

"rolloutState": { # State of the auto-rollout process. # State of the auto rollout process.

469

"startTime": "A String", # Start time of the current step.

470

"step": "A String", # Display name of the current auto rollout step.

471

"stepIndex": 42, # Index of the current step in the auto rollout steps list.

472

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

473

"startTime": "A String", # Start time of this experiment.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

474

"state": "A String", # The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

475

"variantsHistory": [ # The history of updates to the experiment variants.

476

{ # The history of variants update.

477

"updateTime": "A String", # Update time of the variants.

478

"versionVariants": { # A list of flow version variants. # The flow versions as the variants.

479

"variants": [ # A list of flow version variants.

480

{ # A single flow version with specified traffic allocation.

481

"isControlGroup": True or False, # Whether the variant is for the control group.

482

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

483

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

],

},

],

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

497

<pre>Retrieves the next page of results.

498

499

Args:

500

previous_request: The request for the previous page. (required)

501

previous_response: The response from the request for the previous page. (required)

502

503

Returns:

504

A request object that you can call 'execute()' on to request the next

505

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

511

<pre>Updates the specified Experiment.

512

513

Args:

514

name: string, The name of the experiment. Format: projects//locations//agents//environments//experiments/.. (required)

515

body: object, The request body.

516

The object takes the form of:

517

518

{ # Represents an experiment in an environment.

519

"createTime": "A String", # Creation time of this experiment.

520

"definition": { # Definition of the experiment. # The definition of the experiment.

521

"condition": "A 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).

522

"versionVariants": { # A list of flow version variants. # The flow versions as the variants of this experiment.

523

"variants": [ # A list of flow version variants.

524

{ # A single flow version with specified traffic allocation.

525

"isControlGroup": True or False, # Whether the variant is for the control group.

526

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

527

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

"description": "A String", # The human-readable description of the experiment.

533

"displayName": "A String", # Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

534

"endTime": "A String", # End time of this experiment.

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

535

"experimentLength": "A String", # 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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

536

"lastUpdateTime": "A String", # Last update time of this experiment.

537

"name": "A String", # The name of the experiment. Format: projects//locations//agents//environments//experiments/..

538

"result": { # The inference result which includes an objective metric to optimize and the confidence interval. # Inference result of the experiment.

539

"lastUpdateTime": "A String", # The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

540

"versionMetrics": [ # Version variants and metrics.

541

{ # Version variant and associated metrics.

542

"metrics": [ # The metrics and corresponding confidence intervals in the inference result.

543

{ # Metric and corresponding confidence intervals.

544

"confidenceInterval": { # A confidence interval is a range of possible values for the experiment objective you are trying to measure. # The probability that the treatment is better than all other treatments in the experiment

545

"confidenceLevel": 3.14, # The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

546

"lowerBound": 3.14, # Lower bound of the interval.

547

"ratio": 3.14, # The percent change between an experiment metric's value and the value for its control.

548

"upperBound": 3.14, # Upper bound of the interval.

549

},

550

"count": 3.14, # Count value of a metric.

551

"countType": "A String", # Count-based metric type. Only one of type or count_type is specified in each Metric.

552

"ratio": 3.14, # Ratio value of a metric.

553

"type": "A String", # Ratio-based metric type. Only one of type or count_type is specified in each Metric.

554

},

555

],

556

"sessionCount": 42, # Number of sessions that were allocated to this version.

557

"version": "A String", # The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.

558

},

559

],

560

},

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

561

"rolloutConfig": { # The configuration for auto rollout. # 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.

562

"failureCondition": "A String", # The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

563

"rolloutCondition": "A String", # The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

564

"rolloutSteps": [ # Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

565

{ # A single rollout step with specified traffic allocation.

566

"displayName": "A String", # The name of the rollout step;

567

"minDuration": "A String", # The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

568

"trafficPercent": 42, # The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

},

],

},

"rolloutFailureReason": "A String", # The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

573

"rolloutState": { # State of the auto-rollout process. # State of the auto rollout process.

574

"startTime": "A String", # Start time of the current step.

575

"step": "A String", # Display name of the current auto rollout step.

576

"stepIndex": 42, # Index of the current step in the auto rollout steps list.

577

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

578

"startTime": "A String", # Start time of this experiment.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

579

"state": "A String", # The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

580

"variantsHistory": [ # The history of updates to the experiment variants.

581

{ # The history of variants update.

582

"updateTime": "A String", # Update time of the variants.

583

"versionVariants": { # A list of flow version variants. # The flow versions as the variants.

584

"variants": [ # A list of flow version variants.

585

{ # A single flow version with specified traffic allocation.

586

"isControlGroup": True or False, # Whether the variant is for the control group.

587

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

588

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

],

}

updateMask: string, Required. The mask to control which fields get updated.

597

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

604

605

{ # Represents an experiment in an environment.

606

"createTime": "A String", # Creation time of this experiment.

607

"definition": { # Definition of the experiment. # The definition of the experiment.

608

"condition": "A 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).

609

"versionVariants": { # A list of flow version variants. # The flow versions as the variants of this experiment.

610

"variants": [ # A list of flow version variants.

611

{ # A single flow version with specified traffic allocation.

612

"isControlGroup": True or False, # Whether the variant is for the control group.

613

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

614

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

"description": "A String", # The human-readable description of the experiment.

620

"displayName": "A String", # Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

621

"endTime": "A String", # End time of this experiment.

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

622

"experimentLength": "A String", # 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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

623

"lastUpdateTime": "A String", # Last update time of this experiment.

624

"name": "A String", # The name of the experiment. Format: projects//locations//agents//environments//experiments/..

625

"result": { # The inference result which includes an objective metric to optimize and the confidence interval. # Inference result of the experiment.

626

"lastUpdateTime": "A String", # The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

627

"versionMetrics": [ # Version variants and metrics.

628

{ # Version variant and associated metrics.

629

"metrics": [ # The metrics and corresponding confidence intervals in the inference result.

630

{ # Metric and corresponding confidence intervals.

631

"confidenceInterval": { # A confidence interval is a range of possible values for the experiment objective you are trying to measure. # The probability that the treatment is better than all other treatments in the experiment

632

"confidenceLevel": 3.14, # The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

633

"lowerBound": 3.14, # Lower bound of the interval.

634

"ratio": 3.14, # The percent change between an experiment metric's value and the value for its control.

635

"upperBound": 3.14, # Upper bound of the interval.

636

},

637

"count": 3.14, # Count value of a metric.

638

"countType": "A String", # Count-based metric type. Only one of type or count_type is specified in each Metric.

639

"ratio": 3.14, # Ratio value of a metric.

640

"type": "A String", # Ratio-based metric type. Only one of type or count_type is specified in each Metric.

641

},

642

],

643

"sessionCount": 42, # Number of sessions that were allocated to this version.

644

"version": "A String", # The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.

645

},

646

],

647

},

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

648

"rolloutConfig": { # The configuration for auto rollout. # 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.

649

"failureCondition": "A String", # The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

650

"rolloutCondition": "A String", # The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

651

"rolloutSteps": [ # Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

652

{ # A single rollout step with specified traffic allocation.

653

"displayName": "A String", # The name of the rollout step;

654

"minDuration": "A String", # The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

655

"trafficPercent": 42, # The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

},

],

},

"rolloutFailureReason": "A String", # The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

660

"rolloutState": { # State of the auto-rollout process. # State of the auto rollout process.

661

"startTime": "A String", # Start time of the current step.

662

"step": "A String", # Display name of the current auto rollout step.

663

"stepIndex": 42, # Index of the current step in the auto rollout steps list.

664

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

665

"startTime": "A String", # Start time of this experiment.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

666

"state": "A String", # The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

667

"variantsHistory": [ # The history of updates to the experiment variants.

668

{ # The history of variants update.

669

"updateTime": "A String", # Update time of the variants.

670

"versionVariants": { # A list of flow version variants. # The flow versions as the variants.

671

"variants": [ # A list of flow version variants.

672

{ # A single flow version with specified traffic allocation.

673

"isControlGroup": True or False, # Whether the variant is for the control group.

674

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

675

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

],

}</pre>

</div>

<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>

686

<pre>Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.

687

688

Args:

689

name: string, Required. Resource name of the experiment to start. Format: `projects//locations//agents//environments//experiments/`. (required)

690

body: object, The request body.

691

The object takes the form of:

692

693

{ # The request message for Experiments.StartExperiment.

694

}

695

696

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

703

704

{ # Represents an experiment in an environment.

705

"createTime": "A String", # Creation time of this experiment.

706

"definition": { # Definition of the experiment. # The definition of the experiment.

707

"condition": "A 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).

708

"versionVariants": { # A list of flow version variants. # The flow versions as the variants of this experiment.

709

"variants": [ # A list of flow version variants.

710

{ # A single flow version with specified traffic allocation.

711

"isControlGroup": True or False, # Whether the variant is for the control group.

712

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

713

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

"description": "A String", # The human-readable description of the experiment.

719

"displayName": "A String", # Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

720

"endTime": "A String", # End time of this experiment.

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

721

"experimentLength": "A String", # 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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

722

"lastUpdateTime": "A String", # Last update time of this experiment.

723

"name": "A String", # The name of the experiment. Format: projects//locations//agents//environments//experiments/..

724

"result": { # The inference result which includes an objective metric to optimize and the confidence interval. # Inference result of the experiment.

725

"lastUpdateTime": "A String", # The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

726

"versionMetrics": [ # Version variants and metrics.

727

{ # Version variant and associated metrics.

728

"metrics": [ # The metrics and corresponding confidence intervals in the inference result.

729

{ # Metric and corresponding confidence intervals.

730

"confidenceInterval": { # A confidence interval is a range of possible values for the experiment objective you are trying to measure. # The probability that the treatment is better than all other treatments in the experiment

731

"confidenceLevel": 3.14, # The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

732

"lowerBound": 3.14, # Lower bound of the interval.

733

"ratio": 3.14, # The percent change between an experiment metric's value and the value for its control.

734

"upperBound": 3.14, # Upper bound of the interval.

735

},

736

"count": 3.14, # Count value of a metric.

737

"countType": "A String", # Count-based metric type. Only one of type or count_type is specified in each Metric.

738

"ratio": 3.14, # Ratio value of a metric.

739

"type": "A String", # Ratio-based metric type. Only one of type or count_type is specified in each Metric.

740

},

741

],

742

"sessionCount": 42, # Number of sessions that were allocated to this version.

743

"version": "A String", # The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.

744

},

745

],

746

},

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

747

"rolloutConfig": { # The configuration for auto rollout. # 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.

748

"failureCondition": "A String", # The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

749

"rolloutCondition": "A String", # The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

750

"rolloutSteps": [ # Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

751

{ # A single rollout step with specified traffic allocation.

752

"displayName": "A String", # The name of the rollout step;

753

"minDuration": "A String", # The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

754

"trafficPercent": 42, # The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

},

],

},

"rolloutFailureReason": "A String", # The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

759

"rolloutState": { # State of the auto-rollout process. # State of the auto rollout process.

760

"startTime": "A String", # Start time of the current step.

761

"step": "A String", # Display name of the current auto rollout step.

762

"stepIndex": 42, # Index of the current step in the auto rollout steps list.

763

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

764

"startTime": "A String", # Start time of this experiment.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

765

"state": "A String", # The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

766

"variantsHistory": [ # The history of updates to the experiment variants.

767

{ # The history of variants update.

768

"updateTime": "A String", # Update time of the variants.

769

"versionVariants": { # A list of flow version variants. # The flow versions as the variants.

770

"variants": [ # A list of flow version variants.

771

{ # A single flow version with specified traffic allocation.

772

"isControlGroup": True or False, # Whether the variant is for the control group.

773

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

774

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

],

}</pre>

</div>

<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>

785

<pre>Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.

786

787

Args:

788

name: string, Required. Resource name of the experiment to stop. Format: `projects//locations//agents//environments//experiments/`. (required)

789

body: object, The request body.

790

The object takes the form of:

791

792

{ # The request message for Experiments.StopExperiment.

793

}

794

795

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

802

803

{ # Represents an experiment in an environment.

804

"createTime": "A String", # Creation time of this experiment.

805

"definition": { # Definition of the experiment. # The definition of the experiment.

806

"condition": "A 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).

807

"versionVariants": { # A list of flow version variants. # The flow versions as the variants of this experiment.

808

"variants": [ # A list of flow version variants.

809

{ # A single flow version with specified traffic allocation.

810

"isControlGroup": True or False, # Whether the variant is for the control group.

811

"trafficAllocation": 3.14, # Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

812

"version": "A String", # The name of the flow version. Format: `projects//locations//agents//flows//versions/`.

},

],

},

},

"description": "A String", # The human-readable description of the experiment.

818

"displayName": "A String", # Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

819

"endTime": "A String", # End time of this experiment.

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

820

"experimentLength": "A String", # 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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

821

"lastUpdateTime": "A String", # Last update time of this experiment.

822

"name": "A String", # The name of the experiment. Format: projects//locations//agents//environments//experiments/..

823

"result": { # The inference result which includes an objective metric to optimize and the confidence interval. # Inference result of the experiment.

824

"lastUpdateTime": "A String", # The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

825

"versionMetrics": [ # Version variants and metrics.

826

{ # Version variant and associated metrics.

827

"metrics": [ # The metrics and corresponding confidence intervals in the inference result.

828

{ # Metric and corresponding confidence intervals.

829

"confidenceInterval": { # A confidence interval is a range of possible values for the experiment objective you are trying to measure. # The probability that the treatment is better than all other treatments in the experiment

830

"confidenceLevel": 3.14, # The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

831

"lowerBound": 3.14, # Lower bound of the interval.

832

"ratio": 3.14, # The percent change between an experiment metric's value and the value for its control.

833

"upperBound": 3.14, # Upper bound of the interval.

834

},

835

"count": 3.14, # Count value of a metric.

836

"countType": "A String", # Count-based metric type. Only one of type or count_type is specified in each Metric.

837

"ratio": 3.14, # Ratio value of a metric.

838

"type": "A String", # Ratio-based metric type. Only one of type or count_type is specified in each Metric.

839

},

840

],

841

"sessionCount": 42, # Number of sessions that were allocated to this version.

842

"version": "A String", # The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.

843

},

844

],

845

},

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame^]

846

"rolloutConfig": { # The configuration for auto rollout. # 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.

847

"failureCondition": "A String", # The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

848

"rolloutCondition": "A String", # The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).

849

"rolloutSteps": [ # Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

850

{ # A single rollout step with specified traffic allocation.

851

"displayName": "A String", # The name of the rollout step;

852

"minDuration": "A String", # The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

853

"trafficPercent": 42, # The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

},

],

},

"rolloutFailureReason": "A String", # The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

858

"rolloutState": { # State of the auto-rollout process. # State of the auto rollout process.

859

"startTime": "A String", # Start time of the current step.

860

"step": "A String", # Display name of the current auto rollout step.

861

"stepIndex": 42, # Index of the current step in the auto rollout steps list.

862

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

863

"startTime": "A String", # Start time of this experiment.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

864

"state": "A String", # The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

yoshi-code-bot