Blame - docs/dyn/dialogflow_v2beta1.projects.locations.agent.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

101

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

102

<p class="firstline">Retrieves the fulfillment.</p>

103

104

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

105

<p class="firstline">Imports the specified agent from a ZIP file.</p>

106

107

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

108

<p class="firstline">Restores the specified agent from a ZIP file.</p>

109

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

110

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

111

<p class="firstline">Returns the list of agents.</p>

112

113

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

114

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

115

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

116

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

117

<p class="firstline">Trains the specified agent.</p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

118

119

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

120

<p class="firstline">Updates the fulfillment.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

121

<h3>Method Details</h3>

122

123

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

124

<pre>Exports the specified agent to a ZIP file.

125

126

127

Operation <response: ExportAgentResponse>

128

129

Args:

130

parent: string, Required. The project that the agent to export is associated with.

131

Format: `projects/<Project ID>`. (required)

132

body: object, The request body.

133

The object takes the form of:

134

135

{ # The request message for Agents.ExportAgent.

136

"agentUri": "A String", # Optional. The

137

# [Google Cloud Storage](https://cloud.google.com/storage/docs/)

138

# URI to export the agent to.

139

# The format of this URI must be `gs://<bucket-name>/<object-name>`.

140

# If left unspecified, the serialized agent is returned inline.

141

}

142

143

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

150

151

