Blame - docs/dyn/dialogflow_v2.projects.agent.intents.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Deletes intents in the specified agent.</p>

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Updates/Creates multiple intents in the specified agent.</p>

83

Bu Sun Kim

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

[diff] [blame^]

84

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

85

<p class="firstline">Creates an intent in the specified agent.</p>

86

87

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

88

<p class="firstline">Deletes the specified intent and its direct or indirect followup intents.</p>

89

Bu Sun Kim

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

[diff] [blame]

90

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

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

92

Bu Sun Kim

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

[diff] [blame]

93

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

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

95

96

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

97

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

98

Bu Sun Kim

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

[diff] [blame]

99

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

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

101

<h3>Method Details</h3>

102

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

103

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

104

<pre>Deletes intents in the specified agent.

105

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

106

Operation <response: google.protobuf.Empty>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

107

108

Args:

109

parent: string, Required. The name of the agent to delete all entities types for. Format:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

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

111

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

The object takes the form of:

113

114

{ # The request message for Intents.BatchDeleteIntents.

Bu Sun Kim

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

[diff] [blame]

115

"intents": [ # Required. The collection of intents to delete. Only intent `name` must be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

116

# filled in.

Bu Sun Kim

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

[diff] [blame^]

117

{ # An intent categorizes an end-user's intention for one conversation turn. For

118

# each agent, you define many intents, where your combined intents can handle a

119

# complete conversation. When an end-user writes or says something, referred to

120

# as an end-user expression or end-user input, Dialogflow matches the end-user

121

# input to the best intent in your agent. Matching an intent is also known as

122

# intent classification.

123

#

124

# For more information, see the [intent

125

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

126

"name": "A String", # Optional. The unique identifier of this intent.

127

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

128

# methods.

129

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

130

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

131

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

132

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

133

"messages": [ # Optional. The collection of rich messages corresponding to the

134

# `Response` field in the Dialogflow console.

135

{ # A rich response message.

136

# Corresponds to the intent `Response` field in the Dialogflow console.

137

# For more information, see

138

# [Rich response

139

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

140

"card": { # The card response message. # The card response.

141

"title": "A String", # Optional. The title of the card.

142

"subtitle": "A String", # Optional. The subtitle of the card.

143

"buttons": [ # Optional. The collection of card buttons.

144

{ # Contains information about a button.

145

"text": "A String", # Optional. The text to show on the button.

146

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

151

},

152

"text": { # The text response message. # The text response.

153

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

158

"items": [ # Required. Carousel items.

159

{ # An item in the carousel.

160

"description": "A String", # Optional. The body text of the card.

161

"title": "A String", # Required. Title of the carousel item.

162

"image": { # The image response message. # Optional. The image to display.

163

"imageUri": "A String", # Optional. The public URI to an image file.

164

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

165

# e.g., screen readers.

166

},

167

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

168

# dialog.

169

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

180

# This message in `QueryResult.fulfillment_messages` and

181

# `WebhookResponse.fulfillment_messages` should contain only one

182

# `SimpleResponse`.

183

"simpleResponses": [ # Required. The list of simple responses.

184

{ # The simple response message containing speech or text.

185

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

186

# speech output. Mutually exclusive with ssml.

187

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

188

# response to the user in the SSML format. Mutually exclusive with

189

# text_to_speech.

190

"displayText": "A String", # Optional. The text to display.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

195

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

196

# https://developers.google.com/actions/assistant/responses#browsing_carousel

197

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

198

# items, maximum of ten.

199

{ # Browsing carousel tile

200

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

201

# Card. Maximum of one line of text.

202

"image": { # The image response message. # Optional. Hero image for the carousel item.

203

"imageUri": "A String", # Optional. The public URI to an image file.

204

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

205

# e.g., screen readers.

206

},

207

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

208

# text.

209

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

210

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

211

"url": "A String", # Required. URL

212

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

213

# the URL. Defaults to opening via web browser.

},

},

],

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

218

# items.

219

},

220

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

221

# or website associated with this agent.

222

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

223

# suggestion chip.

224

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

225

},

226

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

227

"buttons": [ # Optional. The collection of card buttons.

228

{ # The button object that appears at the bottom of a card.

229

"title": "A String", # Required. The title of the button.

230

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

231

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

236

"formattedText": "A String", # Required, unless image is present. The body text of the card.

237

"title": "A String", # Optional. The title of the card.

238

"image": { # The image response message. # Optional. The image for the card.

239

"imageUri": "A String", # Optional. The public URI to an image file.

240

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

241

# e.g., screen readers.

242

},

243

},

244

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

245

"suggestions": [ # Required. The list of suggested replies.

246

{ # The suggestion chip message that the user can tap to quickly post a reply

247

# to the conversation.

248

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"quickReplies": { # The quick replies response message. # The quick replies response.

253

"quickReplies": [ # Optional. The collection of quick replies.

254

"A String",

255

],

256

"title": "A String", # Optional. The title of the collection of quick replies.

257

},

258

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

259

"title": "A String", # Required. Title of the card.

260

"columnProperties": [ # Optional. Display properties for the columns in this table.

261

{ # Column properties for TableCard.

262

"header": "A String", # Required. Column heading.

263

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

264

},

265

],

266

"subtitle": "A String", # Optional. Subtitle to the title.

267

"image": { # The image response message. # Optional. Image which should be displayed on the card.

268

"imageUri": "A String", # Optional. The public URI to an image file.

269

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

270

# e.g., screen readers.

271

},

272

"rows": [ # Optional. Rows in this table of data.

273

{ # Row of TableCard.

274

"cells": [ # Optional. List of cells that make up this row.

275

{ # Cell of TableCardRow.

276

"text": "A String", # Required. Text in this cell.

277

},

278

],

279

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

280

},

281

],

282

"buttons": [ # Optional. List of buttons for the card.

283

{ # The button object that appears at the bottom of a card.

284

"title": "A String", # Required. The title of the button.

285

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

286

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

},

"image": { # The image response message. # The image response.

292

"imageUri": "A String", # Optional. The public URI to an image file.

293

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

294

# e.g., screen readers.

295

},

296

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

297

"mediaObjects": [ # Required. List of media objects.

298

{ # Response media object for media content card.

299

"largeImage": { # The image response message. # Optional. Image to display above media content.

300

"imageUri": "A String", # Optional. The public URI to an image file.

301

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

302

# e.g., screen readers.

303

},

304

"contentUrl": "A String", # Required. Url where the media is stored.

305

"icon": { # The image response message. # Optional. Icon to display above media content.

306

"imageUri": "A String", # Optional. The public URI to an image file.

307

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

308

# e.g., screen readers.

309

},

310

"name": "A String", # Required. Name of media card.

311

"description": "A String", # Optional. Description of media card.

312

},

313

],

314

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

315

},

316

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

317

"title": "A String", # Optional. The overall title of the list.

318

"items": [ # Required. List items.

319

{ # An item in the list.

320

"image": { # The image response message. # Optional. The image to display.

321

"imageUri": "A String", # Optional. The public URI to an image file.

322

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

323

# e.g., screen readers.

324

},

325

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

326

# dialog.

327

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

332

# response is given.

333

},

334

"title": "A String", # Required. The title of the list item.

335

"description": "A String", # Optional. The main text describing the item.

336

},

337

],

338

"subtitle": "A String", # Optional. Subtitle of the list.

339

},

340

"payload": { # A custom platform-specific response.

341

"a_key": "", # Properties of the object.

342

},

343

},

344

],

Bu Sun Kim

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

[diff] [blame]

345

"events": [ # Optional. The collection of event names that trigger the intent.

346

# If the collection of input contexts is not empty, all of the contexts must

347

# be present in the active user session for an event to trigger this intent.

348

# Event names are limited to 150 characters.

349

"A String",

350

],

Bu Sun Kim

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

[diff] [blame]

351

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

352

# is matched. Context messages in this collection should not set the

353

# parameters field. Setting the `lifespan_count` to 0 will reset the context

354

# when the intent is matched.

355

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

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

[diff] [blame^]

356

{ # Dialogflow contexts are similar to natural language context. If a person says

357

# to you "they are orange", you need context in order to understand what "they"

358

# is referring to. Similarly, for Dialogflow to handle an end-user expression

359

# like that, it needs to be provided with context in order to correctly match

360

# an intent.

361

#

362

# Using contexts, you can control the flow of a conversation. You can configure

363

# contexts for an intent by setting input and output contexts, which are

364

# identified by string names. When an intent is matched, any configured output

365

# contexts for that intent become active. While any contexts are active,

366

# Dialogflow is more likely to match intents that are configured with input

367

# contexts that correspond to the currently active contexts.

368

#

369

# For more information about context, see the

370

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

Bu Sun Kim

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

[diff] [blame]

371

"parameters": { # Optional. The collection of parameters associated with this context.

372

#

373

# Depending on your protocol or client library language, this is a

374

# map, associative array, symbol table, dictionary, or JSON object

375

# composed of a collection of (MapKey, MapValue) pairs:

376

#

377

# - MapKey type: string

378

# - MapKey value: parameter name

379

# - MapValue type:

380

# - If parameter's entity type is a composite entity: map

381

# - Else: string or number, depending on parameter value type

382

# - MapValue value:

383

# - If parameter's entity type is a composite entity:

384

# map from composite entity property names to property values

385

# - Else: parameter value

386

"a_key": "", # Properties of the object.

387

},

Bu Sun Kim

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

[diff] [blame^]

388

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

389

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

390

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

391

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

392

#

393

# The `Context ID` is always converted to lowercase, may only contain

394

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

395

#

396

# If `Environment ID` is not specified, we assume default 'draft'

397

# environment. If `User ID` is not specified, we assume default '-' user.

398

#

399

# The following context names are reserved for internal use by Dialogflow.

400

# You should not use these contexts or create contexts with these names:

401

#

402

# * `__system_counters__`

403

# * `*_id_dialog_context`

404

# * `*_dialog_params_size`

405

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

406

# context expires. The default is `0`. If set to `0`, the context expires

407

# immediately. Contexts expire automatically after 20 minutes if there

408

# are no matching queries.

Bu Sun Kim

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

[diff] [blame]

409

},

410

],

Bu Sun Kim

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

[diff] [blame]

411

"action": "A String", # Optional. The name of the action associated with the intent.

412

# Note: The action name must not contain whitespaces.

Bu Sun Kim

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

[diff] [blame^]

413

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

414

# priorities.

415

#

416

# - If the supplied value is unspecified or 0, the service

417

# translates the value to 500,000, which corresponds to the

418

# `Normal` priority in the console.

419

# - If the supplied value is negative, the intent is ignored

420

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

421

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

422

# followup intents. It identifies the correct followup intents chain for

423

# this intent. We populate this field only in the output.

424

#

425

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

Bu Sun Kim

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

[diff] [blame^]

426

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

427

# a direct or indirect parent. We populate this field only in the output.

428

{ # Represents a single followup intent in the chain.

429

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

430

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

431

"followupIntentName": "A String", # The unique identifier of the followup intent.

432

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

433

},

434

],

Bu Sun Kim

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

[diff] [blame]

435

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

436

# trained on.

437

{ # Represents an example that the agent is trained on.

Bu Sun Kim

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

[diff] [blame]

438

"name": "A String", # Output only. The unique identifier of this training phrase.

439

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

440

# the intent. Each time a developer adds an existing sample by editing an

441

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

442

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

443

# The parts are concatenated in order to form the training phrase.

444

#

445

# Note: The API does not automatically annotate training phrases like the

446

# Dialogflow Console does.

447

#

448

# Note: Do not forget to include whitespace at part boundaries,

449

# so the training phrase is well formatted when the parts are concatenated.

450

#

451

# If the training phrase does not need to be annotated with parameters,

452

# you just need a single part with only the Part.text field set.

453

#

454

# If you want to annotate the training phrase, you must create multiple

455

# parts, where the fields of each part are populated in one of two ways:

456

#

457

# - `Part.text` is set to a part of the phrase that has no parameters.

458

# - `Part.text` is set to a part of the phrase that you want to annotate,

459

# and the `entity_type`, `alias`, and `user_defined` fields are all

460

# set.

461

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

462

"alias": "A String", # Optional. The parameter name for the value extracted from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

463

# annotated part of the example.

464

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

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

[diff] [blame]

465

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

466

# This field is set to true when the Dialogflow Console is used to

467

# manually annotate the part. When creating an annotated part with the

468

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

469

"text": "A String", # Required. The text for this part.

470

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

471

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

472

},

473

],

Bu Sun Kim

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

[diff] [blame^]

474

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

475

},

476

],

Bu Sun Kim

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

[diff] [blame^]

477

"inputContextNames": [ # Optional. The list of context names required for this intent to be

478

# triggered.

479

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

480

"A String",

481

],

482

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

483

# Note: If `ml_disabled` setting is set to true, then this intent is not

484

# taken into account during inference in `ML ONLY` match mode. Also,

485

# auto-markup in the UI is turned off.

Bu Sun Kim

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

[diff] [blame]

486

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

487

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame^]

488

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

489

# chain of followup intents. You can set this field when creating an intent,

490

# for example with CreateIntent or

491

# BatchUpdateIntents, in order to make this

492

# intent a followup intent.

493

#

494

# It identifies the parent followup intent.

495

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

496

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

497

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

498

"A String",

499

],

Bu Sun Kim

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

[diff] [blame]

500

"parameters": [ # Optional. The collection of parameters associated with the intent.

501

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

502

"value": "A String", # Optional. The definition of the parameter value. It can be:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

503

#

Bu Sun Kim

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

[diff] [blame]

504

# - a constant string,

505

# - a parameter value defined as `$parameter_name`,

506

# - an original parameter value defined as `$parameter_name.original`,

507

# - a parameter value from some context defined as

508

# `#context_name.parameter_name`.

509

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

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

[diff] [blame]

510

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

511

# whether the intent cannot be completed without collecting the parameter

512

# value.

Bu Sun Kim

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

[diff] [blame^]

513

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

514

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

515

# describes values of the parameter. If the parameter is

516

# required, this must be provided.

Bu Sun Kim

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

[diff] [blame]

517

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

518

# result.

519

# Default values can be extracted from contexts by using the following

520

# syntax: `#context_name.parameter_name`.

521

"name": "A String", # The unique identifier of this parameter.

Bu Sun Kim

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

[diff] [blame^]

522

"prompts": [ # Optional. The collection of prompts that the agent can present to the

523

# user in order to collect a value for the parameter.

524

"A String",

525

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

526

},

527

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

539

540

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

541

# network API call.

Bu Sun Kim

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

[diff] [blame]

542

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

543

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

544

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

Bu Sun Kim

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

[diff] [blame]

545

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

546

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

547

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

548

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

549

#

550

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

551

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

Bu Sun Kim

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

[diff] [blame^]

552

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

553

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

554

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

555

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

Bu Sun Kim

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

[diff] [blame]

556

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

557

# message types for APIs to use.

558

{

Bu Sun Kim

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

[diff] [blame]

559

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

560

},

561

],

