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

<h1><a href="dialogflow_v3.html">Dialogflow API</a> . <a href="dialogflow_v3.projects.html">projects</a> . <a href="dialogflow_v3.projects.locations.html">locations</a> . <a href="dialogflow_v3.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3.projects.locations.agents.environments.html">environments</a> . <a href="dialogflow_v3.projects.locations.agents.environments.experiments.html">experiments</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Creates an Experiment in the specified Environment.</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes the specified Experiment.</p>

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Retrieves the specified Experiment.</p>

89

90

<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">Returns the list of all experiments in the specified Environment.</p>

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

96

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Updates the specified Experiment.</p>

98

99

<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.</p>

101

102

<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>

103

<p class="firstline">Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.</p>

104

<h3>Method Details</h3>

105

106

<code class="details" id="close">close()</code>

107

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

112

<pre>Creates an Experiment in the specified Environment.

113

114

Args:

115

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

116

body: object, The request body.

117

The object takes the form of:

118

119

{ # Represents an experiment in an environment.

120

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

121

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

122

"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).

123

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

124

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

125

{ # A single flow version with specified traffic allocation.

126

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

127

"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.

128

"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.

134

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

135

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

136

"experimentLength": "A String", # LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc:default_experiment_length)

yoshi-code-bot

b6dc1b9

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/`.

},

],

},

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

163

"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

b6dc1b9

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

[diff] [blame]

164

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

165

{ # The history of variants update.

166

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

167

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

168

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

169

{ # A single flow version with specified traffic allocation.

170

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

171

"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.

172

"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:

187

188

{ # Represents an experiment in an environment.

189

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

190

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

191

"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).

192

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

193

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

194

{ # A single flow version with specified traffic allocation.

195

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

196

"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.

197

"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.

203

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

204

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

205

"experimentLength": "A String", # LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc:default_experiment_length)

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

206

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

207

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

208

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

209

"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.

210

"versionMetrics": [ # Version variants and metrics.

211

{ # Version variant and associated metrics.

212

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

213

{ # Metric and corresponding confidence intervals.

214

"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

215

"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.

216

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

217

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

218

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

219

},

220

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

221

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

222

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

223

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

224

},

225

],

226

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

227

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

},

],

},

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

232

"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

b6dc1b9

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

[diff] [blame]

233

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

234

{ # The history of variants update.

235

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

236

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

237

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

238

{ # A single flow version with specified traffic allocation.

239

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

240

"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.

241

"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>

252

<pre>Deletes the specified Experiment.

253

254

Args:

255

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

256

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

263

264

{ # 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>

270

<pre>Retrieves the specified Experiment.

271

272

Args:

273

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

274

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

281

282

{ # Represents an experiment in an environment.

283

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

284

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

285

"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).

286

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

287

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

288

{ # A single flow version with specified traffic allocation.

289

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

290

"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.

291

"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.

297

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

298

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

299

"experimentLength": "A String", # LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc:default_experiment_length)

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

300

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

301

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

302

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

303

"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.

304

"versionMetrics": [ # Version variants and metrics.

305

{ # Version variant and associated metrics.

306

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

307

{ # Metric and corresponding confidence intervals.

308

"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

309

"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.

310

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

311

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

312

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

313

},

314

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

315

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

316

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

317

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

318

},

319

],

320

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

321

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

},

],

},

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

326

"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

b6dc1b9

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

[diff] [blame]

327

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

328

{ # The history of variants update.

329

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

330

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

331

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

332

{ # A single flow version with specified traffic allocation.

333

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

334

"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.

335

"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>

346

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

347

348

Args:

349

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

350

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

351

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

352

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

359

360

{ # The response message for Experiments.ListExperiments.

361

"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.

362

{ # Represents an experiment in an environment.

363

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

364

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

365

"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).

366

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

367

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

368

{ # A single flow version with specified traffic allocation.

369

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

370

"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.

371

"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.

377

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

378

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

379

"experimentLength": "A String", # LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc:default_experiment_length)

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

380

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

381

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

382

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

383

"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.

384

"versionMetrics": [ # Version variants and metrics.

385

{ # Version variant and associated metrics.

386

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

387

{ # Metric and corresponding confidence intervals.

388

"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

389

"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.

390

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

391

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

392

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

393

},

394

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

395

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

396

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

397

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

398

},

399

],

400

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

401

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

},

],

},

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

406

"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

b6dc1b9

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

[diff] [blame]

407

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

408

{ # The history of variants update.

409

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

410

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

411

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

412

{ # A single flow version with specified traffic allocation.

413

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

414

"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.

415

"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>

429

<pre>Retrieves the next page of results.

430

431

Args:

432

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

433

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

434

435

Returns:

436

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

437

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>

443

<pre>Updates the specified Experiment.

444

445

Args:

446

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

447

body: object, The request body.

448

The object takes the form of:

449

450

{ # Represents an experiment in an environment.

451

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

452

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

453

"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).

454

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

455

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

456

{ # A single flow version with specified traffic allocation.

457

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

458

"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.

459

"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.

465

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

466

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

467

"experimentLength": "A String", # LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc:default_experiment_length)

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

468

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

469

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

470

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

471

"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.

472

"versionMetrics": [ # Version variants and metrics.

473

{ # Version variant and associated metrics.

474

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

475

{ # Metric and corresponding confidence intervals.

476

"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

477

"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.

478

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

479

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

480

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

481

},

482

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

483

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

484

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

485

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

486

},

487

],

488

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

489

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

},

],

},

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

494

"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

b6dc1b9

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

[diff] [blame]

495

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

496

{ # The history of variants update.

497

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

498

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

499

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

500

{ # A single flow version with specified traffic allocation.

501

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

502

"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.

503

"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.

512

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

519

520

{ # Represents an experiment in an environment.

521

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

522

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

523

"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).

524

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

525

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

526

{ # A single flow version with specified traffic allocation.

527

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

528

"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.

529

"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.

535

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

536

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

537

"experimentLength": "A String", # LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc:default_experiment_length)

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

538

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

539

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

540

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

541

"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.

542

"versionMetrics": [ # Version variants and metrics.

543

{ # Version variant and associated metrics.

544

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

545

{ # Metric and corresponding confidence intervals.

546

"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

547

"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.

548

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

549

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

550

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

551

},

552

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

553

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

554

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

555

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

556

},

557

],

558

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

559

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

},

],

},

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

564

"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

b6dc1b9

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

[diff] [blame]

565

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

566

{ # The history of variants update.

567

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

568

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

569

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

570

{ # A single flow version with specified traffic allocation.

571

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

572

"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.

573

"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>

584

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

585

586

Args:

587

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

588

body: object, The request body.

589

The object takes the form of:

590

591

{ # The request message for Experiments.StartExperiment.

592

}

593

594

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

601

602

{ # Represents an experiment in an environment.

603

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

604

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

605

"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).

606

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

607

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

608

{ # A single flow version with specified traffic allocation.

609

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

610

"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.

611

"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.

617

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

618

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

619

"experimentLength": "A String", # LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc:default_experiment_length)

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

620

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

621

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

622

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

623

"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.

624

"versionMetrics": [ # Version variants and metrics.

625

{ # Version variant and associated metrics.

626

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

627

{ # Metric and corresponding confidence intervals.

628

"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

629

"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.

630

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

631

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

632

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

633

},

634

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

635

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

636

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

637

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

638

},

639

],

640

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

641

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

},

],

},

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

646

"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

b6dc1b9

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

[diff] [blame]

647

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

648

{ # The history of variants update.

649

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

650

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

651

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

652

{ # A single flow version with specified traffic allocation.

653

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

654

"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.

655

"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>

666

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

667

668

Args:

669

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

670

body: object, The request body.

671

The object takes the form of:

672

673

{ # The request message for Experiments.StopExperiment.

674

}

675

676

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

683

684

{ # Represents an experiment in an environment.

685

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

686

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

687

"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).

688

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

689

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

690

{ # A single flow version with specified traffic allocation.

691

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

692

"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.

693

"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.

699

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

700

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

701

"experimentLength": "A String", # LINT.IfChange(default_experiment_length) 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. LINT.ThenChange(//depot/google3/cloud/ml/api/conversation/analytics/compute.cc:default_experiment_length)

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

702

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

703

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

704

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

705

"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.

706

"versionMetrics": [ # Version variants and metrics.

707

{ # Version variant and associated metrics.

708

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

709

{ # Metric and corresponding confidence intervals.

710

"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

711

"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.

712

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

713

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

714

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

715

},

716

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

717

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

718

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

719

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

720

},

721

],

722

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

723

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

},

],

},

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

yoshi-code-bot

1a4514d

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

[diff] [blame^]

728

"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

b6dc1b9

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

[diff] [blame]

729

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

730

{ # The history of variants update.

731

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

732

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

733

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

734

{ # A single flow version with specified traffic allocation.

735

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

736

"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.

737

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

},

],

},

},

],

}</pre>

</div>

</body></html>