{ # This resource represents a long-running operation that is the result of a

152

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

153

"name": "A String", # The server-assigned name, which is only unique within the same service that

154

# originally returns it. If you use the default HTTP mapping, the

155

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

156

"response": { # The normal response of the operation in case of success. If the original

157

# method returns no data on success, such as `Delete`, the response is

158

# `google.protobuf.Empty`. If the original method is standard

159

# `Get`/`Create`/`Update`, the response should be the resource. For other

160

# methods, the response should have the type `XxxResponse`, where `Xxx`

161

# is the original method name. For example, if the original method name

162

# is `TakeSnapshot()`, the inferred response type is

163

# `TakeSnapshotResponse`.

164

"a_key": "", # Properties of the object. Contains field @type with type URL.

165

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

166

"done": True or False, # If the value is `false`, it means the operation is still in progress.

167

# If `true`, the operation is completed, and either `error` or `response` is

168

# available.

169

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

170

# different programming environments, including REST APIs and RPC APIs. It is

171

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

172

# three pieces of data: error code, error message, and error details.

173

#

174

# You can find out more about this error model and how to work with it in the

175

# [API Design Guide](https://cloud.google.com/apis/design/errors).

176

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

177

"details": [ # A list of messages that carry the error details. There is a common set of

178

# message types for APIs to use.

179

{

180

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

181

},

182

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

183

"message": "A String", # A developer-facing error message, which should be in English. Any

184

# user-facing error message should be localized and sent in the

185

# google.rpc.Status.details field, or localized by the client.

186

},

187

"metadata": { # Service-specific metadata associated with the operation. It typically

188

# contains progress information and common metadata such as create time.

189

# Some services might not provide such metadata. Any method that returns a

190

# long-running operation should document the metadata type, if any.

191

"a_key": "", # Properties of the object. Contains field @type with type URL.

192

},

193

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

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

198

<pre>Retrieves the fulfillment.

199

200

Args:

201

name: string, Required. The name of the fulfillment.

202

Format: `projects/<Project ID>/agent/fulfillment`. (required)

203

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

210

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

211

{ # By default, your agent responds to a matched intent with a static response.

212

# As an alternative, you can provide a more dynamic response by using

213

# fulfillment. When you enable fulfillment for an intent, Dialogflow responds

214

# to that intent by calling a service that you define. For example, if an

215

# end-user wants to schedule a haircut on Friday, your service can check your

216

# database and respond to the end-user with availability information for

217

# Friday.

218

#

219

# For more information, see the [fulfillment

220

# guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

221

"features": [ # Optional. The field defines whether the fulfillment is enabled for certain features.

222

{ # Whether fulfillment is enabled for the specific feature.

223

"type": "A String", # The type of the feature that enabled for fulfillment.

224

},

225

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

226

"displayName": "A String", # Optional. The human-readable name of the fulfillment, unique within the agent.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

227

"genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.

228

# Dialogflow supports two mechanisms for authentications:

229

# - Basic authentication with username and password.

230

# - Authentication with additional authentication headers.

231

# More information could be found at:

232

# https://cloud.google.com/dialogflow/docs/fulfillment-configure.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

233

"requestHeaders": { # Optional. The HTTP request headers to send together with fulfillment requests.

234

"a_key": "A String",

235

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

236

"uri": "A String", # Required. The fulfillment URI for receiving POST requests.

237

# It must use https protocol.

238

"isCloudFunction": True or False, # Optional. Indicates if generic web service is created through Cloud Functions

239

# integration. Defaults to false.

240

"username": "A String", # Optional. The user name for HTTP Basic authentication.

241

"password": "A String", # Optional. The password for HTTP Basic authentication.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

242

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

243

"enabled": True or False, # Optional. Whether fulfillment is enabled.

244

"name": "A String", # Required. The unique identifier of the fulfillment.

245

# Format: `projects/<Project ID>/agent/fulfillment`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

246

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

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

251

<pre>Imports the specified agent from a ZIP file.

252

253

Uploads new intents and entity types without deleting the existing ones.

254

Intents and entity types with the same name are replaced with the new

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

255

versions from ImportAgentRequest. After the import, the imported draft

256

agent will be trained automatically (unless disabled in agent settings).

257

However, once the import is done, training may not be completed yet. Please

258

call TrainAgent and wait for the operation it returns in order to train

259

explicitly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

260

261

262

Operation <response: google.protobuf.Empty>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

263

An operation which tracks when importing is complete. It only tracks

264

when the draft agent is updated not when it is done training.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

265

266

Args:

267

parent: string, Required. The project that the agent to import is associated with.

268

Format: `projects/<Project ID>`. (required)

269

body: object, The request body.

270

The object takes the form of:

271

272

{ # The request message for Agents.ImportAgent.

273

"agentContent": "A String", # Zip compressed raw byte content for agent.

274

"agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to import.

275

# Note: The URI must start with "gs://".

276

}

277

278

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

285

286

{ # This resource represents a long-running operation that is the result of a

287

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

288

"name": "A String", # The server-assigned name, which is only unique within the same service that

289

# originally returns it. If you use the default HTTP mapping, the

290

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

291

"response": { # The normal response of the operation in case of success. If the original

292

# method returns no data on success, such as `Delete`, the response is

293

# `google.protobuf.Empty`. If the original method is standard

294

# `Get`/`Create`/`Update`, the response should be the resource. For other

295

# methods, the response should have the type `XxxResponse`, where `Xxx`

296

# is the original method name. For example, if the original method name

297

# is `TakeSnapshot()`, the inferred response type is

298

# `TakeSnapshotResponse`.

299

"a_key": "", # Properties of the object. Contains field @type with type URL.

300

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

301

"done": True or False, # If the value is `false`, it means the operation is still in progress.

302

# If `true`, the operation is completed, and either `error` or `response` is

303

# available.

304

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

305

# different programming environments, including REST APIs and RPC APIs. It is

306

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

307

# three pieces of data: error code, error message, and error details.

308

#

309

# You can find out more about this error model and how to work with it in the

310

# [API Design Guide](https://cloud.google.com/apis/design/errors).

311

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

312

"details": [ # A list of messages that carry the error details. There is a common set of

313

# message types for APIs to use.

314

{

315

"a_key": "", # Properties of the object. Contains field @type with type URL.

316

},

317

],

318

"message": "A String", # A developer-facing error message, which should be in English. Any

319

# user-facing error message should be localized and sent in the

320

# google.rpc.Status.details field, or localized by the client.

321

},

322

"metadata": { # Service-specific metadata associated with the operation. It typically

323

# contains progress information and common metadata such as create time.

324

# Some services might not provide such metadata. Any method that returns a

325

# long-running operation should document the metadata type, if any.

326

"a_key": "", # Properties of the object. Contains field @type with type URL.

327

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

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

333

<pre>Restores the specified agent from a ZIP file.

334

335

Replaces the current agent version with a new one. All the intents and

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

336

entity types in the older version are deleted. After the restore, the

337

restored draft agent will be trained automatically (unless disabled in

338

agent settings). However, once the restore is done, training may not be

339

completed yet. Please call TrainAgent and wait for the operation it

340

returns in order to train explicitly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

341

342

343

Operation <response: google.protobuf.Empty>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

344

An operation which tracks when restoring is complete. It only tracks

345

when the draft agent is updated not when it is done training.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

346

347

Args:

348

parent: string, Required. The project that the agent to restore is associated with.

349

Format: `projects/<Project ID>`. (required)

350

body: object, The request body.

351

The object takes the form of:

352

353

{ # The request message for Agents.RestoreAgent.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

354

"agentContent": "A String", # Zip compressed raw byte content for agent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

355

"agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to restore.

356

# Note: The URI must start with "gs://".

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

357

}

358

359

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

366

367

{ # This resource represents a long-running operation that is the result of a

368

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

369

"name": "A String", # The server-assigned name, which is only unique within the same service that

370

# originally returns it. If you use the default HTTP mapping, the

371

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

372

"response": { # The normal response of the operation in case of success. If the original

373

# method returns no data on success, such as `Delete`, the response is

374

# `google.protobuf.Empty`. If the original method is standard

375

# `Get`/`Create`/`Update`, the response should be the resource. For other

376

# methods, the response should have the type `XxxResponse`, where `Xxx`

377

# is the original method name. For example, if the original method name

378

# is `TakeSnapshot()`, the inferred response type is

379

# `TakeSnapshotResponse`.

380

"a_key": "", # Properties of the object. Contains field @type with type URL.

381

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

382

"done": True or False, # If the value is `false`, it means the operation is still in progress.

383

# If `true`, the operation is completed, and either `error` or `response` is

384

# available.

385

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

386

# different programming environments, including REST APIs and RPC APIs. It is

387

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

388

# three pieces of data: error code, error message, and error details.

389

#

390

# You can find out more about this error model and how to work with it in the

391

# [API Design Guide](https://cloud.google.com/apis/design/errors).

392

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

393

"details": [ # A list of messages that carry the error details. There is a common set of

394

# message types for APIs to use.

395

{

396

"a_key": "", # Properties of the object. Contains field @type with type URL.

397

},

398

],

399

"message": "A String", # A developer-facing error message, which should be in English. Any

400

# user-facing error message should be localized and sent in the

401

# google.rpc.Status.details field, or localized by the client.

402

},

403

"metadata": { # Service-specific metadata associated with the operation. It typically

404

# contains progress information and common metadata such as create time.

405

# Some services might not provide such metadata. Any method that returns a

406

# long-running operation should document the metadata type, if any.

407

"a_key": "", # Properties of the object. Contains field @type with type URL.

408

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

413

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

414

<pre>Returns the list of agents.

415

Since there is at most one conversational agent per project, this method is

416

useful primarily for listing all agents across projects the caller has

417

access to. One can achieve that with a wildcard project collection id "-".

418

Refer to [List

419

Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).

420

421

Args:

422

parent: string, Required. The project to list agents from.

423

Format: `projects/<Project ID or '-'>`. (required)

424

pageSize: integer, Optional. The maximum number of items to return in a single page. By

425

default 100 and at most 1000.

426

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

427

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

434

435

{ # The response message for Agents.SearchAgents.

436

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

437

# more results in the list.

438

"agents": [ # The list of agents. There will be a maximum number of items returned based

439

# on the page_size field in the request.

440

{ # A Dialogflow agent is a virtual agent that handles conversations with your

441

# end-users. It is a natural language understanding module that understands the

442

# nuances of human language. Dialogflow translates end-user text or audio

443

# during a conversation to structured data that your apps and services can

444

# understand. You design and build a Dialogflow agent to handle the types of

445

# conversations required for your system.

446

#

447

# For more information about agents, see the

448

# [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).

449

"displayName": "A String", # Required. The name of this agent.

450

"timeZone": "A String", # Required. The time zone of this agent from the

451

# [time zone database](https://www.iana.org/time-zones), e.g.,

452

# America/New_York, Europe/Paris.

453

"parent": "A String", # Required. The project of this agent.

454

# Format: `projects/<Project ID>`.

455

"classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in

456

# matched natural language inputs for your agent, you can tune the machine

457

# learning classification threshold. If the returned score value is less than

458

# the threshold value, then a fallback intent will be triggered or, if there

459

# are no fallback intents defined, no intent will be triggered. The score

460

# values range from 0.0 (completely uncertain) to 1.0 (completely certain).

461

# If set to 0.0, the default of 0.3 is used.

462

"defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See

463

# [Language

464

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

465

# for a list of the currently supported language codes. This field cannot be

466

# set by the `Update` method.

467

"enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.

468

"description": "A String", # Optional. The description of this agent.

469

# The maximum length is 500 characters. If exceeded, the request is rejected.

470

"apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified,

471

# V2 API is assumed. Clients are free to query different service endpoints

472

# for different API versions. However, bots connectors and webhook calls will

473

# follow the specified API version.

474

"tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

475

"avatarUri": "A String", # Optional. The URI of the agent's avatar.

476

# Avatars are used throughout the Dialogflow console and in the self-hosted

477

# [Web

478

# Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)

479

# integration.

480

"matchMode": "A String", # Optional. Determines how intents are detected from user queries.

481

"supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the

482

# `default_language_code`).

"A String",

],

},

],

}</pre>

</div>

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

492

<pre>Retrieves the next page of results.

493

494

Args:

495

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

496

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

497

498

Returns:

499

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

500

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

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

505

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

506

<pre>Trains the specified agent.

507

508

509

Operation <response: google.protobuf.Empty>

510

511

Args:

512

parent: string, Required. The project that the agent to train is associated with.

513

Format: `projects/<Project ID>`. (required)

514

body: object, The request body.

515

The object takes the form of:

516

517

{ # The request message for Agents.TrainAgent.

518

}

519

520

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

527

528

{ # This resource represents a long-running operation that is the result of a

529

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

530

"name": "A String", # The server-assigned name, which is only unique within the same service that

531

# originally returns it. If you use the default HTTP mapping, the

532

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

533

"response": { # The normal response of the operation in case of success. If the original

534

# method returns no data on success, such as `Delete`, the response is

535

# `google.protobuf.Empty`. If the original method is standard

536

# `Get`/`Create`/`Update`, the response should be the resource. For other

537

# methods, the response should have the type `XxxResponse`, where `Xxx`

538

# is the original method name. For example, if the original method name

539

# is `TakeSnapshot()`, the inferred response type is

540

# `TakeSnapshotResponse`.

541

"a_key": "", # Properties of the object. Contains field @type with type URL.

542

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

543

"done": True or False, # If the value is `false`, it means the operation is still in progress.

544

# If `true`, the operation is completed, and either `error` or `response` is

545

# available.

546

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

547

# different programming environments, including REST APIs and RPC APIs. It is

548

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

549

# three pieces of data: error code, error message, and error details.

550

#

551

# You can find out more about this error model and how to work with it in the

552

# [API Design Guide](https://cloud.google.com/apis/design/errors).

553

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

554

"details": [ # A list of messages that carry the error details. There is a common set of

555

# message types for APIs to use.

556

{

557

"a_key": "", # Properties of the object. Contains field @type with type URL.

558

},

559

],

560

"message": "A String", # A developer-facing error message, which should be in English. Any

561

# user-facing error message should be localized and sent in the

562

# google.rpc.Status.details field, or localized by the client.

563

},

564

"metadata": { # Service-specific metadata associated with the operation. It typically

565

# contains progress information and common metadata such as create time.

566

# Some services might not provide such metadata. Any method that returns a

567

# long-running operation should document the metadata type, if any.

568

"a_key": "", # Properties of the object. Contains field @type with type URL.

569

},

Bu Sun Kim