Bu Sun Kim

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

[diff] [blame^]

562

},

563

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

564

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

565

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

566

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

567

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

568

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

569

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

570

# `TakeSnapshotResponse`.

571

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

572

},

Bu Sun Kim

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

[diff] [blame]

573

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

574

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

575

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

576

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

577

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

578

},

579

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

580

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

581

# available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

586

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

587

<pre>Updates/Creates multiple intents in the specified agent.

588

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

589

Operation <response: BatchUpdateIntentsResponse>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

590

591

Args:

592

parent: string, Required. The name of the agent to update or create intents in.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

593

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

594

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

595

The object takes the form of:

596

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

597

{

Bu Sun Kim

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

[diff] [blame^]

598

"languageCode": "A String", # Optional. The language used to access language-specific data.

599

# If not specified, the agent's default language is used.

600

# For more information, see

601

# [Multilingual intent and entity

602

# data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

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

[diff] [blame]

603

"intentBatchInline": { # This message is a wrapper around a collection of intents. # The collection of intents to update or create.

604

"intents": [ # A collection of intents.

Bu Sun Kim

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

[diff] [blame^]

605

{ # An intent categorizes an end-user's intention for one conversation turn. For

606

# each agent, you define many intents, where your combined intents can handle a

607

# complete conversation. When an end-user writes or says something, referred to

608

# as an end-user expression or end-user input, Dialogflow matches the end-user

609

# input to the best intent in your agent. Matching an intent is also known as

610

# intent classification.

611

#

612

# For more information, see the [intent

613

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

614

"name": "A String", # Optional. The unique identifier of this intent.

615

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

616

# methods.

617

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

618

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

619

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

620

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

621

"messages": [ # Optional. The collection of rich messages corresponding to the

622

# `Response` field in the Dialogflow console.

623

{ # A rich response message.

624

# Corresponds to the intent `Response` field in the Dialogflow console.

625

# For more information, see

626

# [Rich response

627

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

628

"card": { # The card response message. # The card response.

629

"title": "A String", # Optional. The title of the card.

630

"subtitle": "A String", # Optional. The subtitle of the card.

631

"buttons": [ # Optional. The collection of card buttons.

632

{ # Contains information about a button.

633

"text": "A String", # Optional. The text to show on the button.

634

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

639

},

640

"text": { # The text response message. # The text response.

641

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

646

"items": [ # Required. Carousel items.

647

{ # An item in the carousel.

648

"description": "A String", # Optional. The body text of the card.

649

"title": "A String", # Required. Title of the carousel item.

650

"image": { # The image response message. # Optional. The image to display.

651

"imageUri": "A String", # Optional. The public URI to an image file.

652

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

653

# e.g., screen readers.

654

},

655

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

656

# dialog.

657

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

668

# This message in `QueryResult.fulfillment_messages` and

669

# `WebhookResponse.fulfillment_messages` should contain only one

670

# `SimpleResponse`.

671

"simpleResponses": [ # Required. The list of simple responses.

672

{ # The simple response message containing speech or text.

673

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

674

# speech output. Mutually exclusive with ssml.

675

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

676

# response to the user in the SSML format. Mutually exclusive with

677

# text_to_speech.

678

"displayText": "A String", # Optional. The text to display.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

683

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

684

# https://developers.google.com/actions/assistant/responses#browsing_carousel

685

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

686

# items, maximum of ten.

687

{ # Browsing carousel tile

688

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

689

# Card. Maximum of one line of text.

690

"image": { # The image response message. # Optional. Hero image for the carousel item.

691

"imageUri": "A String", # Optional. The public URI to an image file.

692

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

693

# e.g., screen readers.

694

},

695

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

696

# text.

697

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

698

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

699

"url": "A String", # Required. URL

700

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

701

# the URL. Defaults to opening via web browser.

},

},

],

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

706

# items.

707

},

708

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

709

# or website associated with this agent.

710

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

711

# suggestion chip.

712

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

713

},

714

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

715

"buttons": [ # Optional. The collection of card buttons.

716

{ # The button object that appears at the bottom of a card.

717

"title": "A String", # Required. The title of the button.

718

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

719

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

724

"formattedText": "A String", # Required, unless image is present. The body text of the card.

725

"title": "A String", # Optional. The title of the card.

726

"image": { # The image response message. # Optional. The image for the card.

727

"imageUri": "A String", # Optional. The public URI to an image file.

728

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

729

# e.g., screen readers.

730

},

731

},

732

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

733

"suggestions": [ # Required. The list of suggested replies.

734

{ # The suggestion chip message that the user can tap to quickly post a reply

735

# to the conversation.

736

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"quickReplies": { # The quick replies response message. # The quick replies response.

741

"quickReplies": [ # Optional. The collection of quick replies.

742

"A String",

743

],

744

"title": "A String", # Optional. The title of the collection of quick replies.

745

},

746

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

747

"title": "A String", # Required. Title of the card.

748

"columnProperties": [ # Optional. Display properties for the columns in this table.

749

{ # Column properties for TableCard.

750

"header": "A String", # Required. Column heading.

751

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

752

},

753

],

754

"subtitle": "A String", # Optional. Subtitle to the title.

755

"image": { # The image response message. # Optional. Image which should be displayed on the card.

756

"imageUri": "A String", # Optional. The public URI to an image file.

757

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

758

# e.g., screen readers.

759

},

760

"rows": [ # Optional. Rows in this table of data.

761

{ # Row of TableCard.

762

"cells": [ # Optional. List of cells that make up this row.

763

{ # Cell of TableCardRow.

764

"text": "A String", # Required. Text in this cell.

765

},

766

],

767

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

768

},

769

],

770

"buttons": [ # Optional. List of buttons for the card.

771

{ # The button object that appears at the bottom of a card.

772

"title": "A String", # Required. The title of the button.

773

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

774

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

},

"image": { # The image response message. # The image response.

780

"imageUri": "A String", # Optional. The public URI to an image file.

781

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

782

# e.g., screen readers.

783

},

784

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

785

"mediaObjects": [ # Required. List of media objects.

786

{ # Response media object for media content card.

787

"largeImage": { # The image response message. # Optional. Image to display above media content.

788

"imageUri": "A String", # Optional. The public URI to an image file.

789

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

790

# e.g., screen readers.

791

},

792

"contentUrl": "A String", # Required. Url where the media is stored.

793

"icon": { # The image response message. # Optional. Icon to display above media content.

794

"imageUri": "A String", # Optional. The public URI to an image file.

795

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

796

# e.g., screen readers.

797

},

798

"name": "A String", # Required. Name of media card.

799

"description": "A String", # Optional. Description of media card.

800

},

801

],

802

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

803

},

804

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

805

"title": "A String", # Optional. The overall title of the list.

806

"items": [ # Required. List items.

807

{ # An item in the list.

808

"image": { # The image response message. # Optional. The image to display.

809

"imageUri": "A String", # Optional. The public URI to an image file.

810

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

811

# e.g., screen readers.

812

},

813

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

814

# dialog.

815

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

820

# response is given.

821

},

822

"title": "A String", # Required. The title of the list item.

823

"description": "A String", # Optional. The main text describing the item.

824

},

825

],

826

"subtitle": "A String", # Optional. Subtitle of the list.

827

},

828

"payload": { # A custom platform-specific response.

829

"a_key": "", # Properties of the object.

830

},

831

},

832

],

Bu Sun Kim

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

[diff] [blame]

833

"events": [ # Optional. The collection of event names that trigger the intent.

834

# If the collection of input contexts is not empty, all of the contexts must

835

# be present in the active user session for an event to trigger this intent.

836

# Event names are limited to 150 characters.

837

"A String",

838

],

Bu Sun Kim

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

[diff] [blame]

839

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

840

# is matched. Context messages in this collection should not set the

841

# parameters field. Setting the `lifespan_count` to 0 will reset the context

842

# when the intent is matched.

843

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

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

[diff] [blame^]

844

{ # Dialogflow contexts are similar to natural language context. If a person says

845

# to you "they are orange", you need context in order to understand what "they"

846

# is referring to. Similarly, for Dialogflow to handle an end-user expression

847

# like that, it needs to be provided with context in order to correctly match

848

# an intent.

849

#

850

# Using contexts, you can control the flow of a conversation. You can configure

851

# contexts for an intent by setting input and output contexts, which are

852

# identified by string names. When an intent is matched, any configured output

853

# contexts for that intent become active. While any contexts are active,

854

# Dialogflow is more likely to match intents that are configured with input

855

# contexts that correspond to the currently active contexts.

856

#

857

# For more information about context, see the

858

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

Bu Sun Kim

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

[diff] [blame]

859

"parameters": { # Optional. The collection of parameters associated with this context.

860

#

861

# Depending on your protocol or client library language, this is a

862

# map, associative array, symbol table, dictionary, or JSON object

863

# composed of a collection of (MapKey, MapValue) pairs:

864

#

865

# - MapKey type: string

866

# - MapKey value: parameter name

867

# - MapValue type:

868

# - If parameter's entity type is a composite entity: map

869

# - Else: string or number, depending on parameter value type

870

# - MapValue value:

871

# - If parameter's entity type is a composite entity:

872

# map from composite entity property names to property values

873

# - Else: parameter value

874

"a_key": "", # Properties of the object.

875

},

Bu Sun Kim

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

[diff] [blame^]

876

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

877

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

878

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

879

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

880

#

881

# The `Context ID` is always converted to lowercase, may only contain

882

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

883

#

884

# If `Environment ID` is not specified, we assume default 'draft'

885

# environment. If `User ID` is not specified, we assume default '-' user.

886

#

887

# The following context names are reserved for internal use by Dialogflow.

888

# You should not use these contexts or create contexts with these names:

889

#

890

# * `__system_counters__`

891

# * `*_id_dialog_context`

892

# * `*_dialog_params_size`

893

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

894

# context expires. The default is `0`. If set to `0`, the context expires

895

# immediately. Contexts expire automatically after 20 minutes if there

896

# are no matching queries.

Bu Sun Kim

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

[diff] [blame]

897

},

898

],

Bu Sun Kim

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

[diff] [blame]

899

"action": "A String", # Optional. The name of the action associated with the intent.

900

# Note: The action name must not contain whitespaces.

Bu Sun Kim

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

[diff] [blame^]

901

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

902

# priorities.

903

#

904

# - If the supplied value is unspecified or 0, the service

905

# translates the value to 500,000, which corresponds to the

906

# `Normal` priority in the console.

907

# - If the supplied value is negative, the intent is ignored

908

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

909

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

910

# followup intents. It identifies the correct followup intents chain for

911

# this intent. We populate this field only in the output.

912

#

913

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

Bu Sun Kim

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

[diff] [blame^]

914

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

915

# a direct or indirect parent. We populate this field only in the output.

916

{ # Represents a single followup intent in the chain.

917

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

918

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

919

"followupIntentName": "A String", # The unique identifier of the followup intent.

920

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

921

},

922

],

Bu Sun Kim

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

[diff] [blame]

923

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

924

# trained on.

925

{ # Represents an example that the agent is trained on.

Bu Sun Kim

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

[diff] [blame]

926

"name": "A String", # Output only. The unique identifier of this training phrase.

927

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

928

# the intent. Each time a developer adds an existing sample by editing an

929

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

930

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

931

# The parts are concatenated in order to form the training phrase.

932

#

933

# Note: The API does not automatically annotate training phrases like the

934

# Dialogflow Console does.

935

#

936

# Note: Do not forget to include whitespace at part boundaries,

937

# so the training phrase is well formatted when the parts are concatenated.

938

#

939

# If the training phrase does not need to be annotated with parameters,

940

# you just need a single part with only the Part.text field set.

941

#

942

# If you want to annotate the training phrase, you must create multiple

943

# parts, where the fields of each part are populated in one of two ways:

944

#

945

# - `Part.text` is set to a part of the phrase that has no parameters.

946

# - `Part.text` is set to a part of the phrase that you want to annotate,

947

# and the `entity_type`, `alias`, and `user_defined` fields are all

948

# set.

949

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

950

"alias": "A String", # Optional. The parameter name for the value extracted from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

951

# annotated part of the example.

952

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

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

[diff] [blame]

953

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

954

# This field is set to true when the Dialogflow Console is used to

955

# manually annotate the part. When creating an annotated part with the

956

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

957

"text": "A String", # Required. The text for this part.

958

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

959

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

960

},

961

],

Bu Sun Kim

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

[diff] [blame^]

962

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

963

},

964

],

Bu Sun Kim

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

[diff] [blame^]

965

"inputContextNames": [ # Optional. The list of context names required for this intent to be

966

# triggered.

967

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

968

"A String",

969

],

970

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

971

# Note: If `ml_disabled` setting is set to true, then this intent is not

972

# taken into account during inference in `ML ONLY` match mode. Also,

973

# auto-markup in the UI is turned off.

Bu Sun Kim

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

[diff] [blame]

974

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

975

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame^]

976

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

977

# chain of followup intents. You can set this field when creating an intent,

978

# for example with CreateIntent or

979

# BatchUpdateIntents, in order to make this

980

# intent a followup intent.

981

#

982

# It identifies the parent followup intent.

983

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

984

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

985

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

986

"A String",

987

],

Bu Sun Kim

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

[diff] [blame]

988

"parameters": [ # Optional. The collection of parameters associated with the intent.

989

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

990

"value": "A String", # Optional. The definition of the parameter value. It can be:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

991

#

Bu Sun Kim

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

[diff] [blame]

992

# - a constant string,

993

# - a parameter value defined as `$parameter_name`,

994

# - an original parameter value defined as `$parameter_name.original`,

995

# - a parameter value from some context defined as

996

# `#context_name.parameter_name`.

997

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

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

[diff] [blame]

998

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

999

# whether the intent cannot be completed without collecting the parameter

1000

# value.

Bu Sun Kim

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

[diff] [blame^]

1001

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1002

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1003

# describes values of the parameter. If the parameter is

1004

# required, this must be provided.

Bu Sun Kim

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

[diff] [blame]

1005

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1006

# result.

1007

# Default values can be extracted from contexts by using the following

1008

# syntax: `#context_name.parameter_name`.

1009

"name": "A String", # The unique identifier of this parameter.

Bu Sun Kim

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

[diff] [blame^]

1010

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1011

# user in order to collect a value for the parameter.

1012

"A String",

1013

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1014

},

1015

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1016

},

1017

],

1018

},

Bu Sun Kim

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

[diff] [blame^]

1019

"intentBatchUri": "A String", # The URI to a Google Cloud Storage file containing intents to update or

1020

# create. The file format can either be a serialized proto (of IntentBatch

1021

# type) or JSON object. Note: The URI must start with "gs://".

Bu Sun Kim

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

[diff] [blame]

1022

"updateMask": "A String", # Optional. The mask to control which fields get updated.

Bu Sun Kim

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

[diff] [blame^]

1023

"intentView": "A String", # Optional. The resource view to apply to the returned intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1024

}

1025

1026

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1033

1034

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

1035

# network API call.

Bu Sun Kim

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

[diff] [blame]

1036

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1037

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

1038

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

Bu Sun Kim

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

[diff] [blame]

1039

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1040

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

1041

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

1042

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

1043

#

1044

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

1045

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

Bu Sun Kim

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

[diff] [blame^]

1046

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

1047

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

1048

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

1049

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

Bu Sun Kim

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

[diff] [blame]

1050

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1051

# message types for APIs to use.

1052

{

Bu Sun Kim

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

[diff] [blame]

1053

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1054

},

1055

],

Bu Sun Kim

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

[diff] [blame^]

1056

},

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

# `TakeSnapshotResponse`.

1065

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1066

},

Bu Sun Kim

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

[diff] [blame]

1067

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

1068

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

1069

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

1070

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

1071

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

1072

},

1073

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

1074

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

1075

# available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

1080

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1081

<pre>Creates an intent in the specified agent.

1082

1083

Args:

1084

parent: string, Required. The agent to create a intent for.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1085

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

1086

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1087

The object takes the form of:

1088

Bu Sun Kim

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

[diff] [blame^]

1089

{ # An intent categorizes an end-user's intention for one conversation turn. For

1090

# each agent, you define many intents, where your combined intents can handle a

1091

# complete conversation. When an end-user writes or says something, referred to

1092

# as an end-user expression or end-user input, Dialogflow matches the end-user

1093

# input to the best intent in your agent. Matching an intent is also known as

1094

# intent classification.

1095

#

1096

# For more information, see the [intent

1097

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

1098

"name": "A String", # Optional. The unique identifier of this intent.

1099

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1100

# methods.

1101

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

1102

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

1103

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

1104

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

1105

"messages": [ # Optional. The collection of rich messages corresponding to the

1106

# `Response` field in the Dialogflow console.

1107

{ # A rich response message.

1108

# Corresponds to the intent `Response` field in the Dialogflow console.

1109

# For more information, see

1110

# [Rich response

1111

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

1112

"card": { # The card response message. # The card response.

1113

"title": "A String", # Optional. The title of the card.

1114

"subtitle": "A String", # Optional. The subtitle of the card.

1115

"buttons": [ # Optional. The collection of card buttons.

1116

{ # Contains information about a button.

1117

"text": "A String", # Optional. The text to show on the button.

1118

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

1123

},

1124

"text": { # The text response message. # The text response.

1125

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

1130

"items": [ # Required. Carousel items.

1131

{ # An item in the carousel.

1132

"description": "A String", # Optional. The body text of the card.

1133

"title": "A String", # Required. Title of the carousel item.

1134

"image": { # The image response message. # Optional. The image to display.

1135

"imageUri": "A String", # Optional. The public URI to an image file.

1136

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1137

# e.g., screen readers.

1138

},

1139

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

1140

# dialog.

1141

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

1152

# This message in `QueryResult.fulfillment_messages` and

1153

# `WebhookResponse.fulfillment_messages` should contain only one

1154

# `SimpleResponse`.

1155

"simpleResponses": [ # Required. The list of simple responses.

1156

{ # The simple response message containing speech or text.

1157

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

1158

# speech output. Mutually exclusive with ssml.

1159

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

1160

# response to the user in the SSML format. Mutually exclusive with

1161

# text_to_speech.

1162

"displayText": "A String", # Optional. The text to display.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

1167

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

1168

# https://developers.google.com/actions/assistant/responses#browsing_carousel

1169

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

1170

# items, maximum of ten.

1171

{ # Browsing carousel tile

1172

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

1173

# Card. Maximum of one line of text.

1174

"image": { # The image response message. # Optional. Hero image for the carousel item.

1175

"imageUri": "A String", # Optional. The public URI to an image file.

1176

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1177

# e.g., screen readers.

1178

},

1179

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

1180

# text.

1181

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

1182

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1183

"url": "A String", # Required. URL

1184

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

1185

# the URL. Defaults to opening via web browser.

},

},

],

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

1190

# items.

1191

},

1192

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

1193

# or website associated with this agent.

1194

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

1195

# suggestion chip.

1196

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1197

},

1198

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

1199

"buttons": [ # Optional. The collection of card buttons.

1200

{ # The button object that appears at the bottom of a card.

1201

"title": "A String", # Required. The title of the button.

1202

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1203

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

1208

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1209

"title": "A String", # Optional. The title of the card.

1210

"image": { # The image response message. # Optional. The image for the card.

1211

"imageUri": "A String", # Optional. The public URI to an image file.

1212

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1213

# e.g., screen readers.

1214

},

1215

},

1216

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

1217

"suggestions": [ # Required. The list of suggested replies.

1218

{ # The suggestion chip message that the user can tap to quickly post a reply

1219

# to the conversation.

1220

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"quickReplies": { # The quick replies response message. # The quick replies response.

1225

"quickReplies": [ # Optional. The collection of quick replies.

1226

"A String",

1227

],

1228

"title": "A String", # Optional. The title of the collection of quick replies.

1229

},

1230

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

1231

"title": "A String", # Required. Title of the card.

1232

"columnProperties": [ # Optional. Display properties for the columns in this table.

1233

{ # Column properties for TableCard.

1234

"header": "A String", # Required. Column heading.

1235

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

1236

},

1237

],

1238

"subtitle": "A String", # Optional. Subtitle to the title.

1239

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1240

"imageUri": "A String", # Optional. The public URI to an image file.

1241

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1242

# e.g., screen readers.

1243

},

1244

"rows": [ # Optional. Rows in this table of data.

1245

{ # Row of TableCard.

1246

"cells": [ # Optional. List of cells that make up this row.

1247

{ # Cell of TableCardRow.

1248

"text": "A String", # Required. Text in this cell.

1249

},

1250

],

1251

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

1252

},

1253

],

1254

"buttons": [ # Optional. List of buttons for the card.

1255

{ # The button object that appears at the bottom of a card.

1256

"title": "A String", # Required. The title of the button.

1257

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1258

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

},

"image": { # The image response message. # The image response.

1264

"imageUri": "A String", # Optional. The public URI to an image file.

1265

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1266

# e.g., screen readers.

1267

},

1268

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1269

"mediaObjects": [ # Required. List of media objects.

1270

{ # Response media object for media content card.

1271

"largeImage": { # The image response message. # Optional. Image to display above media content.

1272

"imageUri": "A String", # Optional. The public URI to an image file.

1273

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1274

# e.g., screen readers.

1275

},

1276

"contentUrl": "A String", # Required. Url where the media is stored.

1277

"icon": { # The image response message. # Optional. Icon to display above media content.

1278

"imageUri": "A String", # Optional. The public URI to an image file.

1279

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1280

# e.g., screen readers.

1281

},

1282

"name": "A String", # Required. Name of media card.

1283

"description": "A String", # Optional. Description of media card.

1284

},

1285

],

1286

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1287

},

1288

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

1289

"title": "A String", # Optional. The overall title of the list.

1290

"items": [ # Required. List items.

1291

{ # An item in the list.

1292

"image": { # The image response message. # Optional. The image to display.

1293

"imageUri": "A String", # Optional. The public URI to an image file.

1294

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1295

# e.g., screen readers.

1296

},

1297

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

1298

# dialog.

1299

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

1304

# response is given.

1305

},

1306

"title": "A String", # Required. The title of the list item.

1307

"description": "A String", # Optional. The main text describing the item.

1308

},

1309

],

1310

"subtitle": "A String", # Optional. Subtitle of the list.

1311

},

1312

"payload": { # A custom platform-specific response.

1313

"a_key": "", # Properties of the object.

1314

},

1315

},

1316

],

Bu Sun Kim

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

[diff] [blame]

1317

"events": [ # Optional. The collection of event names that trigger the intent.

1318

# If the collection of input contexts is not empty, all of the contexts must

1319

# be present in the active user session for an event to trigger this intent.

1320

# Event names are limited to 150 characters.

1321

"A String",

1322

],

Bu Sun Kim

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

[diff] [blame]

1323

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

1324

# is matched. Context messages in this collection should not set the

1325

# parameters field. Setting the `lifespan_count` to 0 will reset the context

1326

# when the intent is matched.

1327

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

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

[diff] [blame^]

1328

{ # Dialogflow contexts are similar to natural language context. If a person says

1329

# to you "they are orange", you need context in order to understand what "they"

1330

# is referring to. Similarly, for Dialogflow to handle an end-user expression

1331

# like that, it needs to be provided with context in order to correctly match

1332

# an intent.

1333

#

1334

# Using contexts, you can control the flow of a conversation. You can configure

1335

# contexts for an intent by setting input and output contexts, which are

1336

# identified by string names. When an intent is matched, any configured output

1337

# contexts for that intent become active. While any contexts are active,

1338

# Dialogflow is more likely to match intents that are configured with input

1339

# contexts that correspond to the currently active contexts.

1340

#

1341

# For more information about context, see the

1342

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

Bu Sun Kim

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

[diff] [blame]

1343

"parameters": { # Optional. The collection of parameters associated with this context.

1344

#

1345

# Depending on your protocol or client library language, this is a

1346

# map, associative array, symbol table, dictionary, or JSON object

1347

# composed of a collection of (MapKey, MapValue) pairs:

1348

#

1349

# - MapKey type: string

1350

# - MapKey value: parameter name

1351

# - MapValue type:

1352

# - If parameter's entity type is a composite entity: map

1353

# - Else: string or number, depending on parameter value type

1354

# - MapValue value:

1355

# - If parameter's entity type is a composite entity:

1356

# map from composite entity property names to property values

1357

# - Else: parameter value

1358

"a_key": "", # Properties of the object.

1359

},

Bu Sun Kim

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

[diff] [blame^]

1360

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

1361

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1362

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1363

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

1364

#

1365

# The `Context ID` is always converted to lowercase, may only contain

1366

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

1367

#

1368

# If `Environment ID` is not specified, we assume default 'draft'

1369

# environment. If `User ID` is not specified, we assume default '-' user.

1370

#

1371

# The following context names are reserved for internal use by Dialogflow.

1372

# You should not use these contexts or create contexts with these names:

1373

#

1374

# * `__system_counters__`

1375

# * `*_id_dialog_context`

1376

# * `*_dialog_params_size`

1377

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1378

# context expires. The default is `0`. If set to `0`, the context expires

1379

# immediately. Contexts expire automatically after 20 minutes if there

1380

# are no matching queries.

Bu Sun Kim

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

[diff] [blame]

1381

},

1382

],

Bu Sun Kim

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

[diff] [blame]

1383

"action": "A String", # Optional. The name of the action associated with the intent.

1384

# Note: The action name must not contain whitespaces.

Bu Sun Kim

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

[diff] [blame^]

1385

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

1386

# priorities.

1387

#

1388

# - If the supplied value is unspecified or 0, the service

1389

# translates the value to 500,000, which corresponds to the

1390

# `Normal` priority in the console.

1391

# - If the supplied value is negative, the intent is ignored

1392

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

1393

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

1394

# followup intents. It identifies the correct followup intents chain for

1395

# this intent. We populate this field only in the output.

1396

#

1397

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

Bu Sun Kim

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

[diff] [blame^]

1398

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

1399

# a direct or indirect parent. We populate this field only in the output.

1400

{ # Represents a single followup intent in the chain.

1401

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

1402

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

1403

"followupIntentName": "A String", # The unique identifier of the followup intent.

1404

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

1405

},

1406

],

Bu Sun Kim

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

[diff] [blame]

1407

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1408

# trained on.

1409

{ # Represents an example that the agent is trained on.

Bu Sun Kim

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

[diff] [blame]

1410

"name": "A String", # Output only. The unique identifier of this training phrase.

1411

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

1412

# the intent. Each time a developer adds an existing sample by editing an

1413

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

1414

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1415

# The parts are concatenated in order to form the training phrase.

1416

#

1417

# Note: The API does not automatically annotate training phrases like the

1418

# Dialogflow Console does.

1419

#

1420

# Note: Do not forget to include whitespace at part boundaries,

1421

# so the training phrase is well formatted when the parts are concatenated.

1422

#

1423

# If the training phrase does not need to be annotated with parameters,

1424

# you just need a single part with only the Part.text field set.

1425

#

1426

# If you want to annotate the training phrase, you must create multiple

1427

# parts, where the fields of each part are populated in one of two ways:

1428

#

1429

# - `Part.text` is set to a part of the phrase that has no parameters.

1430

# - `Part.text` is set to a part of the phrase that you want to annotate,

1431

# and the `entity_type`, `alias`, and `user_defined` fields are all

1432

# set.

1433

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

1434

"alias": "A String", # Optional. The parameter name for the value extracted from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1435

# annotated part of the example.

1436

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

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

[diff] [blame]

1437

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1438

# This field is set to true when the Dialogflow Console is used to

1439

# manually annotate the part. When creating an annotated part with the

1440

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

1441

"text": "A String", # Required. The text for this part.

1442

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

1443

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1444

},

1445

],

Bu Sun Kim

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

[diff] [blame^]

1446

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1447

},

1448

],

Bu Sun Kim

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

[diff] [blame^]

1449

"inputContextNames": [ # Optional. The list of context names required for this intent to be

1450

# triggered.

1451

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

1452

"A String",

1453

],

1454

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

1455

# Note: If `ml_disabled` setting is set to true, then this intent is not

1456

# taken into account during inference in `ML ONLY` match mode. Also,

1457

# auto-markup in the UI is turned off.

Bu Sun Kim

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

[diff] [blame]

1458

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1459

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame^]

1460

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

1461

# chain of followup intents. You can set this field when creating an intent,

1462

# for example with CreateIntent or

1463

# BatchUpdateIntents, in order to make this

1464

# intent a followup intent.

1465

#

1466

# It identifies the parent followup intent.

1467

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

1468

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

1469

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1470

"A String",

1471

],

Bu Sun Kim

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

[diff] [blame]

1472

"parameters": [ # Optional. The collection of parameters associated with the intent.

1473

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

1474

"value": "A String", # Optional. The definition of the parameter value. It can be:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1475

#

Bu Sun Kim

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

[diff] [blame]

1476

# - a constant string,

1477

# - a parameter value defined as `$parameter_name`,

1478

# - an original parameter value defined as `$parameter_name.original`,

1479

# - a parameter value from some context defined as

1480

# `#context_name.parameter_name`.

1481

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

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

[diff] [blame]

1482

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

1483

# whether the intent cannot be completed without collecting the parameter

1484

# value.

Bu Sun Kim

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

[diff] [blame^]

1485

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1486

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1487

# describes values of the parameter. If the parameter is

1488

# required, this must be provided.

Bu Sun Kim

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

[diff] [blame]

1489

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1490

# result.

1491

# Default values can be extracted from contexts by using the following

1492

# syntax: `#context_name.parameter_name`.

1493

"name": "A String", # The unique identifier of this parameter.

Bu Sun Kim

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

[diff] [blame^]

1494

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1495

# user in order to collect a value for the parameter.

1496

"A String",

1497

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1498

},

1499

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1500

}

1501

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1502

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

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

[diff] [blame]

1503

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1504

For more information, see

1505

[Multilingual intent and entity

1506

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

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

[diff] [blame^]

1507

intentView: string, Optional. The resource view to apply to the returned intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1508

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1515

Bu Sun Kim

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

[diff] [blame^]

1516

{ # An intent categorizes an end-user's intention for one conversation turn. For

1517

# each agent, you define many intents, where your combined intents can handle a

1518

# complete conversation. When an end-user writes or says something, referred to

1519

# as an end-user expression or end-user input, Dialogflow matches the end-user

1520

# input to the best intent in your agent. Matching an intent is also known as

1521

# intent classification.

1522

#

1523

# For more information, see the [intent

1524

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

1525

"name": "A String", # Optional. The unique identifier of this intent.

1526

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1527

# methods.

1528

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

1529

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

1530

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

1531

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

1532

"messages": [ # Optional. The collection of rich messages corresponding to the

1533

# `Response` field in the Dialogflow console.

1534

{ # A rich response message.

1535

# Corresponds to the intent `Response` field in the Dialogflow console.

1536

# For more information, see

1537

# [Rich response

1538

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

1539

"card": { # The card response message. # The card response.

1540

"title": "A String", # Optional. The title of the card.

1541

"subtitle": "A String", # Optional. The subtitle of the card.

1542

"buttons": [ # Optional. The collection of card buttons.

1543

{ # Contains information about a button.

1544

"text": "A String", # Optional. The text to show on the button.

1545

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

1550

},

1551

"text": { # The text response message. # The text response.

1552

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

1557

"items": [ # Required. Carousel items.

1558

{ # An item in the carousel.

1559

"description": "A String", # Optional. The body text of the card.

1560

"title": "A String", # Required. Title of the carousel item.

1561

"image": { # The image response message. # Optional. The image to display.

1562

"imageUri": "A String", # Optional. The public URI to an image file.

1563

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1564

# e.g., screen readers.

1565

},

1566

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

1567

# dialog.

1568

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

1579

# This message in `QueryResult.fulfillment_messages` and

1580

# `WebhookResponse.fulfillment_messages` should contain only one

1581

# `SimpleResponse`.

1582

"simpleResponses": [ # Required. The list of simple responses.

1583

{ # The simple response message containing speech or text.

1584

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

1585

# speech output. Mutually exclusive with ssml.

1586

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

1587

# response to the user in the SSML format. Mutually exclusive with

1588

# text_to_speech.

1589

"displayText": "A String", # Optional. The text to display.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

1594

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

1595

# https://developers.google.com/actions/assistant/responses#browsing_carousel

1596

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

1597

# items, maximum of ten.

1598

{ # Browsing carousel tile

1599

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

1600

# Card. Maximum of one line of text.

1601

"image": { # The image response message. # Optional. Hero image for the carousel item.

1602

"imageUri": "A String", # Optional. The public URI to an image file.

1603

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1604

# e.g., screen readers.

1605

},

1606

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

1607

# text.

1608

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

1609

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1610

"url": "A String", # Required. URL

1611

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

1612

# the URL. Defaults to opening via web browser.

},

},

],

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

1617

# items.

1618

},

1619

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

1620

# or website associated with this agent.

1621

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

1622

# suggestion chip.

1623

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1624

},

1625

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

1626

"buttons": [ # Optional. The collection of card buttons.

1627

{ # The button object that appears at the bottom of a card.

1628

"title": "A String", # Required. The title of the button.

1629

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1630

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

1635

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1636

"title": "A String", # Optional. The title of the card.

1637

"image": { # The image response message. # Optional. The image for the card.

1638

"imageUri": "A String", # Optional. The public URI to an image file.

1639

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1640

# e.g., screen readers.

1641

},

1642

},

1643

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

1644

"suggestions": [ # Required. The list of suggested replies.

1645

{ # The suggestion chip message that the user can tap to quickly post a reply

1646

# to the conversation.

1647

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"quickReplies": { # The quick replies response message. # The quick replies response.

1652

"quickReplies": [ # Optional. The collection of quick replies.

1653

"A String",

1654

],

1655

"title": "A String", # Optional. The title of the collection of quick replies.

1656

},

1657

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

1658

"title": "A String", # Required. Title of the card.

1659

"columnProperties": [ # Optional. Display properties for the columns in this table.

1660

{ # Column properties for TableCard.

1661

"header": "A String", # Required. Column heading.

1662

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

1663

},

1664

],

1665

"subtitle": "A String", # Optional. Subtitle to the title.

1666

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1667

"imageUri": "A String", # Optional. The public URI to an image file.

1668

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1669

# e.g., screen readers.

1670

},

1671

"rows": [ # Optional. Rows in this table of data.

1672

{ # Row of TableCard.

1673

"cells": [ # Optional. List of cells that make up this row.

1674

{ # Cell of TableCardRow.

1675

"text": "A String", # Required. Text in this cell.

1676

},

1677

],

1678

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

1679

},

1680

],

1681

"buttons": [ # Optional. List of buttons for the card.

1682

{ # The button object that appears at the bottom of a card.

1683

"title": "A String", # Required. The title of the button.

1684

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1685

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

},

"image": { # The image response message. # The image response.

1691

"imageUri": "A String", # Optional. The public URI to an image file.

1692

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1693

# e.g., screen readers.

1694

},

1695

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1696

"mediaObjects": [ # Required. List of media objects.

1697

{ # Response media object for media content card.

1698

"largeImage": { # The image response message. # Optional. Image to display above media content.

1699

"imageUri": "A String", # Optional. The public URI to an image file.

1700

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1701

# e.g., screen readers.

1702

},

1703

"contentUrl": "A String", # Required. Url where the media is stored.

1704

"icon": { # The image response message. # Optional. Icon to display above media content.

1705

"imageUri": "A String", # Optional. The public URI to an image file.

1706

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1707

# e.g., screen readers.

1708

},

1709

"name": "A String", # Required. Name of media card.

1710

"description": "A String", # Optional. Description of media card.

1711

},

1712

],

1713

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1714

},

1715

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

1716

"title": "A String", # Optional. The overall title of the list.

1717

"items": [ # Required. List items.

1718

{ # An item in the list.

1719

"image": { # The image response message. # Optional. The image to display.

1720

"imageUri": "A String", # Optional. The public URI to an image file.

1721

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1722

# e.g., screen readers.

1723

},

1724

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

1725

# dialog.

1726

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

1731

# response is given.

1732

},

1733

"title": "A String", # Required. The title of the list item.

1734

"description": "A String", # Optional. The main text describing the item.

1735

},

1736

],

1737

"subtitle": "A String", # Optional. Subtitle of the list.

1738

},

1739

"payload": { # A custom platform-specific response.

1740

"a_key": "", # Properties of the object.

1741

},

1742

},

1743

],

Bu Sun Kim

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

[diff] [blame]

1744

"events": [ # Optional. The collection of event names that trigger the intent.

1745

# If the collection of input contexts is not empty, all of the contexts must

1746

# be present in the active user session for an event to trigger this intent.

1747

# Event names are limited to 150 characters.

1748

"A String",

1749

],

Bu Sun Kim

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

[diff] [blame]

1750

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

1751

# is matched. Context messages in this collection should not set the

1752

# parameters field. Setting the `lifespan_count` to 0 will reset the context

1753

# when the intent is matched.

1754

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

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

[diff] [blame^]

1755

{ # Dialogflow contexts are similar to natural language context. If a person says

1756

# to you "they are orange", you need context in order to understand what "they"

1757

# is referring to. Similarly, for Dialogflow to handle an end-user expression

1758

# like that, it needs to be provided with context in order to correctly match

1759

# an intent.

1760

#

1761

# Using contexts, you can control the flow of a conversation. You can configure

1762

# contexts for an intent by setting input and output contexts, which are

1763

# identified by string names. When an intent is matched, any configured output

1764

# contexts for that intent become active. While any contexts are active,

1765

# Dialogflow is more likely to match intents that are configured with input

1766

# contexts that correspond to the currently active contexts.

1767

#

1768

# For more information about context, see the

1769

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

Bu Sun Kim

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

[diff] [blame]

1770

"parameters": { # Optional. The collection of parameters associated with this context.

1771

#

1772

# Depending on your protocol or client library language, this is a

1773

# map, associative array, symbol table, dictionary, or JSON object

1774

# composed of a collection of (MapKey, MapValue) pairs:

1775

#

1776

# - MapKey type: string

1777

# - MapKey value: parameter name

1778

# - MapValue type:

1779

# - If parameter's entity type is a composite entity: map

1780

# - Else: string or number, depending on parameter value type

1781

# - MapValue value:

1782

# - If parameter's entity type is a composite entity:

1783

# map from composite entity property names to property values

1784

# - Else: parameter value

1785

"a_key": "", # Properties of the object.

1786

},

Bu Sun Kim

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

[diff] [blame^]

1787

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

1788

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1789

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1790

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

1791

#

1792

# The `Context ID` is always converted to lowercase, may only contain

1793

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

1794

#

1795

# If `Environment ID` is not specified, we assume default 'draft'

1796

# environment. If `User ID` is not specified, we assume default '-' user.

1797

#

1798

# The following context names are reserved for internal use by Dialogflow.

1799

# You should not use these contexts or create contexts with these names:

1800

#

1801

# * `__system_counters__`

1802

# * `*_id_dialog_context`

1803

# * `*_dialog_params_size`

1804

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1805

# context expires. The default is `0`. If set to `0`, the context expires

1806

# immediately. Contexts expire automatically after 20 minutes if there

1807

# are no matching queries.

Bu Sun Kim

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

[diff] [blame]

1808

},

1809

],

Bu Sun Kim

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

[diff] [blame]

1810

"action": "A String", # Optional. The name of the action associated with the intent.

1811

# Note: The action name must not contain whitespaces.

Bu Sun Kim

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

[diff] [blame^]

1812

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

1813

# priorities.

1814

#

1815

# - If the supplied value is unspecified or 0, the service

1816

# translates the value to 500,000, which corresponds to the

1817

# `Normal` priority in the console.

1818

# - If the supplied value is negative, the intent is ignored

1819

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

1820

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

1821

# followup intents. It identifies the correct followup intents chain for

1822

# this intent. We populate this field only in the output.

1823

#

1824

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

Bu Sun Kim

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

[diff] [blame^]

1825

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

1826

# a direct or indirect parent. We populate this field only in the output.

1827

{ # Represents a single followup intent in the chain.

1828

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

1829

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

1830

"followupIntentName": "A String", # The unique identifier of the followup intent.

1831

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

1832

},

1833

],

Bu Sun Kim

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

[diff] [blame]

1834

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1835

# trained on.

1836

{ # Represents an example that the agent is trained on.

Bu Sun Kim

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

[diff] [blame]

1837

"name": "A String", # Output only. The unique identifier of this training phrase.

1838

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

1839

# the intent. Each time a developer adds an existing sample by editing an

1840

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

1841

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1842

# The parts are concatenated in order to form the training phrase.

1843

#

1844

# Note: The API does not automatically annotate training phrases like the

1845

# Dialogflow Console does.

1846

#

1847

# Note: Do not forget to include whitespace at part boundaries,

1848

# so the training phrase is well formatted when the parts are concatenated.

1849

#

1850

# If the training phrase does not need to be annotated with parameters,

1851

# you just need a single part with only the Part.text field set.

1852

#

1853

# If you want to annotate the training phrase, you must create multiple

1854

# parts, where the fields of each part are populated in one of two ways:

1855

#

1856

# - `Part.text` is set to a part of the phrase that has no parameters.

1857

# - `Part.text` is set to a part of the phrase that you want to annotate,

1858

# and the `entity_type`, `alias`, and `user_defined` fields are all

1859

# set.

1860

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

1861

"alias": "A String", # Optional. The parameter name for the value extracted from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1862

# annotated part of the example.

1863

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

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

[diff] [blame]

1864

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1865

# This field is set to true when the Dialogflow Console is used to

1866

# manually annotate the part. When creating an annotated part with the

1867

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

1868

"text": "A String", # Required. The text for this part.

1869

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

1870

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1871

},

1872

],

Bu Sun Kim

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

[diff] [blame^]

1873

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1874

},

1875

],

Bu Sun Kim

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

[diff] [blame^]

1876

"inputContextNames": [ # Optional. The list of context names required for this intent to be

1877

# triggered.

1878

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

1879

"A String",

1880

],

1881

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

1882

# Note: If `ml_disabled` setting is set to true, then this intent is not

1883

# taken into account during inference in `ML ONLY` match mode. Also,

1884

# auto-markup in the UI is turned off.

Bu Sun Kim

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

[diff] [blame]

1885

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1886

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame^]

1887

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

1888

# chain of followup intents. You can set this field when creating an intent,

1889

# for example with CreateIntent or

1890

# BatchUpdateIntents, in order to make this

1891

# intent a followup intent.

1892

#

1893

# It identifies the parent followup intent.

1894

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

1895

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

1896

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1897

"A String",

1898

],

Bu Sun Kim

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

[diff] [blame]

1899

"parameters": [ # Optional. The collection of parameters associated with the intent.

1900

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

1901

"value": "A String", # Optional. The definition of the parameter value. It can be:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1902

#

Bu Sun Kim

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

[diff] [blame]

1903

# - a constant string,

1904

# - a parameter value defined as `$parameter_name`,

1905

# - an original parameter value defined as `$parameter_name.original`,

1906

# - a parameter value from some context defined as

1907

# `#context_name.parameter_name`.

1908

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

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

[diff] [blame]

1909

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

1910

# whether the intent cannot be completed without collecting the parameter

1911

# value.

Bu Sun Kim

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

[diff] [blame^]

1912

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1913

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1914

# describes values of the parameter. If the parameter is

1915

# required, this must be provided.

Bu Sun Kim

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

[diff] [blame]

1916

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1917

# result.

1918

# Default values can be extracted from contexts by using the following

1919

# syntax: `#context_name.parameter_name`.

1920

"name": "A String", # The unique identifier of this parameter.

Bu Sun Kim

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

[diff] [blame^]

1921

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1922

# user in order to collect a value for the parameter.

1923

"A String",

1924

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1925

},

1926

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

1932

<pre>Deletes the specified intent and its direct or indirect followup intents.

1933

1934

Args:

1935

name: string, Required. The name of the intent to delete. If this intent has direct or

1936

indirect followup intents, we also delete them.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1937

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1938

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1945

1946

{ # A generic empty message that you can re-use to avoid defining duplicated

1947

# empty messages in your APIs. A typical example is to use it as the request

1948

# or the response type of an API method. For instance:

1949

#

1950

# service Foo {

1951

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1952

# }

1953

#

1954

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1959

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1960

<pre>Retrieves the specified intent.

1961

1962

Args:

1963

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1964

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

Bu Sun Kim

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

[diff] [blame]

1965

intentView: string, Optional. The resource view to apply to the returned intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1966

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

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

[diff] [blame]

1967

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1968

For more information, see

1969

[Multilingual intent and entity

1970

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1971

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1978

Bu Sun Kim

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

[diff] [blame^]

1979

{ # An intent categorizes an end-user's intention for one conversation turn. For

1980

# each agent, you define many intents, where your combined intents can handle a

1981

# complete conversation. When an end-user writes or says something, referred to

1982

# as an end-user expression or end-user input, Dialogflow matches the end-user

1983

# input to the best intent in your agent. Matching an intent is also known as

1984

# intent classification.

1985

#

1986

# For more information, see the [intent

1987

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

1988

"name": "A String", # Optional. The unique identifier of this intent.

1989

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1990

# methods.

1991

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

1992

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

1993

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

1994

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

1995

"messages": [ # Optional. The collection of rich messages corresponding to the

1996

# `Response` field in the Dialogflow console.

1997

{ # A rich response message.

1998

# Corresponds to the intent `Response` field in the Dialogflow console.

1999

# For more information, see

2000

# [Rich response

2001

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

2002

"card": { # The card response message. # The card response.

2003

"title": "A String", # Optional. The title of the card.

2004

"subtitle": "A String", # Optional. The subtitle of the card.

2005

"buttons": [ # Optional. The collection of card buttons.

2006

{ # Contains information about a button.

2007

"text": "A String", # Optional. The text to show on the button.

2008

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2013

},

2014

"text": { # The text response message. # The text response.

2015

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

2020

"items": [ # Required. Carousel items.

2021

{ # An item in the carousel.

2022

"description": "A String", # Optional. The body text of the card.

2023

"title": "A String", # Required. Title of the carousel item.

2024

"image": { # The image response message. # Optional. The image to display.

2025

"imageUri": "A String", # Optional. The public URI to an image file.

2026

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2027

# e.g., screen readers.

2028

},

2029

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2030

# dialog.

2031

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

2042

# This message in `QueryResult.fulfillment_messages` and

2043

# `WebhookResponse.fulfillment_messages` should contain only one

2044

# `SimpleResponse`.

2045

"simpleResponses": [ # Required. The list of simple responses.

2046

{ # The simple response message containing speech or text.

2047

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2048

# speech output. Mutually exclusive with ssml.

2049

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2050

# response to the user in the SSML format. Mutually exclusive with

2051

# text_to_speech.

2052

"displayText": "A String", # Optional. The text to display.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2057

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2058

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2059

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2060

# items, maximum of ten.

2061

{ # Browsing carousel tile

2062

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2063

# Card. Maximum of one line of text.

2064

"image": { # The image response message. # Optional. Hero image for the carousel item.

2065

"imageUri": "A String", # Optional. The public URI to an image file.

2066

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2067

# e.g., screen readers.

2068

},

2069

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2070

# text.

2071

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2072

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2073

"url": "A String", # Required. URL

2074

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2075

# the URL. Defaults to opening via web browser.

},

},

],

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2080

# items.

2081

},

2082

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

2083

# or website associated with this agent.

2084

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2085

# suggestion chip.

2086

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2087

},

2088

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

2089

"buttons": [ # Optional. The collection of card buttons.

2090

{ # The button object that appears at the bottom of a card.

2091

"title": "A String", # Required. The title of the button.

2092

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2093

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

2098

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2099

"title": "A String", # Optional. The title of the card.

2100

"image": { # The image response message. # Optional. The image for the card.

2101

"imageUri": "A String", # Optional. The public URI to an image file.

2102

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2103

# e.g., screen readers.

2104

},

2105

},

2106

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

2107

"suggestions": [ # Required. The list of suggested replies.

2108

{ # The suggestion chip message that the user can tap to quickly post a reply

2109

# to the conversation.

2110

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"quickReplies": { # The quick replies response message. # The quick replies response.

2115

"quickReplies": [ # Optional. The collection of quick replies.

2116

"A String",

2117

],

2118

"title": "A String", # Optional. The title of the collection of quick replies.

2119

},

2120

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2121

"title": "A String", # Required. Title of the card.

2122

"columnProperties": [ # Optional. Display properties for the columns in this table.

2123

{ # Column properties for TableCard.

2124

"header": "A String", # Required. Column heading.

2125

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2126

},

2127

],

2128

"subtitle": "A String", # Optional. Subtitle to the title.

2129

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2130

"imageUri": "A String", # Optional. The public URI to an image file.

2131

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2132

# e.g., screen readers.

2133

},

2134

"rows": [ # Optional. Rows in this table of data.

2135

{ # Row of TableCard.

2136

"cells": [ # Optional. List of cells that make up this row.

2137

{ # Cell of TableCardRow.

2138

"text": "A String", # Required. Text in this cell.

2139

},

2140

],

2141

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2142

},

2143

],

2144

"buttons": [ # Optional. List of buttons for the card.

2145

{ # The button object that appears at the bottom of a card.

2146

"title": "A String", # Required. The title of the button.

2147

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2148

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

},

"image": { # The image response message. # The image response.

2154

"imageUri": "A String", # Optional. The public URI to an image file.

2155

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2156

# e.g., screen readers.

2157

},

2158

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2159

"mediaObjects": [ # Required. List of media objects.

2160

{ # Response media object for media content card.

2161

"largeImage": { # The image response message. # Optional. Image to display above media content.

2162

"imageUri": "A String", # Optional. The public URI to an image file.

2163

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2164

# e.g., screen readers.

2165

},

2166

"contentUrl": "A String", # Required. Url where the media is stored.

2167

"icon": { # The image response message. # Optional. Icon to display above media content.

2168

"imageUri": "A String", # Optional. The public URI to an image file.

2169

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2170

# e.g., screen readers.

2171

},

2172

"name": "A String", # Required. Name of media card.

2173

"description": "A String", # Optional. Description of media card.

2174

},

2175

],

2176

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2177

},

2178

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

2179

"title": "A String", # Optional. The overall title of the list.

2180

"items": [ # Required. List items.

2181

{ # An item in the list.

2182

"image": { # The image response message. # Optional. The image to display.

2183

"imageUri": "A String", # Optional. The public URI to an image file.

2184

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2185

# e.g., screen readers.

2186

},

2187

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2188

# dialog.

2189

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

2194

# response is given.

2195

},

2196

"title": "A String", # Required. The title of the list item.

2197

"description": "A String", # Optional. The main text describing the item.

2198

},

2199

],

2200

"subtitle": "A String", # Optional. Subtitle of the list.

2201

},

2202

"payload": { # A custom platform-specific response.

2203

"a_key": "", # Properties of the object.

2204

},

2205

},

2206

],

Bu Sun Kim

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

[diff] [blame]

2207

"events": [ # Optional. The collection of event names that trigger the intent.

2208

# If the collection of input contexts is not empty, all of the contexts must

2209

# be present in the active user session for an event to trigger this intent.

2210

# Event names are limited to 150 characters.

2211

"A String",

2212

],

Bu Sun Kim

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

[diff] [blame]

2213

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

2214

# is matched. Context messages in this collection should not set the

2215

# parameters field. Setting the `lifespan_count` to 0 will reset the context

2216

# when the intent is matched.

2217

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

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

[diff] [blame^]

2218

{ # Dialogflow contexts are similar to natural language context. If a person says

2219

# to you "they are orange", you need context in order to understand what "they"

2220

# is referring to. Similarly, for Dialogflow to handle an end-user expression

2221

# like that, it needs to be provided with context in order to correctly match

2222

# an intent.

2223

#

2224

# Using contexts, you can control the flow of a conversation. You can configure

2225

# contexts for an intent by setting input and output contexts, which are

2226

# identified by string names. When an intent is matched, any configured output

2227

# contexts for that intent become active. While any contexts are active,

2228

# Dialogflow is more likely to match intents that are configured with input

2229

# contexts that correspond to the currently active contexts.

2230

#

2231

# For more information about context, see the

2232

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

Bu Sun Kim

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

[diff] [blame]

2233

"parameters": { # Optional. The collection of parameters associated with this context.

2234

#

2235

# Depending on your protocol or client library language, this is a

2236

# map, associative array, symbol table, dictionary, or JSON object

2237

# composed of a collection of (MapKey, MapValue) pairs:

2238

#

2239

# - MapKey type: string

2240

# - MapKey value: parameter name

2241

# - MapValue type:

2242

# - If parameter's entity type is a composite entity: map

2243

# - Else: string or number, depending on parameter value type

2244

# - MapValue value:

2245

# - If parameter's entity type is a composite entity:

2246

# map from composite entity property names to property values

2247

# - Else: parameter value

2248

"a_key": "", # Properties of the object.

2249

},

Bu Sun Kim

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

[diff] [blame^]

2250

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

2251

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

2252

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

2253

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

2254

#

2255

# The `Context ID` is always converted to lowercase, may only contain

2256

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2257

#

2258

# If `Environment ID` is not specified, we assume default 'draft'

2259

# environment. If `User ID` is not specified, we assume default '-' user.

2260

#

2261

# The following context names are reserved for internal use by Dialogflow.

2262

# You should not use these contexts or create contexts with these names:

2263

#

2264

# * `__system_counters__`

2265

# * `*_id_dialog_context`

2266

# * `*_dialog_params_size`

2267

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

2268

# context expires. The default is `0`. If set to `0`, the context expires

2269

# immediately. Contexts expire automatically after 20 minutes if there

2270

# are no matching queries.

Bu Sun Kim

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

[diff] [blame]

2271

},

2272

],

Bu Sun Kim

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

[diff] [blame]

2273

"action": "A String", # Optional. The name of the action associated with the intent.

2274

# Note: The action name must not contain whitespaces.

Bu Sun Kim

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

[diff] [blame^]

2275

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

2276

# priorities.

2277

#

2278

# - If the supplied value is unspecified or 0, the service

2279

# translates the value to 500,000, which corresponds to the

2280

# `Normal` priority in the console.

2281

# - If the supplied value is negative, the intent is ignored

2282

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

2283

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

2284

# followup intents. It identifies the correct followup intents chain for

2285

# this intent. We populate this field only in the output.

2286

#

2287

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

Bu Sun Kim

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

[diff] [blame^]

2288

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

2289

# a direct or indirect parent. We populate this field only in the output.

2290

{ # Represents a single followup intent in the chain.

2291

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2292

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

2293

"followupIntentName": "A String", # The unique identifier of the followup intent.

2294

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

2295

},

2296

],

Bu Sun Kim

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

[diff] [blame]

2297

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2298

# trained on.

2299

{ # Represents an example that the agent is trained on.

Bu Sun Kim

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

[diff] [blame]

2300

"name": "A String", # Output only. The unique identifier of this training phrase.

2301

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

2302

# the intent. Each time a developer adds an existing sample by editing an

2303

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

2304

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2305

# The parts are concatenated in order to form the training phrase.

2306

#

2307

# Note: The API does not automatically annotate training phrases like the

2308

# Dialogflow Console does.

2309

#

2310

# Note: Do not forget to include whitespace at part boundaries,

2311

# so the training phrase is well formatted when the parts are concatenated.

2312

#

2313

# If the training phrase does not need to be annotated with parameters,

2314

# you just need a single part with only the Part.text field set.

2315

#

2316

# If you want to annotate the training phrase, you must create multiple

2317

# parts, where the fields of each part are populated in one of two ways:

2318

#

2319

# - `Part.text` is set to a part of the phrase that has no parameters.

2320

# - `Part.text` is set to a part of the phrase that you want to annotate,

2321

# and the `entity_type`, `alias`, and `user_defined` fields are all

2322

# set.

2323

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

2324

"alias": "A String", # Optional. The parameter name for the value extracted from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2325

# annotated part of the example.

2326

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

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

[diff] [blame]

2327

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2328

# This field is set to true when the Dialogflow Console is used to

2329

# manually annotate the part. When creating an annotated part with the

2330

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

2331

"text": "A String", # Required. The text for this part.

2332

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2333

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2334

},

2335

],

Bu Sun Kim

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

[diff] [blame^]

2336

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2337

},

2338

],

Bu Sun Kim

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

[diff] [blame^]

2339

"inputContextNames": [ # Optional. The list of context names required for this intent to be

2340

# triggered.

2341

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2342

"A String",

2343

],

2344

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2345

# Note: If `ml_disabled` setting is set to true, then this intent is not

2346

# taken into account during inference in `ML ONLY` match mode. Also,

2347

# auto-markup in the UI is turned off.

Bu Sun Kim

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

[diff] [blame]

2348

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2349

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame^]

2350

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

2351

# chain of followup intents. You can set this field when creating an intent,

2352

# for example with CreateIntent or

2353

# BatchUpdateIntents, in order to make this

2354

# intent a followup intent.

2355

#

2356

# It identifies the parent followup intent.

2357

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

2358

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2359

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2360

"A String",

2361

],

Bu Sun Kim

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

[diff] [blame]

2362

"parameters": [ # Optional. The collection of parameters associated with the intent.

2363

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

2364

"value": "A String", # Optional. The definition of the parameter value. It can be:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2365

#

Bu Sun Kim

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

[diff] [blame]

2366

# - a constant string,

2367

# - a parameter value defined as `$parameter_name`,

2368

# - an original parameter value defined as `$parameter_name.original`,

2369

# - a parameter value from some context defined as

2370

# `#context_name.parameter_name`.

2371

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

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

[diff] [blame]

2372

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

2373

# whether the intent cannot be completed without collecting the parameter

2374

# value.

Bu Sun Kim

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

[diff] [blame^]

2375

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2376

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

2377

# describes values of the parameter. If the parameter is

2378

# required, this must be provided.

Bu Sun Kim

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

[diff] [blame]

2379

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

2380

# result.

2381

# Default values can be extracted from contexts by using the following

2382

# syntax: `#context_name.parameter_name`.

2383

"name": "A String", # The unique identifier of this parameter.

Bu Sun Kim

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

[diff] [blame^]

2384

"prompts": [ # Optional. The collection of prompts that the agent can present to the

2385

# user in order to collect a value for the parameter.

2386

"A String",

2387

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2388

},

2389

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

2394

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2395

<pre>Returns the list of all intents in the specified agent.

2396

2397

Args:

2398

parent: string, Required. The agent to list all intents from.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2399

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

Bu Sun Kim

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

[diff] [blame]

2400

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2401

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

2402

default 100 and at most 1000.

2403

intentView: string, Optional. The resource view to apply to the returned intent.

Bu Sun Kim

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

[diff] [blame]

2404

languageCode: string, Optional. The language used to access language-specific data.

2405

If not specified, the agent's default language is used.

2406

For more information, see

2407

[Multilingual intent and entity

2408

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2409

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2416

2417

{ # The response message for Intents.ListIntents.

Bu Sun Kim

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

[diff] [blame^]

2418

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

2419

# more results in the list.

Bu Sun Kim

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

[diff] [blame]

2420

"intents": [ # The list of agent intents. There will be a maximum number of items

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2421

# returned based on the page_size field in the request.

Bu Sun Kim

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

[diff] [blame^]

2422

{ # An intent categorizes an end-user's intention for one conversation turn. For

2423

# each agent, you define many intents, where your combined intents can handle a

2424

# complete conversation. When an end-user writes or says something, referred to

2425

# as an end-user expression or end-user input, Dialogflow matches the end-user

2426

# input to the best intent in your agent. Matching an intent is also known as

2427

# intent classification.

2428

#

2429

# For more information, see the [intent

2430

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

2431

"name": "A String", # Optional. The unique identifier of this intent.

2432

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2433

# methods.

2434

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

2435

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

2436

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2437

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

2438

"messages": [ # Optional. The collection of rich messages corresponding to the

2439

# `Response` field in the Dialogflow console.

2440

{ # A rich response message.

2441

# Corresponds to the intent `Response` field in the Dialogflow console.

2442

# For more information, see

2443

# [Rich response

2444

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

2445

"card": { # The card response message. # The card response.

2446

"title": "A String", # Optional. The title of the card.

2447

"subtitle": "A String", # Optional. The subtitle of the card.

2448

"buttons": [ # Optional. The collection of card buttons.

2449

{ # Contains information about a button.

2450

"text": "A String", # Optional. The text to show on the button.

2451

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2456

},

2457

"text": { # The text response message. # The text response.

2458

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

2463

"items": [ # Required. Carousel items.

2464

{ # An item in the carousel.

2465

"description": "A String", # Optional. The body text of the card.

2466

"title": "A String", # Required. Title of the carousel item.

2467

"image": { # The image response message. # Optional. The image to display.

2468

"imageUri": "A String", # Optional. The public URI to an image file.

2469

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2470

# e.g., screen readers.

2471

},

2472

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2473

# dialog.

2474

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

2485

# This message in `QueryResult.fulfillment_messages` and

2486

# `WebhookResponse.fulfillment_messages` should contain only one

2487

# `SimpleResponse`.

2488

"simpleResponses": [ # Required. The list of simple responses.

2489

{ # The simple response message containing speech or text.

2490

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2491

# speech output. Mutually exclusive with ssml.

2492

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2493

# response to the user in the SSML format. Mutually exclusive with

2494

# text_to_speech.

2495

"displayText": "A String", # Optional. The text to display.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2500

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2501

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2502

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2503

# items, maximum of ten.

2504

{ # Browsing carousel tile

2505

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2506

# Card. Maximum of one line of text.

2507

"image": { # The image response message. # Optional. Hero image for the carousel item.

2508

"imageUri": "A String", # Optional. The public URI to an image file.

2509

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2510

# e.g., screen readers.

2511

},

2512

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2513

# text.

2514

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2515

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2516

"url": "A String", # Required. URL

2517

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2518

# the URL. Defaults to opening via web browser.

},

},

],

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2523

# items.

2524

},

2525

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

2526

# or website associated with this agent.

2527

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2528

# suggestion chip.

2529

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2530

},

2531

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

2532

"buttons": [ # Optional. The collection of card buttons.

2533

{ # The button object that appears at the bottom of a card.

2534

"title": "A String", # Required. The title of the button.

2535

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2536

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

2541

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2542

"title": "A String", # Optional. The title of the card.

2543

"image": { # The image response message. # Optional. The image for the card.

2544

"imageUri": "A String", # Optional. The public URI to an image file.

2545

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2546

# e.g., screen readers.

2547

},

2548

},

2549

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

2550

"suggestions": [ # Required. The list of suggested replies.

2551

{ # The suggestion chip message that the user can tap to quickly post a reply

2552

# to the conversation.

2553

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"quickReplies": { # The quick replies response message. # The quick replies response.

2558

"quickReplies": [ # Optional. The collection of quick replies.

2559

"A String",

2560

],

2561

"title": "A String", # Optional. The title of the collection of quick replies.

2562

},

2563

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2564

"title": "A String", # Required. Title of the card.

2565

"columnProperties": [ # Optional. Display properties for the columns in this table.

2566

{ # Column properties for TableCard.

2567

"header": "A String", # Required. Column heading.

2568

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2569

},

2570

],

2571

"subtitle": "A String", # Optional. Subtitle to the title.

2572

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2573

"imageUri": "A String", # Optional. The public URI to an image file.

2574

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2575

# e.g., screen readers.

2576

},

2577

"rows": [ # Optional. Rows in this table of data.

2578

{ # Row of TableCard.

2579

"cells": [ # Optional. List of cells that make up this row.

2580

{ # Cell of TableCardRow.

2581

"text": "A String", # Required. Text in this cell.

2582

},

2583

],

2584

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2585

},

2586

],

2587

"buttons": [ # Optional. List of buttons for the card.

2588

{ # The button object that appears at the bottom of a card.

2589

"title": "A String", # Required. The title of the button.

2590

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2591

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

},

"image": { # The image response message. # The image response.

2597

"imageUri": "A String", # Optional. The public URI to an image file.

2598

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2599

# e.g., screen readers.

2600

},

2601

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2602

"mediaObjects": [ # Required. List of media objects.

2603

{ # Response media object for media content card.

2604

"largeImage": { # The image response message. # Optional. Image to display above media content.

2605

"imageUri": "A String", # Optional. The public URI to an image file.

2606

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2607

# e.g., screen readers.

2608

},

2609

"contentUrl": "A String", # Required. Url where the media is stored.

2610

"icon": { # The image response message. # Optional. Icon to display above media content.

2611

"imageUri": "A String", # Optional. The public URI to an image file.

2612

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2613

# e.g., screen readers.

2614

},

2615

"name": "A String", # Required. Name of media card.

2616

"description": "A String", # Optional. Description of media card.

2617

},

2618

],

2619

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2620

},

2621

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

2622

"title": "A String", # Optional. The overall title of the list.

2623

"items": [ # Required. List items.

2624

{ # An item in the list.

2625

"image": { # The image response message. # Optional. The image to display.

2626

"imageUri": "A String", # Optional. The public URI to an image file.

2627

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2628

# e.g., screen readers.

2629

},

2630

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2631

# dialog.

2632

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

2637

# response is given.

2638

},

2639

"title": "A String", # Required. The title of the list item.

2640

"description": "A String", # Optional. The main text describing the item.

2641

},

2642

],

2643

"subtitle": "A String", # Optional. Subtitle of the list.

2644

},

2645

"payload": { # A custom platform-specific response.

2646

"a_key": "", # Properties of the object.

2647

},

2648

},

2649

],

Bu Sun Kim

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

[diff] [blame]

2650

"events": [ # Optional. The collection of event names that trigger the intent.

2651

# If the collection of input contexts is not empty, all of the contexts must

2652

# be present in the active user session for an event to trigger this intent.

2653

# Event names are limited to 150 characters.

2654

"A String",

2655

],

Bu Sun Kim

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

[diff] [blame]

2656

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

2657

# is matched. Context messages in this collection should not set the

2658

# parameters field. Setting the `lifespan_count` to 0 will reset the context

2659

# when the intent is matched.

2660

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

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

[diff] [blame^]

2661

{ # Dialogflow contexts are similar to natural language context. If a person says

2662

# to you "they are orange", you need context in order to understand what "they"

2663

# is referring to. Similarly, for Dialogflow to handle an end-user expression

2664

# like that, it needs to be provided with context in order to correctly match

2665

# an intent.

2666

#

2667

# Using contexts, you can control the flow of a conversation. You can configure

2668

# contexts for an intent by setting input and output contexts, which are

2669

# identified by string names. When an intent is matched, any configured output

2670

# contexts for that intent become active. While any contexts are active,

2671

# Dialogflow is more likely to match intents that are configured with input

2672

# contexts that correspond to the currently active contexts.

2673

#

2674

# For more information about context, see the

2675

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

Bu Sun Kim

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

[diff] [blame]

2676

"parameters": { # Optional. The collection of parameters associated with this context.

2677

#

2678

# Depending on your protocol or client library language, this is a

2679

# map, associative array, symbol table, dictionary, or JSON object

2680

# composed of a collection of (MapKey, MapValue) pairs:

2681

#

2682

# - MapKey type: string

2683

# - MapKey value: parameter name

2684

# - MapValue type:

2685

# - If parameter's entity type is a composite entity: map

2686

# - Else: string or number, depending on parameter value type

2687

# - MapValue value:

2688

# - If parameter's entity type is a composite entity:

2689

# map from composite entity property names to property values

2690

# - Else: parameter value

2691

"a_key": "", # Properties of the object.

2692

},

Bu Sun Kim

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

[diff] [blame^]

2693

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

2694

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

2695

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

2696

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

2697

#

2698

# The `Context ID` is always converted to lowercase, may only contain

2699

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2700

#

2701

# If `Environment ID` is not specified, we assume default 'draft'

2702

# environment. If `User ID` is not specified, we assume default '-' user.

2703

#

2704

# The following context names are reserved for internal use by Dialogflow.

2705

# You should not use these contexts or create contexts with these names:

2706

#

2707

# * `__system_counters__`

2708

# * `*_id_dialog_context`

2709

# * `*_dialog_params_size`

2710

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

2711

# context expires. The default is `0`. If set to `0`, the context expires

2712

# immediately. Contexts expire automatically after 20 minutes if there

2713

# are no matching queries.

Bu Sun Kim

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

[diff] [blame]

2714

},

2715

],

Bu Sun Kim

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

[diff] [blame]

2716

"action": "A String", # Optional. The name of the action associated with the intent.

2717

# Note: The action name must not contain whitespaces.

Bu Sun Kim

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

[diff] [blame^]

2718

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

2719

# priorities.

2720

#

2721

# - If the supplied value is unspecified or 0, the service

2722

# translates the value to 500,000, which corresponds to the

2723

# `Normal` priority in the console.

2724

# - If the supplied value is negative, the intent is ignored

2725

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

2726

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

2727

# followup intents. It identifies the correct followup intents chain for

2728

# this intent. We populate this field only in the output.

2729

#

2730

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

Bu Sun Kim

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

[diff] [blame^]

2731

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

2732

# a direct or indirect parent. We populate this field only in the output.

2733

{ # Represents a single followup intent in the chain.

2734

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2735

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

2736

"followupIntentName": "A String", # The unique identifier of the followup intent.

2737

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

2738

},

2739

],

Bu Sun Kim

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

[diff] [blame]

2740

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2741

# trained on.

2742

{ # Represents an example that the agent is trained on.

Bu Sun Kim

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

[diff] [blame]

2743

"name": "A String", # Output only. The unique identifier of this training phrase.

2744

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

2745

# the intent. Each time a developer adds an existing sample by editing an

2746

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

2747

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2748

# The parts are concatenated in order to form the training phrase.

2749

#

2750

# Note: The API does not automatically annotate training phrases like the

2751

# Dialogflow Console does.

2752

#

2753

# Note: Do not forget to include whitespace at part boundaries,

2754

# so the training phrase is well formatted when the parts are concatenated.

2755

#

2756

# If the training phrase does not need to be annotated with parameters,

2757

# you just need a single part with only the Part.text field set.

2758

#

2759

# If you want to annotate the training phrase, you must create multiple

2760

# parts, where the fields of each part are populated in one of two ways:

2761

#

2762

# - `Part.text` is set to a part of the phrase that has no parameters.

2763

# - `Part.text` is set to a part of the phrase that you want to annotate,

2764

# and the `entity_type`, `alias`, and `user_defined` fields are all

2765

# set.

2766

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

2767

"alias": "A String", # Optional. The parameter name for the value extracted from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2768

# annotated part of the example.

2769

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

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

[diff] [blame]

2770

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2771

# This field is set to true when the Dialogflow Console is used to

2772

# manually annotate the part. When creating an annotated part with the

2773

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

2774

"text": "A String", # Required. The text for this part.

2775

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2776

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2777

},

2778

],

Bu Sun Kim

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

[diff] [blame^]

2779

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2780

},

2781

],

Bu Sun Kim

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

[diff] [blame^]

2782

"inputContextNames": [ # Optional. The list of context names required for this intent to be

2783

# triggered.

2784

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2785

"A String",

2786

],

2787

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2788

# Note: If `ml_disabled` setting is set to true, then this intent is not

2789

# taken into account during inference in `ML ONLY` match mode. Also,

2790

# auto-markup in the UI is turned off.

Bu Sun Kim

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

[diff] [blame]

2791

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2792

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame^]

2793

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

2794

# chain of followup intents. You can set this field when creating an intent,

2795

# for example with CreateIntent or

2796

# BatchUpdateIntents, in order to make this

2797

# intent a followup intent.

2798

#

2799

# It identifies the parent followup intent.

2800

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

2801

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2802

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2803

"A String",

2804

],

Bu Sun Kim

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

[diff] [blame]

2805

"parameters": [ # Optional. The collection of parameters associated with the intent.

2806

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

2807

"value": "A String", # Optional. The definition of the parameter value. It can be:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2808

#

Bu Sun Kim

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

[diff] [blame]

2809

# - a constant string,

2810

# - a parameter value defined as `$parameter_name`,

2811

# - an original parameter value defined as `$parameter_name.original`,

2812

# - a parameter value from some context defined as

2813

# `#context_name.parameter_name`.

2814

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

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

[diff] [blame]

2815

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

2816

# whether the intent cannot be completed without collecting the parameter

2817

# value.

Bu Sun Kim

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

[diff] [blame^]

2818

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2819

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

2820

# describes values of the parameter. If the parameter is

2821

# required, this must be provided.

Bu Sun Kim

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

[diff] [blame]

2822

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

2823

# result.

2824

# Default values can be extracted from contexts by using the following

2825

# syntax: `#context_name.parameter_name`.

2826

"name": "A String", # The unique identifier of this parameter.

Bu Sun Kim

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

[diff] [blame^]

2827

"prompts": [ # Optional. The collection of prompts that the agent can present to the

2828

# user in order to collect a value for the parameter.

2829

"A String",

2830

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2831

},

2832

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

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

2840

<pre>Retrieves the next page of results.

2841

2842

Args:

2843

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

2844

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

2845

2846

Returns:

Bu Sun Kim

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

[diff] [blame]

2847

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2848

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]

2853

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2854

<pre>Updates the specified intent.

2855

2856

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2857

name: string, Optional. The unique identifier of this intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2858

Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2859

methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2860

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

2861

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2862

The object takes the form of:

2863

Bu Sun Kim

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

[diff] [blame^]

2864

{ # An intent categorizes an end-user's intention for one conversation turn. For

2865

# each agent, you define many intents, where your combined intents can handle a

2866

# complete conversation. When an end-user writes or says something, referred to

2867

# as an end-user expression or end-user input, Dialogflow matches the end-user

2868

# input to the best intent in your agent. Matching an intent is also known as

2869

# intent classification.

2870

#

2871

# For more information, see the [intent

2872

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

2873

"name": "A String", # Optional. The unique identifier of this intent.

2874

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2875

# methods.

2876

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

2877

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

2878

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2879

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

2880

"messages": [ # Optional. The collection of rich messages corresponding to the

2881

# `Response` field in the Dialogflow console.

2882

{ # A rich response message.

2883

# Corresponds to the intent `Response` field in the Dialogflow console.

2884

# For more information, see

2885

# [Rich response

2886

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

2887

"card": { # The card response message. # The card response.

2888

"title": "A String", # Optional. The title of the card.

2889

"subtitle": "A String", # Optional. The subtitle of the card.

2890

"buttons": [ # Optional. The collection of card buttons.

2891

{ # Contains information about a button.

2892

"text": "A String", # Optional. The text to show on the button.

2893

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2898

},

2899

"text": { # The text response message. # The text response.

2900

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

2905

"items": [ # Required. Carousel items.

2906

{ # An item in the carousel.

2907

"description": "A String", # Optional. The body text of the card.

2908

"title": "A String", # Required. Title of the carousel item.

2909

"image": { # The image response message. # Optional. The image to display.

2910

"imageUri": "A String", # Optional. The public URI to an image file.

2911

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2912

# e.g., screen readers.

2913

},

2914

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2915

# dialog.

2916

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

2927

# This message in `QueryResult.fulfillment_messages` and

2928

# `WebhookResponse.fulfillment_messages` should contain only one

2929

# `SimpleResponse`.

2930

"simpleResponses": [ # Required. The list of simple responses.

2931

{ # The simple response message containing speech or text.

2932

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2933

# speech output. Mutually exclusive with ssml.

2934

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2935

# response to the user in the SSML format. Mutually exclusive with

2936

# text_to_speech.

2937

"displayText": "A String", # Optional. The text to display.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2942

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2943

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2944

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2945

# items, maximum of ten.

2946

{ # Browsing carousel tile

2947

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2948

# Card. Maximum of one line of text.

2949

"image": { # The image response message. # Optional. Hero image for the carousel item.

2950

"imageUri": "A String", # Optional. The public URI to an image file.

2951

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2952

# e.g., screen readers.

2953

},

2954

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2955

# text.

2956

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2957

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2958

"url": "A String", # Required. URL

2959

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2960

# the URL. Defaults to opening via web browser.

},

},

],

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2965

# items.

2966

},

2967

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

2968

# or website associated with this agent.

2969

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2970

# suggestion chip.

2971

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2972

},

2973

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

2974

"buttons": [ # Optional. The collection of card buttons.

2975

{ # The button object that appears at the bottom of a card.

2976

"title": "A String", # Required. The title of the button.

2977

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2978

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

2983

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2984

"title": "A String", # Optional. The title of the card.

2985

"image": { # The image response message. # Optional. The image for the card.

2986

"imageUri": "A String", # Optional. The public URI to an image file.

2987

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2988

# e.g., screen readers.

2989

},

2990

},

2991

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

2992

"suggestions": [ # Required. The list of suggested replies.

2993

{ # The suggestion chip message that the user can tap to quickly post a reply

2994

# to the conversation.

2995

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"quickReplies": { # The quick replies response message. # The quick replies response.

3000

"quickReplies": [ # Optional. The collection of quick replies.

3001

"A String",

3002

],

3003

"title": "A String", # Optional. The title of the collection of quick replies.

3004

},

3005

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

3006

"title": "A String", # Required. Title of the card.

3007

"columnProperties": [ # Optional. Display properties for the columns in this table.

3008

{ # Column properties for TableCard.

3009

"header": "A String", # Required. Column heading.

3010

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

3011

},

3012

],

3013

"subtitle": "A String", # Optional. Subtitle to the title.

3014

"image": { # The image response message. # Optional. Image which should be displayed on the card.

3015

"imageUri": "A String", # Optional. The public URI to an image file.

3016

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3017

# e.g., screen readers.

3018

},

3019

"rows": [ # Optional. Rows in this table of data.

3020

{ # Row of TableCard.

3021

"cells": [ # Optional. List of cells that make up this row.

3022

{ # Cell of TableCardRow.

3023

"text": "A String", # Required. Text in this cell.

3024

},

3025

],

3026

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

3027

},

3028

],

3029

"buttons": [ # Optional. List of buttons for the card.

3030

{ # The button object that appears at the bottom of a card.

3031

"title": "A String", # Required. The title of the button.

3032

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3033

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

},

"image": { # The image response message. # The image response.

3039

"imageUri": "A String", # Optional. The public URI to an image file.

3040

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3041

# e.g., screen readers.

3042

},

3043

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

3044

"mediaObjects": [ # Required. List of media objects.

3045

{ # Response media object for media content card.

3046

"largeImage": { # The image response message. # Optional. Image to display above media content.

3047

"imageUri": "A String", # Optional. The public URI to an image file.

3048

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3049

# e.g., screen readers.

3050

},

3051

"contentUrl": "A String", # Required. Url where the media is stored.

3052

"icon": { # The image response message. # Optional. Icon to display above media content.

3053

"imageUri": "A String", # Optional. The public URI to an image file.

3054

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3055

# e.g., screen readers.

3056

},

3057

"name": "A String", # Required. Name of media card.

3058

"description": "A String", # Optional. Description of media card.

3059

},

3060

],

3061

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

3062

},

3063

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

3064

"title": "A String", # Optional. The overall title of the list.

3065

"items": [ # Required. List items.

3066

{ # An item in the list.

3067

"image": { # The image response message. # Optional. The image to display.

3068

"imageUri": "A String", # Optional. The public URI to an image file.

3069

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3070

# e.g., screen readers.

3071

},

3072

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3073

# dialog.

3074

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

3079

# response is given.

3080

},

3081

"title": "A String", # Required. The title of the list item.

3082

"description": "A String", # Optional. The main text describing the item.

3083

},

3084

],

3085

"subtitle": "A String", # Optional. Subtitle of the list.

3086

},

3087

"payload": { # A custom platform-specific response.

3088

"a_key": "", # Properties of the object.

3089

},

3090

},

3091

],

Bu Sun Kim

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

[diff] [blame]

3092

"events": [ # Optional. The collection of event names that trigger the intent.

3093

# If the collection of input contexts is not empty, all of the contexts must

3094

# be present in the active user session for an event to trigger this intent.

3095

# Event names are limited to 150 characters.

3096

"A String",

3097

],

Bu Sun Kim

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

[diff] [blame]

3098

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3099

# is matched. Context messages in this collection should not set the

3100

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3101

# when the intent is matched.

3102

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

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

[diff] [blame^]

3103

{ # Dialogflow contexts are similar to natural language context. If a person says

3104

# to you "they are orange", you need context in order to understand what "they"

3105

# is referring to. Similarly, for Dialogflow to handle an end-user expression

3106

# like that, it needs to be provided with context in order to correctly match

3107

# an intent.

3108

#

3109

# Using contexts, you can control the flow of a conversation. You can configure

3110

# contexts for an intent by setting input and output contexts, which are

3111

# identified by string names. When an intent is matched, any configured output

3112

# contexts for that intent become active. While any contexts are active,

3113

# Dialogflow is more likely to match intents that are configured with input

3114

# contexts that correspond to the currently active contexts.

3115

#

3116

# For more information about context, see the

3117

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

Bu Sun Kim

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

[diff] [blame]

3118

"parameters": { # Optional. The collection of parameters associated with this context.

3119

#

3120

# Depending on your protocol or client library language, this is a

3121

# map, associative array, symbol table, dictionary, or JSON object

3122

# composed of a collection of (MapKey, MapValue) pairs:

3123

#

3124

# - MapKey type: string

3125

# - MapKey value: parameter name

3126

# - MapValue type:

3127

# - If parameter's entity type is a composite entity: map

3128

# - Else: string or number, depending on parameter value type

3129

# - MapValue value:

3130

# - If parameter's entity type is a composite entity:

3131

# map from composite entity property names to property values

3132

# - Else: parameter value

3133

"a_key": "", # Properties of the object.

3134

},

Bu Sun Kim

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

[diff] [blame^]

3135

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

3136

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3137

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3138

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3139

#

3140

# The `Context ID` is always converted to lowercase, may only contain

3141

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3142

#

3143

# If `Environment ID` is not specified, we assume default 'draft'

3144

# environment. If `User ID` is not specified, we assume default '-' user.

3145

#

3146

# The following context names are reserved for internal use by Dialogflow.

3147

# You should not use these contexts or create contexts with these names:

3148

#

3149

# * `__system_counters__`

3150

# * `*_id_dialog_context`

3151

# * `*_dialog_params_size`

3152

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3153

# context expires. The default is `0`. If set to `0`, the context expires

3154

# immediately. Contexts expire automatically after 20 minutes if there

3155

# are no matching queries.

Bu Sun Kim

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

[diff] [blame]

3156

},

3157

],

Bu Sun Kim

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

[diff] [blame]

3158

"action": "A String", # Optional. The name of the action associated with the intent.

3159

# Note: The action name must not contain whitespaces.

Bu Sun Kim

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

[diff] [blame^]

3160

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

3161

# priorities.

3162

#

3163

# - If the supplied value is unspecified or 0, the service

3164

# translates the value to 500,000, which corresponds to the

3165

# `Normal` priority in the console.

3166

# - If the supplied value is negative, the intent is ignored

3167

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

3168

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

3169

# followup intents. It identifies the correct followup intents chain for

3170

# this intent. We populate this field only in the output.

3171

#

3172

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

Bu Sun Kim

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

[diff] [blame^]

3173

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

3174

# a direct or indirect parent. We populate this field only in the output.

3175

{ # Represents a single followup intent in the chain.

3176

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

3177

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

3178

"followupIntentName": "A String", # The unique identifier of the followup intent.

3179

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

3180

},

3181

],

Bu Sun Kim

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

[diff] [blame]

3182

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3183

# trained on.

3184

{ # Represents an example that the agent is trained on.

Bu Sun Kim

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

[diff] [blame]

3185

"name": "A String", # Output only. The unique identifier of this training phrase.

3186

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

3187

# the intent. Each time a developer adds an existing sample by editing an

3188

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

3189

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3190

# The parts are concatenated in order to form the training phrase.

3191

#

3192

# Note: The API does not automatically annotate training phrases like the

3193

# Dialogflow Console does.

3194

#

3195

# Note: Do not forget to include whitespace at part boundaries,

3196

# so the training phrase is well formatted when the parts are concatenated.

3197

#

3198

# If the training phrase does not need to be annotated with parameters,

3199

# you just need a single part with only the Part.text field set.

3200

#

3201

# If you want to annotate the training phrase, you must create multiple

3202

# parts, where the fields of each part are populated in one of two ways:

3203

#

3204

# - `Part.text` is set to a part of the phrase that has no parameters.

3205

# - `Part.text` is set to a part of the phrase that you want to annotate,

3206

# and the `entity_type`, `alias`, and `user_defined` fields are all

3207

# set.

3208

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

3209

"alias": "A String", # Optional. The parameter name for the value extracted from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3210

# annotated part of the example.

3211

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

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

[diff] [blame]

3212

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3213

# This field is set to true when the Dialogflow Console is used to

3214

# manually annotate the part. When creating an annotated part with the

3215

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

3216

"text": "A String", # Required. The text for this part.

3217

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3218

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3219

},

3220

],

Bu Sun Kim

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

[diff] [blame^]

3221

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3222

},

3223

],

Bu Sun Kim

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

[diff] [blame^]

3224

"inputContextNames": [ # Optional. The list of context names required for this intent to be

3225

# triggered.

3226

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3227

"A String",

3228

],

3229

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

3230

# Note: If `ml_disabled` setting is set to true, then this intent is not

3231

# taken into account during inference in `ML ONLY` match mode. Also,

3232

# auto-markup in the UI is turned off.

Bu Sun Kim

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

[diff] [blame]

3233

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3234

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame^]

3235

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

3236

# chain of followup intents. You can set this field when creating an intent,

3237

# for example with CreateIntent or

3238

# BatchUpdateIntents, in order to make this

3239

# intent a followup intent.

3240

#

3241

# It identifies the parent followup intent.

3242

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

3243

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3244

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3245

"A String",

3246

],

Bu Sun Kim

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

[diff] [blame]

3247

"parameters": [ # Optional. The collection of parameters associated with the intent.

3248

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

3249

"value": "A String", # Optional. The definition of the parameter value. It can be:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3250

#

Bu Sun Kim

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

[diff] [blame]

3251

# - a constant string,

3252

# - a parameter value defined as `$parameter_name`,

3253

# - an original parameter value defined as `$parameter_name.original`,

3254

# - a parameter value from some context defined as

3255

# `#context_name.parameter_name`.

3256

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

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

[diff] [blame]

3257

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3258

# whether the intent cannot be completed without collecting the parameter

3259

# value.

Bu Sun Kim

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

[diff] [blame^]

3260

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

3261

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3262

# describes values of the parameter. If the parameter is

3263

# required, this must be provided.

Bu Sun Kim

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

[diff] [blame]

3264

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3265

# result.

3266

# Default values can be extracted from contexts by using the following

3267

# syntax: `#context_name.parameter_name`.

3268

"name": "A String", # The unique identifier of this parameter.

Bu Sun Kim

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

[diff] [blame^]

3269

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3270

# user in order to collect a value for the parameter.

3271

"A String",

3272

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3273

},

3274

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3275

}

3276

Bu Sun Kim

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

[diff] [blame]

3277

intentView: string, Optional. The resource view to apply to the returned intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3278

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

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

[diff] [blame]

3279

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3280

For more information, see

3281

[Multilingual intent and entity

3282

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3283

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

3284

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3291

Bu Sun Kim

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

[diff] [blame^]

3292

{ # An intent categorizes an end-user's intention for one conversation turn. For

3293

# each agent, you define many intents, where your combined intents can handle a

3294

# complete conversation. When an end-user writes or says something, referred to

3295

# as an end-user expression or end-user input, Dialogflow matches the end-user

3296

# input to the best intent in your agent. Matching an intent is also known as

3297

# intent classification.

3298

#

3299

# For more information, see the [intent

3300

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

3301

"name": "A String", # Optional. The unique identifier of this intent.

3302

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

3303

# methods.

3304

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

3305

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

3306

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

3307

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

3308

"messages": [ # Optional. The collection of rich messages corresponding to the

3309

# `Response` field in the Dialogflow console.

3310

{ # A rich response message.

3311

# Corresponds to the intent `Response` field in the Dialogflow console.

3312

# For more information, see

3313

# [Rich response

3314

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

3315

"card": { # The card response message. # The card response.

3316

"title": "A String", # Optional. The title of the card.

3317

"subtitle": "A String", # Optional. The subtitle of the card.

3318

"buttons": [ # Optional. The collection of card buttons.

3319

{ # Contains information about a button.

3320

"text": "A String", # Optional. The text to show on the button.

3321

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

3326

},

3327

"text": { # The text response message. # The text response.

3328

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

3333

"items": [ # Required. Carousel items.

3334

{ # An item in the carousel.

3335

"description": "A String", # Optional. The body text of the card.

3336

"title": "A String", # Required. Title of the carousel item.

3337

"image": { # The image response message. # Optional. The image to display.

3338

"imageUri": "A String", # Optional. The public URI to an image file.

3339

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3340

# e.g., screen readers.

3341

},

3342

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

3343

# dialog.

3344

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

3355

# This message in `QueryResult.fulfillment_messages` and

3356

# `WebhookResponse.fulfillment_messages` should contain only one

3357

# `SimpleResponse`.

3358

"simpleResponses": [ # Required. The list of simple responses.

3359

{ # The simple response message containing speech or text.

3360

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

3361

# speech output. Mutually exclusive with ssml.

3362

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

3363

# response to the user in the SSML format. Mutually exclusive with

3364

# text_to_speech.

3365

"displayText": "A String", # Optional. The text to display.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

3370

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

3371

# https://developers.google.com/actions/assistant/responses#browsing_carousel

3372

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

3373

# items, maximum of ten.

3374

{ # Browsing carousel tile

3375

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

3376

# Card. Maximum of one line of text.

3377

"image": { # The image response message. # Optional. Hero image for the carousel item.

3378

"imageUri": "A String", # Optional. The public URI to an image file.

3379

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3380

# e.g., screen readers.

3381

},

3382

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

3383

# text.

3384

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

3385

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

3386

"url": "A String", # Required. URL

3387

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

3388

# the URL. Defaults to opening via web browser.

},

},

],

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

3393

# items.

3394

},

3395

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

3396

# or website associated with this agent.

3397

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

3398

# suggestion chip.

3399

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

3400

},

3401

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

3402

"buttons": [ # Optional. The collection of card buttons.

3403

{ # The button object that appears at the bottom of a card.

3404

"title": "A String", # Required. The title of the button.

3405

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3406

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

3411

"formattedText": "A String", # Required, unless image is present. The body text of the card.

3412

"title": "A String", # Optional. The title of the card.

3413

"image": { # The image response message. # Optional. The image for the card.

3414

"imageUri": "A String", # Optional. The public URI to an image file.

3415

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3416

# e.g., screen readers.

3417

},

3418

},

3419

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

3420

"suggestions": [ # Required. The list of suggested replies.

3421

{ # The suggestion chip message that the user can tap to quickly post a reply

3422

# to the conversation.

3423

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"quickReplies": { # The quick replies response message. # The quick replies response.

3428

"quickReplies": [ # Optional. The collection of quick replies.

3429

"A String",

3430

],

3431

"title": "A String", # Optional. The title of the collection of quick replies.

3432

},

3433

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

3434

"title": "A String", # Required. Title of the card.

3435

"columnProperties": [ # Optional. Display properties for the columns in this table.

3436

{ # Column properties for TableCard.

3437

"header": "A String", # Required. Column heading.

3438

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

3439

},

3440

],

3441

"subtitle": "A String", # Optional. Subtitle to the title.

3442

"image": { # The image response message. # Optional. Image which should be displayed on the card.

3443

"imageUri": "A String", # Optional. The public URI to an image file.

3444

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3445

# e.g., screen readers.

3446

},

3447

"rows": [ # Optional. Rows in this table of data.

3448

{ # Row of TableCard.

3449

"cells": [ # Optional. List of cells that make up this row.

3450

{ # Cell of TableCardRow.

3451

"text": "A String", # Required. Text in this cell.

3452

},

3453

],

3454

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

3455

},

3456

],

3457

"buttons": [ # Optional. List of buttons for the card.

3458

{ # The button object that appears at the bottom of a card.

3459

"title": "A String", # Required. The title of the button.

3460

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3461

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

},

},

],

},

"image": { # The image response message. # The image response.

3467

"imageUri": "A String", # Optional. The public URI to an image file.

3468

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3469

# e.g., screen readers.

3470

},

3471

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

3472

"mediaObjects": [ # Required. List of media objects.

3473

{ # Response media object for media content card.

3474

"largeImage": { # The image response message. # Optional. Image to display above media content.

3475

"imageUri": "A String", # Optional. The public URI to an image file.

3476

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3477

# e.g., screen readers.

3478

},

3479

"contentUrl": "A String", # Required. Url where the media is stored.

3480

"icon": { # The image response message. # Optional. Icon to display above media content.

3481

"imageUri": "A String", # Optional. The public URI to an image file.

3482

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3483

# e.g., screen readers.

3484

},

3485

"name": "A String", # Required. Name of media card.

3486

"description": "A String", # Optional. Description of media card.

3487

},

3488

],

3489

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

3490

},

3491

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

3492

"title": "A String", # Optional. The overall title of the list.

3493

"items": [ # Required. List items.

3494

{ # An item in the list.

3495

"image": { # The image response message. # Optional. The image to display.

3496

"imageUri": "A String", # Optional. The public URI to an image file.

3497

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3498

# e.g., screen readers.

3499

},

3500

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3501

# dialog.

3502

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

3507

# response is given.

3508

},

3509

"title": "A String", # Required. The title of the list item.

3510

"description": "A String", # Optional. The main text describing the item.

3511

},

3512

],

3513

"subtitle": "A String", # Optional. Subtitle of the list.

3514

},

3515

"payload": { # A custom platform-specific response.

3516

"a_key": "", # Properties of the object.

3517

},

3518

},

3519

],

Bu Sun Kim

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

[diff] [blame]

3520

"events": [ # Optional. The collection of event names that trigger the intent.

3521

# If the collection of input contexts is not empty, all of the contexts must

3522

# be present in the active user session for an event to trigger this intent.

3523

# Event names are limited to 150 characters.

3524

"A String",

3525

],

Bu Sun Kim

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

[diff] [blame]

3526

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3527

# is matched. Context messages in this collection should not set the

3528

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3529

# when the intent is matched.

3530

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

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

[diff] [blame^]

3531

{ # Dialogflow contexts are similar to natural language context. If a person says

3532

# to you "they are orange", you need context in order to understand what "they"

3533

# is referring to. Similarly, for Dialogflow to handle an end-user expression

3534

# like that, it needs to be provided with context in order to correctly match

3535

# an intent.

3536

#

3537

# Using contexts, you can control the flow of a conversation. You can configure

3538

# contexts for an intent by setting input and output contexts, which are

3539

# identified by string names. When an intent is matched, any configured output

3540

# contexts for that intent become active. While any contexts are active,

3541

# Dialogflow is more likely to match intents that are configured with input

3542

# contexts that correspond to the currently active contexts.

3543

#

3544

# For more information about context, see the

3545

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

Bu Sun Kim

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

[diff] [blame]

3546

"parameters": { # Optional. The collection of parameters associated with this context.

3547

#

3548

# Depending on your protocol or client library language, this is a

3549

# map, associative array, symbol table, dictionary, or JSON object

3550

# composed of a collection of (MapKey, MapValue) pairs:

3551

#

3552

# - MapKey type: string

3553

# - MapKey value: parameter name

3554

# - MapValue type:

3555

# - If parameter's entity type is a composite entity: map

3556

# - Else: string or number, depending on parameter value type

3557

# - MapValue value:

3558

# - If parameter's entity type is a composite entity:

3559

# map from composite entity property names to property values

3560

# - Else: parameter value

3561

"a_key": "", # Properties of the object.

3562

},

Bu Sun Kim

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

[diff] [blame^]

3563

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

3564

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3565

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3566

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3567

#

3568

# The `Context ID` is always converted to lowercase, may only contain

3569

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3570

#

3571

# If `Environment ID` is not specified, we assume default 'draft'

3572

# environment. If `User ID` is not specified, we assume default '-' user.

3573

#

3574

# The following context names are reserved for internal use by Dialogflow.

3575

# You should not use these contexts or create contexts with these names:

3576

#

3577

# * `__system_counters__`

3578

# * `*_id_dialog_context`

3579

# * `*_dialog_params_size`

3580

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3581

# context expires. The default is `0`. If set to `0`, the context expires

3582

# immediately. Contexts expire automatically after 20 minutes if there

3583

# are no matching queries.

Bu Sun Kim

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

[diff] [blame]

3584

},

3585

],

Bu Sun Kim

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

[diff] [blame]

3586

"action": "A String", # Optional. The name of the action associated with the intent.

3587

# Note: The action name must not contain whitespaces.

Bu Sun Kim

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

[diff] [blame^]

3588

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

3589

# priorities.

3590

#

3591

# - If the supplied value is unspecified or 0, the service

3592

# translates the value to 500,000, which corresponds to the

3593

# `Normal` priority in the console.

3594

# - If the supplied value is negative, the intent is ignored

3595

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

3596

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

3597

# followup intents. It identifies the correct followup intents chain for

3598

# this intent. We populate this field only in the output.

3599

#

3600

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

Bu Sun Kim

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

[diff] [blame^]

3601

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

3602

# a direct or indirect parent. We populate this field only in the output.

3603

{ # Represents a single followup intent in the chain.

3604

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

3605

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

3606

"followupIntentName": "A String", # The unique identifier of the followup intent.

3607

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

3608

},

3609

],

Bu Sun Kim

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

[diff] [blame]

3610

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3611

# trained on.

3612

{ # Represents an example that the agent is trained on.

Bu Sun Kim

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

[diff] [blame]

3613

"name": "A String", # Output only. The unique identifier of this training phrase.

3614

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

3615

# the intent. Each time a developer adds an existing sample by editing an

3616

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

3617

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3618

# The parts are concatenated in order to form the training phrase.

3619

#

3620

# Note: The API does not automatically annotate training phrases like the

3621

# Dialogflow Console does.

3622

#

3623

# Note: Do not forget to include whitespace at part boundaries,

3624

# so the training phrase is well formatted when the parts are concatenated.

3625

#

3626

# If the training phrase does not need to be annotated with parameters,

3627

# you just need a single part with only the Part.text field set.

3628

#

3629

# If you want to annotate the training phrase, you must create multiple

3630

# parts, where the fields of each part are populated in one of two ways:

3631

#

3632

# - `Part.text` is set to a part of the phrase that has no parameters.

3633

# - `Part.text` is set to a part of the phrase that you want to annotate,

3634

# and the `entity_type`, `alias`, and `user_defined` fields are all

3635

# set.

3636

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

3637

"alias": "A String", # Optional. The parameter name for the value extracted from the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3638

# annotated part of the example.

3639

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

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

[diff] [blame]

3640

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3641

# This field is set to true when the Dialogflow Console is used to

3642

# manually annotate the part. When creating an annotated part with the

3643

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

3644

"text": "A String", # Required. The text for this part.

3645

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3646

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3647

},

3648

],

Bu Sun Kim

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

[diff] [blame^]

3649

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3650

},

3651

],

Bu Sun Kim

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

[diff] [blame^]

3652

"inputContextNames": [ # Optional. The list of context names required for this intent to be

3653

# triggered.

3654

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3655

"A String",

3656

],

3657

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

3658

# Note: If `ml_disabled` setting is set to true, then this intent is not

3659

# taken into account during inference in `ML ONLY` match mode. Also,

3660

# auto-markup in the UI is turned off.

Bu Sun Kim

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

[diff] [blame]

3661

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3662

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame^]

3663

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

3664

# chain of followup intents. You can set this field when creating an intent,

3665

# for example with CreateIntent or

3666

# BatchUpdateIntents, in order to make this

3667

# intent a followup intent.

3668

#

3669

# It identifies the parent followup intent.

3670

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

3671

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3672

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3673

"A String",

3674

],

Bu Sun Kim

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

[diff] [blame]

3675

"parameters": [ # Optional. The collection of parameters associated with the intent.

3676

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

3677

"value": "A String", # Optional. The definition of the parameter value. It can be:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3678

#

Bu Sun Kim

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

[diff] [blame]

3679

# - a constant string,

3680

# - a parameter value defined as `$parameter_name`,

3681

# - an original parameter value defined as `$parameter_name.original`,

3682

# - a parameter value from some context defined as

3683

# `#context_name.parameter_name`.

3684

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

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

[diff] [blame]

3685

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3686

# whether the intent cannot be completed without collecting the parameter

3687

# value.

Bu Sun Kim

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

[diff] [blame^]

3688

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

3689

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3690

# describes values of the parameter. If the parameter is

3691

# required, this must be provided.

Bu Sun Kim

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

[diff] [blame]

3692

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3693

# result.

3694

# Default values can be extracted from contexts by using the following

3695

# syntax: `#context_name.parameter_name`.

3696

"name": "A String", # The unique identifier of this parameter.

Bu Sun Kim

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

[diff] [blame^]

3697

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3698

# user in order to collect a value for the parameter.

3699

"A String",

3700

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3701

},

3702

],

Bu Sun Kim