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-05-20 12:08:20 -0700

[diff] [blame]

84

<code><a href="#create">create(parent, body=None, intentView=None, languageCode=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.

117

{ # Represents an intent.

118

# Intents convert a number of user expressions or patterns into an action. An

119

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

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

[diff] [blame]

120

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

121

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

122

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

123

# Event names are limited to 150 characters.

124

"A String",

125

],

126

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

127

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

128

# for example with CreateIntent or

129

# BatchUpdateIntents, in order to make this

130

# intent a followup intent.

131

#

132

# It identifies the parent followup intent.

133

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

134

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

135

# priorities.

136

#

137

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

138

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

139

# `Normal` priority in the console.

140

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

141

# in runtime detect intent requests.

142

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

143

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

144

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

145

# when the intent is matched.

146

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

147

{ # Represents a context.

148

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

149

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

150

# immediately. Contexts expire automatically after 20 minutes if there

151

# are no matching queries.

152

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

153

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

154

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

155

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

156

#

157

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

158

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

159

#

160

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

161

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

162

#

163

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

164

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

165

#

166

# * `__system_counters__`

167

# * `*_id_dialog_context`

168

# * `*_dialog_params_size`

169

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

170

#

171

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

172

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

173

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

174

#

175

# - MapKey type: string

176

# - MapKey value: parameter name

177

# - MapValue type:

178

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

179

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

180

# - MapValue value:

181

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

182

# map from composite entity property names to property values

183

# - Else: parameter value

184

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

},

},

],

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

189

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

190

"A String",

191

],

Bu Sun Kim

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

[diff] [blame]

192

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

193

# Note: The action name must not contain whitespaces.

194

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

195

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

196

# methods.

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

199

# `Response` field in the Dialogflow console.

200

{ # A rich response message.

201

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

202

# For more information, see

203

# [Rich response

204

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

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

207

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

208

{ # Response media object for media content card.

209

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

210

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

211

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

212

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

213

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

214

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

215

# e.g., screen readers.

216

},

217

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

218

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

219

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

220

# e.g., screen readers.

},

},

],

},

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

226

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

227

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

228

# e.g., screen readers.

229

},

230

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

231

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

232

},

233

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

234

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

"A String",

],

},

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

239

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

240

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

241

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

242

# to the conversation.

243

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

244

},

245

],

246

},

Bu Sun Kim

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

[diff] [blame]

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

249

"items": [ # Required. List items.

250

{ # An item in the list.

251

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

252

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

253

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

254

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

255

# e.g., screen readers.

256

},

257

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

258

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

259

# dialog.

260

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

},

},

],

Bu Sun Kim

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

[diff] [blame]

269

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

Bu Sun Kim

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

[diff] [blame]

270

},

271

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

272

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

273

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

"A String",

],

},

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

Bu Sun Kim

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

[diff] [blame]

278

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

Bu Sun Kim

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

[diff] [blame]

279

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

280

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

281

{ # Contains information about a button.

282

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

283

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

# open.

},

],

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

Bu Sun Kim

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

[diff] [blame]

288

},

289

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

290

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

291

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

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

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

297

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

298

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

Bu Sun Kim

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

[diff] [blame]

299

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

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

302

},

Bu Sun Kim

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

[diff] [blame]

303

},

304

],

305

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

306

},

307

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

308

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

309

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

310

{ # Row of TableCard.

311

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

312

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

313

{ # Cell of TableCardRow.

314

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

},

],

},

],

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

320

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

321

{ # Column properties for TableCard.

322

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

323

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

324

},

325

],

326

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

327

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

328

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

329

# e.g., screen readers.

330

},

331

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

332

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

Bu Sun Kim

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

[diff] [blame]

333

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

Bu Sun Kim

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

[diff] [blame]

334

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

335

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

336

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

341

"items": [ # Required. Carousel items.

342

{ # An item in the carousel.

Bu Sun Kim

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

[diff] [blame]

343

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

344

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

345

# dialog.

346

"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

351

# response is given.

352

},

Bu Sun Kim

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

[diff] [blame]

353

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

354

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

355

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

356

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

357

# e.g., screen readers.

358

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

363

# or website associated with this agent.

364

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

365

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

366

# suggestion chip.

367

},

368

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

369

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

370

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

371

# items, maximum of ten.

372

{ # Browsing carousel tile

Bu Sun Kim

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

[diff] [blame]

373

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

374

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

375

# the URL. Defaults to opening via web browser.

376

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

377

},

378

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

379

# Card. Maximum of one line of text.

380

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

381

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

382

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

383

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

384

# e.g., screen readers.

385

},

Bu Sun Kim

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

[diff] [blame]

386

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

387

# text.

Bu Sun Kim

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

[diff] [blame]

388

},

389

],

390

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

391

# items.

392

},

393

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

394

# This message in `QueryResult.fulfillment_messages` and

395

# `WebhookResponse.fulfillment_messages` should contain only one

396

# `SimpleResponse`.

397

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

398

{ # The simple response message containing speech or text.

Bu Sun Kim

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

[diff] [blame]

399

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

400

# speech output. Mutually exclusive with ssml.

401

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

402

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

403

# text_to_speech.

Bu Sun Kim

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

[diff] [blame]

404

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

Bu Sun Kim

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

[diff] [blame]

405

},

406

],

407

},

Bu Sun Kim

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

[diff] [blame]

408

},

409

],

Bu Sun Kim

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

[diff] [blame]

410

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

Bu Sun Kim

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

[diff] [blame]

411

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

412

# triggered.

413

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

414

"A String",

415

],

Bu Sun Kim

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

[diff] [blame]

416

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

417

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

418

{ # Represents a single followup intent in the chain.

419

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

420

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

421

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

422

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

Bu Sun Kim

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

[diff] [blame]

423

},

424

],

Bu Sun Kim

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

[diff] [blame]

425

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

426

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

427

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

428

#

429

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

Bu Sun Kim

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

[diff] [blame]

430

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

Bu Sun Kim

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

[diff] [blame]

431

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

432

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

433

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

434

# auto-markup in the UI is turned off.

435

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

436

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

Bu Sun Kim

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

[diff] [blame]

437

# trained on.

438

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

Bu Sun Kim

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

[diff] [blame]

439

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

440

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

441

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

442

# intent or training, this counter is increased.

443

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

Bu Sun Kim

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

[diff] [blame]

444

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

Bu Sun Kim

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

[diff] [blame]

445

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

446

#

447

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

448

# Dialogflow Console does.

449

#

450

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

451

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

452

#

453

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

454

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

455

#

456

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

457

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

458

#

459

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

460

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

461

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

462

# set.

463

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

464

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

465

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

466

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

Bu Sun Kim

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

[diff] [blame]

467

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

468

# annotated part of the example.

469

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

Bu Sun Kim

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

[diff] [blame]

470

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

Bu Sun Kim

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

[diff] [blame]

471

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

472

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

473

# API, you must set this to true.

474

},

475

],

Bu Sun Kim

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

[diff] [blame]

476

},

477

],

Bu Sun Kim

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

[diff] [blame]

478

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

479

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame]

480

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

481

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

482

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

483

#

Bu Sun Kim

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

[diff] [blame]

484

# - a constant string,

485

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

486

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

487

# - a parameter value from some context defined as

488

# `#context_name.parameter_name`.

489

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

490

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

491

# describes values of the parameter. If the parameter is

492

# required, this must be provided.

493

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

494

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

495

"A String",

496

],

Bu Sun Kim

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

[diff] [blame]

497

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

498

# whether the intent cannot be completed without collecting the parameter

499

# value.

500

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

501

# result.

502

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

503

# syntax: `#context_name.parameter_name`.

504

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

505

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

Bu Sun Kim

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

[diff] [blame]

506

},

507

],

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:

519

520

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

521

# network API call.

Bu Sun Kim

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

[diff] [blame]

522

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

Dan O'Meara

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

[diff] [blame]

523

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

524

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

525

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

526

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

527

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

528

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

529

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

530

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

Dan O'Meara

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

[diff] [blame]

531

},

Bu Sun Kim

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

[diff] [blame]

532

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

533

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

534

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

Bu Sun Kim

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

[diff] [blame]

535

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

536

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

537

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

538

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

539

#

540

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

541

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

Bu Sun Kim

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

[diff] [blame]

542

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

543

# message types for APIs to use.

544

{

Bu Sun Kim

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

[diff] [blame]

545

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

Bu Sun Kim

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

[diff] [blame]

546

},

547

],

Bu Sun Kim

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

[diff] [blame]

548

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

549

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

550

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

551

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

Bu Sun Kim

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

[diff] [blame]

552

},

Bu Sun Kim

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

[diff] [blame]

553

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

554

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

555

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

556

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

557

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

558

},

559

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

560

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

561

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

566

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

567

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

568

Dan O'Meara

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

[diff] [blame]

569

Operation <response: BatchUpdateIntentsResponse>

Bu Sun Kim

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

[diff] [blame]

570

571

Args:

572

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]

573

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

574

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

575

The object takes the form of:

576

Dan O'Meara

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

[diff] [blame]

577

{

Bu Sun Kim

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

[diff] [blame]

578

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

Bu Sun Kim

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

[diff] [blame]

579

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

Bu Sun Kim

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

[diff] [blame]

580

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

581

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

582

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

583

"intents": [ # A collection of intents.

Bu Sun Kim

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

[diff] [blame]

584

{ # Represents an intent.

585

# Intents convert a number of user expressions or patterns into an action. An

586

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

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

[diff] [blame]

587

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

588

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

589

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

590

# Event names are limited to 150 characters.

591

"A String",

592

],

593

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

594

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

595

# for example with CreateIntent or

596

# BatchUpdateIntents, in order to make this

597

# intent a followup intent.

598

#

599

# It identifies the parent followup intent.

600

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

601

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

602

# priorities.

603

#

604

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

605

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

606

# `Normal` priority in the console.

607

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

608

# in runtime detect intent requests.

609

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

610

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

611

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

612

# when the intent is matched.

613

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

614

{ # Represents a context.

615

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

616

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

617

# immediately. Contexts expire automatically after 20 minutes if there

618

# are no matching queries.

619

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

620

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

621

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

622

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

623

#

624

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

625

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

626

#

627

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

628

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

629

#

630

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

631

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

632

#

633

# * `__system_counters__`

634

# * `*_id_dialog_context`

635

# * `*_dialog_params_size`

636

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

637

#

638

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

639

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

640

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

641

#

642

# - MapKey type: string

643

# - MapKey value: parameter name

644

# - MapValue type:

645

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

646

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

647

# - MapValue value:

648

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

649

# map from composite entity property names to property values

650

# - Else: parameter value

651

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

},

},

],

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

656

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

657

"A String",

658

],

Bu Sun Kim

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

[diff] [blame]

659

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

660

# Note: The action name must not contain whitespaces.

661

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

662

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

663

# methods.

664

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

Bu Sun Kim

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

[diff] [blame]

665

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

666

# `Response` field in the Dialogflow console.

667

{ # A rich response message.

668

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

669

# For more information, see

670

# [Rich response

671

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

Bu Sun Kim

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

[diff] [blame]

672

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

673

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

674

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

675

{ # Response media object for media content card.

676

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

677

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

678

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

679

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

680

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

681

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

682

# e.g., screen readers.

683

},

684

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

685

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

686

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

687

# e.g., screen readers.

},

},

],

},

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

693

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

694

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

695

# e.g., screen readers.

696

},

697

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

698

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

699

},

700

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

701

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

"A String",

],

},

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

706

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

707

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

708

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

709

# to the conversation.

710

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

711

},

712

],

713

},

Bu Sun Kim

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

[diff] [blame]

714

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

Bu Sun Kim

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

[diff] [blame]

715

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

716

"items": [ # Required. List items.

717

{ # An item in the list.

718

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

719

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

720

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

721

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

722

# e.g., screen readers.

723

},

724

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

725

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

726

# dialog.

727

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

},

},

],

Bu Sun Kim

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

[diff] [blame]

736

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

Bu Sun Kim

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

[diff] [blame]

737

},

738

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

739

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

740

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

"A String",

],

},

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

Bu Sun Kim

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

[diff] [blame]

745

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

Bu Sun Kim

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

[diff] [blame]

746

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

747

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

748

{ # Contains information about a button.

749

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

750

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

# open.

},

],

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

Bu Sun Kim

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

[diff] [blame]

755

},

756

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

757

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

758

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

759

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

760

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

761

# e.g., screen readers.

762

},

763

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

764

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

765

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

Bu Sun Kim

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

[diff] [blame]

766

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

Bu Sun Kim

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

[diff] [blame]

767

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

768

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

769

},

Bu Sun Kim

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

[diff] [blame]

770

},

771

],

772

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

773

},

774

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

775

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

776

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

777

{ # Row of TableCard.

778

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

779

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

780

{ # Cell of TableCardRow.

781

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

},

],

},

],

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

787

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

788

{ # Column properties for TableCard.

789

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

790

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

791

},

792

],

793

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

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

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

799

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

Bu Sun Kim

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

[diff] [blame]

800

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

Bu Sun Kim

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

[diff] [blame]

801

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

802

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

803

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

808

"items": [ # Required. Carousel items.

809

{ # An item in the carousel.

Bu Sun Kim

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

[diff] [blame]

810

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

811

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

812

# dialog.

813

"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

818

# response is given.

819

},

Bu Sun Kim

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

[diff] [blame]

820

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

821

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

822

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

823

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

824

# e.g., screen readers.

825

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

830

# or website associated with this agent.

831

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

832

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

833

# suggestion chip.

834

},

835

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

836

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

837

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

838

# items, maximum of ten.

839

{ # Browsing carousel tile

Bu Sun Kim

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

[diff] [blame]

840

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

841

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

842

# the URL. Defaults to opening via web browser.

843

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

844

},

845

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

846

# Card. Maximum of one line of text.

847

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

848

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

849

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

850

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

851

# e.g., screen readers.

852

},

Bu Sun Kim

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

[diff] [blame]

853

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

854

# text.

Bu Sun Kim

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

[diff] [blame]

855

},

856

],

857

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

858

# items.

859

},

860

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

861

# This message in `QueryResult.fulfillment_messages` and

862

# `WebhookResponse.fulfillment_messages` should contain only one

863

# `SimpleResponse`.

864

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

865

{ # The simple response message containing speech or text.

Bu Sun Kim

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

[diff] [blame]

866

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

867

# speech output. Mutually exclusive with ssml.

868

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

869

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

870

# text_to_speech.

Bu Sun Kim

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

[diff] [blame]

871

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

Bu Sun Kim

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

[diff] [blame]

872

},

873

],

874

},

Bu Sun Kim

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

[diff] [blame]

875

},

876

],

Bu Sun Kim

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

[diff] [blame]

877

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

Bu Sun Kim

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

[diff] [blame]

878

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

879

# triggered.

880

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

881

"A String",

882

],

Bu Sun Kim

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

[diff] [blame]

883

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

884

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

885

{ # Represents a single followup intent in the chain.

886

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

887

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

888

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

889

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

Bu Sun Kim

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

[diff] [blame]

890

},

891

],

Bu Sun Kim

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

[diff] [blame]

892

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

893

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

894

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

895

#

896

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

Bu Sun Kim

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

[diff] [blame]

897

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

Bu Sun Kim

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

[diff] [blame]

898

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

899

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

900

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

901

# auto-markup in the UI is turned off.

902

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

903

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

Bu Sun Kim

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

[diff] [blame]

904

# trained on.

905

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

Bu Sun Kim

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

[diff] [blame]

906

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

907

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

908

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

909

# intent or training, this counter is increased.

910

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

Bu Sun Kim

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

[diff] [blame]

911

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

Bu Sun Kim

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

[diff] [blame]

912

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

913

#

914

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

915

# Dialogflow Console does.

916

#

917

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

918

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

919

#

920

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

921

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

922

#

923

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

924

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

925

#

926

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

927

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

928

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

929

# set.

930

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

931

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

932

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

933

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

Bu Sun Kim

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

[diff] [blame]

934

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

935

# annotated part of the example.

936

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

Bu Sun Kim

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

[diff] [blame]

937

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

Bu Sun Kim

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

[diff] [blame]

938

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

939

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

940

# API, you must set this to true.

941

},

942

],

Bu Sun Kim

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

[diff] [blame]

943

},

944

],

Bu Sun Kim

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

[diff] [blame]

945

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

946

# session when this intent is matched.

Bu Sun Kim

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

[diff] [blame]

947

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

948

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

949

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

950

#

Bu Sun Kim

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

[diff] [blame]

951

# - a constant string,

952

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

953

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

954

# - a parameter value from some context defined as

955

# `#context_name.parameter_name`.

956

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

957

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

958

# describes values of the parameter. If the parameter is

959

# required, this must be provided.

960

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

961

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

962

"A String",

963

],

Bu Sun Kim

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

[diff] [blame]

964

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

965

# whether the intent cannot be completed without collecting the parameter

966

# value.

967

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

968

# result.

969

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

970

# syntax: `#context_name.parameter_name`.

971

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

972

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

Bu Sun Kim

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

[diff] [blame]

973

},

974

],

Bu Sun Kim

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

[diff] [blame]

975

},

976

],

977

},

Bu Sun Kim

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

[diff] [blame]

978

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

979

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

980

# For more information, see

981

# [Multilingual intent and entity

982

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

983

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

Bu Sun Kim

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

[diff] [blame]

984

}

985

986

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

993

994

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

995

# network API call.

Bu Sun Kim

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

[diff] [blame]

996

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

Dan O'Meara

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

[diff] [blame]

997

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

998

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

999

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

1000

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

1001

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

1002

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

1003

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1004

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

Dan O'Meara

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

[diff] [blame]

1005

},

Bu Sun Kim

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

[diff] [blame]

1006

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

1007

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

1008

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

Bu Sun Kim

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

[diff] [blame]

1009

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

1010

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

1011

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

1012

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

1013

#

1014

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

1015

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

Bu Sun Kim

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

[diff] [blame]

1016

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

1017

# message types for APIs to use.

1018

{

Bu Sun Kim

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

[diff] [blame]

1019

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

Bu Sun Kim

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

[diff] [blame]

1020

},

1021

],

Bu Sun Kim

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

[diff] [blame]

1022

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

1023

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

1024

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

1025

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

Bu Sun Kim

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

[diff] [blame]

1026

},

Bu Sun Kim

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

[diff] [blame]

1027

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

1028

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

1029

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

1030

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

1031

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

1032

},

1033

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

1034

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

1035

# available.

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]

1040

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

Bu Sun Kim

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

[diff] [blame]

1041

<pre>Creates an intent in the specified agent.

1042

1043

Args:

1044

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

Dan O'Meara

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

[diff] [blame]

1045

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

1046

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1047

The object takes the form of:

1048

1049

{ # Represents an intent.

1050

# Intents convert a number of user expressions or patterns into an action. An

1051

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

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

[diff] [blame]

1052

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

1053

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

1054

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

1055

# Event names are limited to 150 characters.

1056

"A String",

1057

],

1058

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

1059

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

1060

# for example with CreateIntent or

1061

# BatchUpdateIntents, in order to make this

1062

# intent a followup intent.

1063

#

1064

# It identifies the parent followup intent.

1065

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

1066

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

1067

# priorities.

1068

#

1069

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

1070

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

1071

# `Normal` priority in the console.

1072

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

1073

# in runtime detect intent requests.

1074

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

1075

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

1076

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

1077

# when the intent is matched.

1078

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

1079

{ # Represents a context.

1080

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

1081

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

1082

# immediately. Contexts expire automatically after 20 minutes if there

1083

# are no matching queries.

1084

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

1085

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

1086

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

1087

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

1088

#

1089

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

1090

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

1091

#

1092

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

1093

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

1094

#

1095

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

1096

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

1097

#

1098

# * `__system_counters__`

1099

# * `*_id_dialog_context`

1100

# * `*_dialog_params_size`

1101

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

1102

#

1103

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

1104

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

1105

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

1106

#

1107

# - MapKey type: string

1108

# - MapKey value: parameter name

1109

# - MapValue type:

1110

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

1111

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

1112

# - MapValue value:

1113

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

1114

# map from composite entity property names to property values

1115

# - Else: parameter value

1116

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

},

},

],

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

1121

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

1122

"A String",

1123

],

Bu Sun Kim

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

[diff] [blame]

1124

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

1125

# Note: The action name must not contain whitespaces.

1126

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

1127

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1128

# methods.

1129

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

Bu Sun Kim

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

[diff] [blame]

1130

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

1131

# `Response` field in the Dialogflow console.

1132

{ # A rich response message.

1133

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

1134

# For more information, see

1135

# [Rich response

1136

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

Bu Sun Kim

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

[diff] [blame]

1137

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

1138

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

1139

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

1140

{ # Response media object for media content card.

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

# e.g., screen readers.

1148

},

1149

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

1150

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

1151

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

1152

# e.g., screen readers.

},

},

],

},

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

1158

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

1159

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

1160

# e.g., screen readers.

1161

},

1162

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

1163

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

1164

},

1165

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

1166

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

"A String",

],

},

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

1171

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

1172

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

1173

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

1174

# to the conversation.

1175

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

1176

},

1177

],

1178

},

Bu Sun Kim

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

[diff] [blame]

1179

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

Bu Sun Kim

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

[diff] [blame]

1180

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

1181

"items": [ # Required. List items.

1182

{ # An item in the list.

1183

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

1184

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

1185

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

1186

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

1187

# e.g., screen readers.

1188

},

1189

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

1190

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

1191

# dialog.

1192

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

},

},

],

Bu Sun Kim

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

[diff] [blame]

1201

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

Bu Sun Kim

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

[diff] [blame]

1202

},

1203

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

1204

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

1205

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

"A String",

],

},

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

Bu Sun Kim

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

[diff] [blame]

1210

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

Bu Sun Kim

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

[diff] [blame]

1211

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

1212

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

1213

{ # Contains information about a button.

1214

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

1215

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

# open.

},

],

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

Bu Sun Kim

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

[diff] [blame]

1220

},

1221

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

1222

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

1223

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

1224

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

1225

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

1226

# e.g., screen readers.

1227

},

1228

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

1229

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

1230

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

Bu Sun Kim

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

[diff] [blame]

1231

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

Bu Sun Kim

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

[diff] [blame]

1232

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

1233

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

1234

},

Bu Sun Kim

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

[diff] [blame]

1235

},

1236

],

1237

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

1238

},

1239

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

1240

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

1241

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

1242

{ # Row of TableCard.

1243

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

1244

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

1245

{ # Cell of TableCardRow.

1246

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

},

],

},

],

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

1252

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

1253

{ # Column properties for TableCard.

1254

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

1255

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

1256

},

1257

],

1258

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

1259

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

1260

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

1261

# e.g., screen readers.

1262

},

1263

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

1264

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

Bu Sun Kim

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

[diff] [blame]

1265

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

Bu Sun Kim

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

[diff] [blame]

1266

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

1267

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

1268

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

1273

"items": [ # Required. Carousel items.

1274

{ # An item in the carousel.

Bu Sun Kim

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

[diff] [blame]

1275

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

1276

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

1277

# dialog.

1278

"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

1283

# response is given.

1284

},

Bu Sun Kim

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

[diff] [blame]

1285

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

1286

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

1287

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

1288

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

1289

# e.g., screen readers.

1290

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

1295

# or website associated with this agent.

1296

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

1297

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

1298

# suggestion chip.

1299

},

1300

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

1301

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

1302

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

1303

# items, maximum of ten.

1304

{ # Browsing carousel tile

Bu Sun Kim

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

[diff] [blame]

1305

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

1306

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

1307

# the URL. Defaults to opening via web browser.

1308

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

1309

},

1310

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

1311

# Card. Maximum of one line of text.

1312

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

1313

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

1314

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

1315

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

1316

# e.g., screen readers.

1317

},

Bu Sun Kim

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

[diff] [blame]

1318

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

1319

# text.

Bu Sun Kim

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

[diff] [blame]

1320

},

1321

],

1322

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

1323

# items.

1324

},

1325

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

1326

# This message in `QueryResult.fulfillment_messages` and

1327

# `WebhookResponse.fulfillment_messages` should contain only one

1328

# `SimpleResponse`.

1329

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

1330

{ # The simple response message containing speech or text.

Bu Sun Kim

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

[diff] [blame]

1331

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

1332

# speech output. Mutually exclusive with ssml.

1333

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

1334

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

1335

# text_to_speech.

Bu Sun Kim

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

[diff] [blame]

1336

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

Bu Sun Kim

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

[diff] [blame]

1337

},

1338

],

1339

},

Bu Sun Kim

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

[diff] [blame]

1340

},

1341

],

Bu Sun Kim

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

[diff] [blame]

1342

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

Bu Sun Kim

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

[diff] [blame]

1343

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

1344

# triggered.

1345

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

1346

"A String",

1347

],

Bu Sun Kim

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

[diff] [blame]

1348

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

1349

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

1350

{ # Represents a single followup intent in the chain.

1351

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

1352

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

1353

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

1354

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1355

},

1356

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1357

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

1358

# followup intents. It identifies the correct followup intents chain for

1359

# this intent. We populate this field only in the output.

1360

#

1361

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1362

"displayName": "A String", # Required. The name of this intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1363

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

1364

# Note: If `ml_disabled` setting is set to true, then this intent is not

1365

# taken into account during inference in `ML ONLY` match mode. Also,

1366

# auto-markup in the UI is turned off.

1367

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

1368

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1369

# trained on.

1370

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1371

"name": "A String", # Output only. The unique identifier of this training phrase.

1372

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

1373

# the intent. Each time a developer adds an existing sample by editing an

1374

# intent or training, this counter is increased.

1375

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1376

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1377

# The parts are concatenated in order to form the training phrase.

1378

#

1379

# Note: The API does not automatically annotate training phrases like the

1380

# Dialogflow Console does.

1381

#

1382

# Note: Do not forget to include whitespace at part boundaries,

1383

# so the training phrase is well formatted when the parts are concatenated.

1384

#

1385

# If the training phrase does not need to be annotated with parameters,

1386

# you just need a single part with only the Part.text field set.

1387

#

1388

# If you want to annotate the training phrase, you must create multiple

1389

# parts, where the fields of each part are populated in one of two ways:

1390

#

1391

# - `Part.text` is set to a part of the phrase that has no parameters.

1392

# - `Part.text` is set to a part of the phrase that you want to annotate,

1393

# and the `entity_type`, `alias`, and `user_defined` fields are all

1394

# set.

1395

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1396

"text": "A String", # Required. The text for this part.

1397

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

1398

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1399

"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]

1400

# annotated part of the example.

1401

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1402

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1403

# This field is set to true when the Dialogflow Console is used to

1404

# manually annotate the part. When creating an annotated part with the

1405

# API, you must set this to true.

1406

},

1407

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1408

},

1409

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1410

"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]

1411

# session when this intent is matched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1412

"parameters": [ # Optional. The collection of parameters associated with the intent.

1413

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1414

"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]

1415

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1416

# - a constant string,

1417

# - a parameter value defined as `$parameter_name`,

1418

# - an original parameter value defined as `$parameter_name.original`,

1419

# - a parameter value from some context defined as

1420

# `#context_name.parameter_name`.

1421

"displayName": "A String", # Required. The name of the parameter.

1422

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1423

# describes values of the parameter. If the parameter is

1424

# required, this must be provided.

1425

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1426

# user in order to collect a value for the parameter.

1427

"A String",

1428

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1429

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

1430

# whether the intent cannot be completed without collecting the parameter

1431

# value.

1432

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1433

# result.

1434

# Default values can be extracted from contexts by using the following

1435

# syntax: `#context_name.parameter_name`.

1436

"name": "A String", # The unique identifier of this parameter.

1437

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1438

},

1439

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1440

}

1441

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1442

intentView: string, Optional. The resource view to apply to the returned intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1443

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1444

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1445

For more information, see

1446

[Multilingual intent and entity

1447

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1448

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1455

1456

{ # Represents an intent.

1457

# Intents convert a number of user expressions or patterns into an action. An

1458

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1459

"events": [ # Optional. The collection of event names that trigger the intent.

1460

# If the collection of input contexts is not empty, all of the contexts must

1461

# be present in the active user session for an event to trigger this intent.

1462

# Event names are limited to 150 characters.

1463

"A String",

1464

],

1465

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

1466

# chain of followup intents. You can set this field when creating an intent,

1467

# for example with CreateIntent or

1468

# BatchUpdateIntents, in order to make this

1469

# intent a followup intent.

1470

#

1471

# It identifies the parent followup intent.

1472

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1473

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

1474

# priorities.

1475

#

1476

# - If the supplied value is unspecified or 0, the service

1477

# translates the value to 500,000, which corresponds to the

1478

# `Normal` priority in the console.

1479

# - If the supplied value is negative, the intent is ignored

1480

# in runtime detect intent requests.

1481

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

1482

# is matched. Context messages in this collection should not set the

1483

# parameters field. Setting the `lifespan_count` to 0 will reset the context

1484

# when the intent is matched.

1485

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

1486

{ # Represents a context.

1487

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1488

# context expires. The default is `0`. If set to `0`, the context expires

1489

# immediately. Contexts expire automatically after 20 minutes if there

1490

# are no matching queries.

1491

"name": "A String", # Required. The unique identifier of the context. Format:

1492

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1493

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1494

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

1495

#

1496

# The `Context ID` is always converted to lowercase, may only contain

1497

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

1498

#

1499

# If `Environment ID` is not specified, we assume default 'draft'

1500

# environment. If `User ID` is not specified, we assume default '-' user.

1501

#

1502

# The following context names are reserved for internal use by Dialogflow.

1503

# You should not use these contexts or create contexts with these names:

1504

#

1505

# * `__system_counters__`

1506

# * `*_id_dialog_context`

1507

# * `*_dialog_params_size`

1508

"parameters": { # Optional. The collection of parameters associated with this context.

1509

#

1510

# Depending on your protocol or client library language, this is a

1511

# map, associative array, symbol table, dictionary, or JSON object

1512

# composed of a collection of (MapKey, MapValue) pairs:

1513

#

1514

# - MapKey type: string

1515

# - MapKey value: parameter name

1516

# - MapValue type:

1517

# - If parameter's entity type is a composite entity: map

1518

# - Else: string or number, depending on parameter value type

1519

# - MapValue value:

1520

# - If parameter's entity type is a composite entity:

1521

# map from composite entity property names to property values

1522

# - Else: parameter value

1523

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

1528

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1529

"A String",

1530

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1531

"action": "A String", # Optional. The name of the action associated with the intent.

1532

# Note: The action name must not contain whitespaces.

1533

"name": "A String", # Optional. The unique identifier of this intent.

1534

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1535

# methods.

1536

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1537

"messages": [ # Optional. The collection of rich messages corresponding to the

1538

# `Response` field in the Dialogflow console.

1539

{ # A rich response message.

1540

# Corresponds to the intent `Response` field in the Dialogflow console.

1541

# For more information, see

1542

# [Rich response

1543

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1544

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1545

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1546

"mediaObjects": [ # Required. List of media objects.

1547

{ # Response media object for media content card.

1548

"name": "A String", # Required. Name of media card.

1549

"description": "A String", # Optional. Description of media card.

1550

"contentUrl": "A String", # Required. Url where the media is stored.

1551

"icon": { # The image response message. # Optional. Icon to display above media content.

1552

"imageUri": "A String", # Optional. The public URI to an image file.

1553

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1554

# e.g., screen readers.

1555

},

1556

"largeImage": { # The image response message. # Optional. Image to display above media content.

1557

"imageUri": "A String", # Optional. The public URI to an image file.

1558

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1559

# e.g., screen readers.

},

},

],

},

"image": { # The image response message. # The image response.

1565

"imageUri": "A String", # Optional. The public URI to an image file.

1566

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1567

# e.g., screen readers.

1568

},

1569

"payload": { # A custom platform-specific response.

1570

"a_key": "", # Properties of the object.

1571

},

1572

"text": { # The text response message. # The text response.

1573

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

1578

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

1579

"suggestions": [ # Required. The list of suggested replies.

1580

{ # The suggestion chip message that the user can tap to quickly post a reply

1581

# to the conversation.

1582

"title": "A String", # Required. The text shown the in the suggestion chip.

1583

},

1584

],

1585

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1586

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1587

"subtitle": "A String", # Optional. Subtitle of the list.

1588

"items": [ # Required. List items.

1589

{ # An item in the list.

1590

"title": "A String", # Required. The title of the list item.

1591

"image": { # The image response message. # Optional. The image to display.

1592

"imageUri": "A String", # Optional. The public URI to an image file.

1593

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1594

# e.g., screen readers.

1595

},

1596

"description": "A String", # Optional. The main text describing the item.

1597

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

1598

# dialog.

1599

"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.

},

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1608

"title": "A String", # Optional. The overall title of the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1609

},

1610

"quickReplies": { # The quick replies response message. # The quick replies response.

1611

"title": "A String", # Optional. The title of the collection of quick replies.

1612

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"card": { # The card response message. # The card response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1617

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1618

"title": "A String", # Optional. The title of the card.

1619

"buttons": [ # Optional. The collection of card buttons.

1620

{ # Contains information about a button.

1621

"text": "A String", # Optional. The text to show on the button.

1622

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1627

},

1628

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

1629

"title": "A String", # Optional. The title of the card.

1630

"image": { # The image response message. # Optional. The image for the card.

1631

"imageUri": "A String", # Optional. The public URI to an image file.

1632

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1633

# e.g., screen readers.

1634

},

1635

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1636

"buttons": [ # Optional. The collection of card buttons.

1637

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1638

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1639

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1640

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1641

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1642

},

1643

],

1644

"subtitle": "A String", # Optional. The subtitle of the card.

1645

},

1646

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

1647

"title": "A String", # Required. Title of the card.

1648

"rows": [ # Optional. Rows in this table of data.

1649

{ # Row of TableCard.

1650

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

1651

"cells": [ # Optional. List of cells that make up this row.

1652

{ # Cell of TableCardRow.

1653

"text": "A String", # Required. Text in this cell.

},

],

},

],

"subtitle": "A String", # Optional. Subtitle to the title.

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

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1666

"imageUri": "A String", # Optional. The public URI to an image file.

1667

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1668

# e.g., screen readers.

1669

},

1670

"buttons": [ # Optional. List of buttons for the card.

1671

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1672

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1673

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1674

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1675

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

1680

"items": [ # Required. Carousel items.

1681

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1682

"description": "A String", # Optional. The body text of the card.

1683

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

1684

# dialog.

1685

"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

1690

# response is given.

1691

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1692

"title": "A String", # Required. Title of the carousel item.

1693

"image": { # The image response message. # Optional. The image to display.

1694

"imageUri": "A String", # Optional. The public URI to an image file.

1695

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1696

# e.g., screen readers.

1697

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

1702

# or website associated with this agent.

1703

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1704

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

1705

# suggestion chip.

1706

},

1707

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

1708

# https://developers.google.com/actions/assistant/responses#browsing_carousel

1709

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

1710

# items, maximum of ten.

1711

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1712

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1713

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

1714

# the URL. Defaults to opening via web browser.

1715

"url": "A String", # Required. URL

1716

},

1717

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

1718

# Card. Maximum of one line of text.

1719

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

1720

"image": { # The image response message. # Optional. Hero image for the carousel item.

1721

"imageUri": "A String", # Optional. The public URI to an image file.

1722

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1723

# e.g., screen readers.

1724

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1725

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

1726

# text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1727

},

1728

],

1729

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

1730

# items.

1731

},

1732

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

1733

# This message in `QueryResult.fulfillment_messages` and

1734

# `WebhookResponse.fulfillment_messages` should contain only one

1735

# `SimpleResponse`.

1736

"simpleResponses": [ # Required. The list of simple responses.

1737

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1738

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

1739

# speech output. Mutually exclusive with ssml.

1740

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

1741

# response to the user in the SSML format. Mutually exclusive with

1742

# text_to_speech.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1743

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1744

},

1745

],

1746

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1747

},

1748

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1749

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1750

"inputContextNames": [ # Optional. The list of context names required for this intent to be

1751

# triggered.

1752

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

1753

"A String",

1754

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1755

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

1756

# a direct or indirect parent. We populate this field only in the output.

1757

{ # Represents a single followup intent in the chain.

1758

"followupIntentName": "A String", # The unique identifier of the followup intent.

1759

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1760

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

1761

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1762

},

1763

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1764

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

1765

# followup intents. It identifies the correct followup intents chain for

1766

# this intent. We populate this field only in the output.

1767

#

1768

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1769

"displayName": "A String", # Required. The name of this intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1770

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

1771

# Note: If `ml_disabled` setting is set to true, then this intent is not

1772

# taken into account during inference in `ML ONLY` match mode. Also,

1773

# auto-markup in the UI is turned off.

1774

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

1775

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1776

# trained on.

1777

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1778

"name": "A String", # Output only. The unique identifier of this training phrase.

1779

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

1780

# the intent. Each time a developer adds an existing sample by editing an

1781

# intent or training, this counter is increased.

1782

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1783

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1784

# The parts are concatenated in order to form the training phrase.

1785

#

1786

# Note: The API does not automatically annotate training phrases like the

1787

# Dialogflow Console does.

1788

#

1789

# Note: Do not forget to include whitespace at part boundaries,

1790

# so the training phrase is well formatted when the parts are concatenated.

1791

#

1792

# If the training phrase does not need to be annotated with parameters,

1793

# you just need a single part with only the Part.text field set.

1794

#

1795

# If you want to annotate the training phrase, you must create multiple

1796

# parts, where the fields of each part are populated in one of two ways:

1797

#

1798

# - `Part.text` is set to a part of the phrase that has no parameters.

1799

# - `Part.text` is set to a part of the phrase that you want to annotate,

1800

# and the `entity_type`, `alias`, and `user_defined` fields are all

1801

# set.

1802

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1803

"text": "A String", # Required. The text for this part.

1804

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

1805

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1806

"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]

1807

# annotated part of the example.

1808

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1809

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1810

# This field is set to true when the Dialogflow Console is used to

1811

# manually annotate the part. When creating an annotated part with the

1812

# API, you must set this to true.

1813

},

1814

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1815

},

1816

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1817

"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]

1818

# session when this intent is matched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1819

"parameters": [ # Optional. The collection of parameters associated with the intent.

1820

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1821

"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]

1822

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1823

# - a constant string,

1824

# - a parameter value defined as `$parameter_name`,

1825

# - an original parameter value defined as `$parameter_name.original`,

1826

# - a parameter value from some context defined as

1827

# `#context_name.parameter_name`.

1828

"displayName": "A String", # Required. The name of the parameter.

1829

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1830

# describes values of the parameter. If the parameter is

1831

# required, this must be provided.

1832

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1833

# user in order to collect a value for the parameter.

1834

"A String",

1835

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1836

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

1837

# whether the intent cannot be completed without collecting the parameter

1838

# value.

1839

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1840

# result.

1841

# Default values can be extracted from contexts by using the following

1842

# syntax: `#context_name.parameter_name`.

1843

"name": "A String", # The unique identifier of this parameter.

1844

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1845

},

1846

],

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>

1852

<pre>Deletes the specified intent and its direct or indirect followup intents.

1853

1854

Args:

1855

name: string, Required. The name of the intent to delete. If this intent has direct or

1856

indirect followup intents, we also delete them.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1857

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1858

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1865

1866

{ # A generic empty message that you can re-use to avoid defining duplicated

1867

# empty messages in your APIs. A typical example is to use it as the request

1868

# or the response type of an API method. For instance:

1869

#

1870

# service Foo {

1871

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1872

# }

1873

#

1874

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1879

<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]

1880

<pre>Retrieves the specified intent.

1881

1882

Args:

1883

name: string, Required. The name of the intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1884

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1885

intentView: string, Optional. The resource view to apply to the returned intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1886

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1887

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1888

For more information, see

1889

[Multilingual intent and entity

1890

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1891

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1898

1899

{ # Represents an intent.

1900

# Intents convert a number of user expressions or patterns into an action. An

1901

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1902

"events": [ # Optional. The collection of event names that trigger the intent.

1903

# If the collection of input contexts is not empty, all of the contexts must

1904

# be present in the active user session for an event to trigger this intent.

1905

# Event names are limited to 150 characters.

1906

"A String",

1907

],

1908

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

1909

# chain of followup intents. You can set this field when creating an intent,

1910

# for example with CreateIntent or

1911

# BatchUpdateIntents, in order to make this

1912

# intent a followup intent.

1913

#

1914

# It identifies the parent followup intent.

1915

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1916

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

1917

# priorities.

1918

#

1919

# - If the supplied value is unspecified or 0, the service

1920

# translates the value to 500,000, which corresponds to the

1921

# `Normal` priority in the console.

1922

# - If the supplied value is negative, the intent is ignored

1923

# in runtime detect intent requests.

1924

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

1925

# is matched. Context messages in this collection should not set the

1926

# parameters field. Setting the `lifespan_count` to 0 will reset the context

1927

# when the intent is matched.

1928

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

1929

{ # Represents a context.

1930

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1931

# context expires. The default is `0`. If set to `0`, the context expires

1932

# immediately. Contexts expire automatically after 20 minutes if there

1933

# are no matching queries.

1934

"name": "A String", # Required. The unique identifier of the context. Format:

1935

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1936

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1937

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

1938

#

1939

# The `Context ID` is always converted to lowercase, may only contain

1940

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

1941

#

1942

# If `Environment ID` is not specified, we assume default 'draft'

1943

# environment. If `User ID` is not specified, we assume default '-' user.

1944

#

1945

# The following context names are reserved for internal use by Dialogflow.

1946

# You should not use these contexts or create contexts with these names:

1947

#

1948

# * `__system_counters__`

1949

# * `*_id_dialog_context`

1950

# * `*_dialog_params_size`

1951

"parameters": { # Optional. The collection of parameters associated with this context.

1952

#

1953

# Depending on your protocol or client library language, this is a

1954

# map, associative array, symbol table, dictionary, or JSON object

1955

# composed of a collection of (MapKey, MapValue) pairs:

1956

#

1957

# - MapKey type: string

1958

# - MapKey value: parameter name

1959

# - MapValue type:

1960

# - If parameter's entity type is a composite entity: map

1961

# - Else: string or number, depending on parameter value type

1962

# - MapValue value:

1963

# - If parameter's entity type is a composite entity:

1964

# map from composite entity property names to property values

1965

# - Else: parameter value

1966

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

1971

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1972

"A String",

1973

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1974

"action": "A String", # Optional. The name of the action associated with the intent.

1975

# Note: The action name must not contain whitespaces.

1976

"name": "A String", # Optional. The unique identifier of this intent.

1977

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1978

# methods.

1979

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1980

"messages": [ # Optional. The collection of rich messages corresponding to the

1981

# `Response` field in the Dialogflow console.

1982

{ # A rich response message.

1983

# Corresponds to the intent `Response` field in the Dialogflow console.

1984

# For more information, see

1985

# [Rich response

1986

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1987

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1988

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1989

"mediaObjects": [ # Required. List of media objects.

1990

{ # Response media object for media content card.

1991

"name": "A String", # Required. Name of media card.

1992

"description": "A String", # Optional. Description of media card.

1993

"contentUrl": "A String", # Required. Url where the media is stored.

1994

"icon": { # The image response message. # Optional. Icon to display above media content.

1995

"imageUri": "A String", # Optional. The public URI to an image file.

1996

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

1997

# e.g., screen readers.

1998

},

1999

"largeImage": { # The image response message. # Optional. Image to display above media content.

2000

"imageUri": "A String", # Optional. The public URI to an image file.

2001

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2002

# e.g., screen readers.

},

},

],

},

"image": { # The image response message. # The image response.

2008

"imageUri": "A String", # Optional. The public URI to an image file.

2009

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2010

# e.g., screen readers.

2011

},

2012

"payload": { # A custom platform-specific response.

2013

"a_key": "", # Properties of the object.

2014

},

2015

"text": { # The text response message. # The text response.

2016

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2021

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

2022

"suggestions": [ # Required. The list of suggested replies.

2023

{ # The suggestion chip message that the user can tap to quickly post a reply

2024

# to the conversation.

2025

"title": "A String", # Required. The text shown the in the suggestion chip.

2026

},

2027

],

2028

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2029

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2030

"subtitle": "A String", # Optional. Subtitle of the list.

2031

"items": [ # Required. List items.

2032

{ # An item in the list.

2033

"title": "A String", # Required. The title of the list item.

2034

"image": { # The image response message. # Optional. The image to display.

2035

"imageUri": "A String", # Optional. The public URI to an image file.

2036

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2037

# e.g., screen readers.

2038

},

2039

"description": "A String", # Optional. The main text describing the item.

2040

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2041

# dialog.

2042

"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.

},

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2051

"title": "A String", # Optional. The overall title of the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2052

},

2053

"quickReplies": { # The quick replies response message. # The quick replies response.

2054

"title": "A String", # Optional. The title of the collection of quick replies.

2055

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"card": { # The card response message. # The card response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2060

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2061

"title": "A String", # Optional. The title of the card.

2062

"buttons": [ # Optional. The collection of card buttons.

2063

{ # Contains information about a button.

2064

"text": "A String", # Optional. The text to show on the button.

2065

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2070

},

2071

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

2072

"title": "A String", # Optional. The title of the card.

2073

"image": { # The image response message. # Optional. The image for the card.

2074

"imageUri": "A String", # Optional. The public URI to an image file.

2075

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2076

# e.g., screen readers.

2077

},

2078

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2079

"buttons": [ # Optional. The collection of card buttons.

2080

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2081

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2082

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2083

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2084

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2085

},

2086

],

2087

"subtitle": "A String", # Optional. The subtitle of the card.

2088

},

2089

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2090

"title": "A String", # Required. Title of the card.

2091

"rows": [ # Optional. Rows in this table of data.

2092

{ # Row of TableCard.

2093

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2094

"cells": [ # Optional. List of cells that make up this row.

2095

{ # Cell of TableCardRow.

2096

"text": "A String", # Required. Text in this cell.

},

],

},

],

"subtitle": "A String", # Optional. Subtitle to the title.

2102

"columnProperties": [ # Optional. Display properties for the columns in this table.

2103

{ # Column properties for TableCard.

2104

"header": "A String", # Required. Column heading.

2105

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2106

},

2107

],

2108

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2109

"imageUri": "A String", # Optional. The public URI to an image file.

2110

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2111

# e.g., screen readers.

2112

},

2113

"buttons": [ # Optional. List of buttons for the card.

2114

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2115

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2116

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2117

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2118

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

2123

"items": [ # Required. Carousel items.

2124

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2125

"description": "A String", # Optional. The body text of the card.

2126

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2127

# dialog.

2128

"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

2133

# response is given.

2134

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2135

"title": "A String", # Required. Title of the carousel item.

2136

"image": { # The image response message. # Optional. The image to display.

2137

"imageUri": "A String", # Optional. The public URI to an image file.

2138

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2139

# e.g., screen readers.

2140

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

2145

# or website associated with this agent.

2146

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2147

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2148

# suggestion chip.

2149

},

2150

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2151

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2152

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2153

# items, maximum of ten.

2154

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2155

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2156

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2157

# the URL. Defaults to opening via web browser.

2158

"url": "A String", # Required. URL

2159

},

2160

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2161

# Card. Maximum of one line of text.

2162

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2163

"image": { # The image response message. # Optional. Hero image for the carousel item.

2164

"imageUri": "A String", # Optional. The public URI to an image file.

2165

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2166

# e.g., screen readers.

2167

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2168

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2169

# text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2170

},

2171

],

2172

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2173

# items.

2174

},

2175

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

2176

# This message in `QueryResult.fulfillment_messages` and

2177

# `WebhookResponse.fulfillment_messages` should contain only one

2178

# `SimpleResponse`.

2179

"simpleResponses": [ # Required. The list of simple responses.

2180

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2181

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2182

# speech output. Mutually exclusive with ssml.

2183

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2184

# response to the user in the SSML format. Mutually exclusive with

2185

# text_to_speech.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2186

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2187

},

2188

],

2189

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2190

},

2191

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2192

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2193

"inputContextNames": [ # Optional. The list of context names required for this intent to be

2194

# triggered.

2195

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2196

"A String",

2197

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2198

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

2199

# a direct or indirect parent. We populate this field only in the output.

2200

{ # Represents a single followup intent in the chain.

2201

"followupIntentName": "A String", # The unique identifier of the followup intent.

2202

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2203

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2204

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2205

},

2206

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2207

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

2208

# followup intents. It identifies the correct followup intents chain for

2209

# this intent. We populate this field only in the output.

2210

#

2211

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2212

"displayName": "A String", # Required. The name of this intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2213

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2214

# Note: If `ml_disabled` setting is set to true, then this intent is not

2215

# taken into account during inference in `ML ONLY` match mode. Also,

2216

# auto-markup in the UI is turned off.

2217

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2218

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2219

# trained on.

2220

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2221

"name": "A String", # Output only. The unique identifier of this training phrase.

2222

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

2223

# the intent. Each time a developer adds an existing sample by editing an

2224

# intent or training, this counter is increased.

2225

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2226

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2227

# The parts are concatenated in order to form the training phrase.

2228

#

2229

# Note: The API does not automatically annotate training phrases like the

2230

# Dialogflow Console does.

2231

#

2232

# Note: Do not forget to include whitespace at part boundaries,

2233

# so the training phrase is well formatted when the parts are concatenated.

2234

#

2235

# If the training phrase does not need to be annotated with parameters,

2236

# you just need a single part with only the Part.text field set.

2237

#

2238

# If you want to annotate the training phrase, you must create multiple

2239

# parts, where the fields of each part are populated in one of two ways:

2240

#

2241

# - `Part.text` is set to a part of the phrase that has no parameters.

2242

# - `Part.text` is set to a part of the phrase that you want to annotate,

2243

# and the `entity_type`, `alias`, and `user_defined` fields are all

2244

# set.

2245

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2246

"text": "A String", # Required. The text for this part.

2247

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2248

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2249

"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]

2250

# annotated part of the example.

2251

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2252

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2253

# This field is set to true when the Dialogflow Console is used to

2254

# manually annotate the part. When creating an annotated part with the

2255

# API, you must set this to true.

2256

},

2257

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2258

},

2259

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2260

"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]

2261

# session when this intent is matched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2262

"parameters": [ # Optional. The collection of parameters associated with the intent.

2263

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2264

"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]

2265

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2266

# - a constant string,

2267

# - a parameter value defined as `$parameter_name`,

2268

# - an original parameter value defined as `$parameter_name.original`,

2269

# - a parameter value from some context defined as

2270

# `#context_name.parameter_name`.

2271

"displayName": "A String", # Required. The name of the parameter.

2272

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

2273

# describes values of the parameter. If the parameter is

2274

# required, this must be provided.

2275

"prompts": [ # Optional. The collection of prompts that the agent can present to the

2276

# user in order to collect a value for the parameter.

2277

"A String",

2278

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2279

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

2280

# whether the intent cannot be completed without collecting the parameter

2281

# value.

2282

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

2283

# result.

2284

# Default values can be extracted from contexts by using the following

2285

# syntax: `#context_name.parameter_name`.

2286

"name": "A String", # The unique identifier of this parameter.

2287

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2288

},

2289

],

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]

2294

<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]

2295

<pre>Returns the list of all intents in the specified agent.

2296

2297

Args:

2298

parent: string, Required. The agent to list all intents from.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2299

Format: `projects/<Project ID>/agent`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2300

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]

2301

pageSize: integer, Optional. The maximum number of items to return in a single page. By

2302

default 100 and at most 1000.

2303

intentView: string, Optional. The resource view to apply to the returned intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2304

languageCode: string, Optional. The language used to access language-specific data.

2305

If not specified, the agent's default language is used.

2306

For more information, see

2307

[Multilingual intent and entity

2308

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2309

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2316

2317

{ # The response message for Intents.ListIntents.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2318

"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]

2319

# returned based on the page_size field in the request.

2320

{ # Represents an intent.

2321

# Intents convert a number of user expressions or patterns into an action. An

2322

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2323

"events": [ # Optional. The collection of event names that trigger the intent.

2324

# If the collection of input contexts is not empty, all of the contexts must

2325

# be present in the active user session for an event to trigger this intent.

2326

# Event names are limited to 150 characters.

2327

"A String",

2328

],

2329

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

2330

# chain of followup intents. You can set this field when creating an intent,

2331

# for example with CreateIntent or

2332

# BatchUpdateIntents, in order to make this

2333

# intent a followup intent.

2334

#

2335

# It identifies the parent followup intent.

2336

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2337

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

2338

# priorities.

2339

#

2340

# - If the supplied value is unspecified or 0, the service

2341

# translates the value to 500,000, which corresponds to the

2342

# `Normal` priority in the console.

2343

# - If the supplied value is negative, the intent is ignored

2344

# in runtime detect intent requests.

2345

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

2346

# is matched. Context messages in this collection should not set the

2347

# parameters field. Setting the `lifespan_count` to 0 will reset the context

2348

# when the intent is matched.

2349

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2350

{ # Represents a context.

2351

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

2352

# context expires. The default is `0`. If set to `0`, the context expires

2353

# immediately. Contexts expire automatically after 20 minutes if there

2354

# are no matching queries.

2355

"name": "A String", # Required. The unique identifier of the context. Format:

2356

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

2357

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

2358

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

2359

#

2360

# The `Context ID` is always converted to lowercase, may only contain

2361

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2362

#

2363

# If `Environment ID` is not specified, we assume default 'draft'

2364

# environment. If `User ID` is not specified, we assume default '-' user.

2365

#

2366

# The following context names are reserved for internal use by Dialogflow.

2367

# You should not use these contexts or create contexts with these names:

2368

#

2369

# * `__system_counters__`

2370

# * `*_id_dialog_context`

2371

# * `*_dialog_params_size`

2372

"parameters": { # Optional. The collection of parameters associated with this context.

2373

#

2374

# Depending on your protocol or client library language, this is a

2375

# map, associative array, symbol table, dictionary, or JSON object

2376

# composed of a collection of (MapKey, MapValue) pairs:

2377

#

2378

# - MapKey type: string

2379

# - MapKey value: parameter name

2380

# - MapValue type:

2381

# - If parameter's entity type is a composite entity: map

2382

# - Else: string or number, depending on parameter value type

2383

# - MapValue value:

2384

# - If parameter's entity type is a composite entity:

2385

# map from composite entity property names to property values

2386

# - Else: parameter value

2387

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2392

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2393

"A String",

2394

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2395

"action": "A String", # Optional. The name of the action associated with the intent.

2396

# Note: The action name must not contain whitespaces.

2397

"name": "A String", # Optional. The unique identifier of this intent.

2398

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2399

# methods.

2400

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2401

"messages": [ # Optional. The collection of rich messages corresponding to the

2402

# `Response` field in the Dialogflow console.

2403

{ # A rich response message.

2404

# Corresponds to the intent `Response` field in the Dialogflow console.

2405

# For more information, see

2406

# [Rich response

2407

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2408

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2409

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2410

"mediaObjects": [ # Required. List of media objects.

2411

{ # Response media object for media content card.

2412

"name": "A String", # Required. Name of media card.

2413

"description": "A String", # Optional. Description of media card.

2414

"contentUrl": "A String", # Required. Url where the media is stored.

2415

"icon": { # The image response message. # Optional. Icon to display above media content.

2416

"imageUri": "A String", # Optional. The public URI to an image file.

2417

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2418

# e.g., screen readers.

2419

},

2420

"largeImage": { # The image response message. # Optional. Image to display above media content.

2421

"imageUri": "A String", # Optional. The public URI to an image file.

2422

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2423

# e.g., screen readers.

},

},

],

},

"image": { # The image response message. # The image response.

2429

"imageUri": "A String", # Optional. The public URI to an image file.

2430

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2431

# e.g., screen readers.

2432

},

2433

"payload": { # A custom platform-specific response.

2434

"a_key": "", # Properties of the object.

2435

},

2436

"text": { # The text response message. # The text response.

2437

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2442

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

2443

"suggestions": [ # Required. The list of suggested replies.

2444

{ # The suggestion chip message that the user can tap to quickly post a reply

2445

# to the conversation.

2446

"title": "A String", # Required. The text shown the in the suggestion chip.

2447

},

2448

],

2449

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2450

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

"subtitle": "A String", # Optional. Subtitle of the list.

2452

"items": [ # Required. List items.

2453

{ # An item in the list.

2454

"title": "A String", # Required. The title of the list item.

2455

"image": { # The image response message. # Optional. The image to display.

2456

"imageUri": "A String", # Optional. The public URI to an image file.

2457

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2458

# e.g., screen readers.

2459

},

2460

"description": "A String", # Optional. The main text describing the item.

2461

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2462

# dialog.

2463

"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.

},

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2472

"title": "A String", # Optional. The overall title of the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2473

},

2474

"quickReplies": { # The quick replies response message. # The quick replies response.

2475

"title": "A String", # Optional. The title of the collection of quick replies.

2476

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"card": { # The card response message. # The card response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2481

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2482

"title": "A String", # Optional. The title of the card.

2483

"buttons": [ # Optional. The collection of card buttons.

2484

{ # Contains information about a button.

2485

"text": "A String", # Optional. The text to show on the button.

2486

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2491

},

2492

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

2493

"title": "A String", # Optional. The title of the card.

2494

"image": { # The image response message. # Optional. The image for the card.

2495

"imageUri": "A String", # Optional. The public URI to an image file.

2496

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2497

# e.g., screen readers.

2498

},

2499

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2500

"buttons": [ # Optional. The collection of card buttons.

2501

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2502

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2503

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2504

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2505

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2506

},

2507

],

2508

"subtitle": "A String", # Optional. The subtitle of the card.

2509

},

2510

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2511

"title": "A String", # Required. Title of the card.

2512

"rows": [ # Optional. Rows in this table of data.

2513

{ # Row of TableCard.

2514

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2515

"cells": [ # Optional. List of cells that make up this row.

2516

{ # Cell of TableCardRow.

2517

"text": "A String", # Required. Text in this cell.

},

],

},

],

"subtitle": "A String", # Optional. Subtitle to the title.

2523

"columnProperties": [ # Optional. Display properties for the columns in this table.

2524

{ # Column properties for TableCard.

2525

"header": "A String", # Required. Column heading.

2526

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2527

},

2528

],

2529

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2530

"imageUri": "A String", # Optional. The public URI to an image file.

2531

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2532

# e.g., screen readers.

2533

},

2534

"buttons": [ # Optional. List of buttons for the card.

2535

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2536

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2537

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2538

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2539

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

2544

"items": [ # Required. Carousel items.

2545

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2546

"description": "A String", # Optional. The body text of the card.

2547

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2548

# dialog.

2549

"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

2554

# response is given.

2555

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2556

"title": "A String", # Required. Title of the carousel item.

2557

"image": { # The image response message. # Optional. The image to display.

2558

"imageUri": "A String", # Optional. The public URI to an image file.

2559

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2560

# e.g., screen readers.

2561

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

2566

# or website associated with this agent.

2567

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2568

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2569

# suggestion chip.

2570

},

2571

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2572

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2573

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2574

# items, maximum of ten.

2575

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2576

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2577

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2578

# the URL. Defaults to opening via web browser.

2579

"url": "A String", # Required. URL

2580

},

2581

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2582

# Card. Maximum of one line of text.

2583

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2584

"image": { # The image response message. # Optional. Hero image for the carousel item.

2585

"imageUri": "A String", # Optional. The public URI to an image file.

2586

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2587

# e.g., screen readers.

2588

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2589

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2590

# text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2591

},

2592

],

2593

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2594

# items.

2595

},

2596

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

2597

# This message in `QueryResult.fulfillment_messages` and

2598

# `WebhookResponse.fulfillment_messages` should contain only one

2599

# `SimpleResponse`.

2600

"simpleResponses": [ # Required. The list of simple responses.

2601

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2602

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2603

# speech output. Mutually exclusive with ssml.

2604

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2605

# response to the user in the SSML format. Mutually exclusive with

2606

# text_to_speech.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2607

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2608

},

2609

],

2610

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2611

},

2612

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2613

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2614

"inputContextNames": [ # Optional. The list of context names required for this intent to be

2615

# triggered.

2616

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2617

"A String",

2618

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2619

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

2620

# a direct or indirect parent. We populate this field only in the output.

2621

{ # Represents a single followup intent in the chain.

2622

"followupIntentName": "A String", # The unique identifier of the followup intent.

2623

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2624

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2625

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2626

},

2627

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2628

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

2629

# followup intents. It identifies the correct followup intents chain for

2630

# this intent. We populate this field only in the output.

2631

#

2632

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2633

"displayName": "A String", # Required. The name of this intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2634

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2635

# Note: If `ml_disabled` setting is set to true, then this intent is not

2636

# taken into account during inference in `ML ONLY` match mode. Also,

2637

# auto-markup in the UI is turned off.

2638

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2639

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2640

# trained on.

2641

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2642

"name": "A String", # Output only. The unique identifier of this training phrase.

2643

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

2644

# the intent. Each time a developer adds an existing sample by editing an

2645

# intent or training, this counter is increased.

2646

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2647

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2648

# The parts are concatenated in order to form the training phrase.

2649

#

2650

# Note: The API does not automatically annotate training phrases like the

2651

# Dialogflow Console does.

2652

#

2653

# Note: Do not forget to include whitespace at part boundaries,

2654

# so the training phrase is well formatted when the parts are concatenated.

2655

#

2656

# If the training phrase does not need to be annotated with parameters,

2657

# you just need a single part with only the Part.text field set.

2658

#

2659

# If you want to annotate the training phrase, you must create multiple

2660

# parts, where the fields of each part are populated in one of two ways:

2661

#

2662

# - `Part.text` is set to a part of the phrase that has no parameters.

2663

# - `Part.text` is set to a part of the phrase that you want to annotate,

2664

# and the `entity_type`, `alias`, and `user_defined` fields are all

2665

# set.

2666

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2667

"text": "A String", # Required. The text for this part.

2668

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2669

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2670

"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]

2671

# annotated part of the example.

2672

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2673

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2674

# This field is set to true when the Dialogflow Console is used to

2675

# manually annotate the part. When creating an annotated part with the

2676

# API, you must set this to true.

2677

},

2678

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2679

},

2680

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2681

"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]

2682

# session when this intent is matched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2683

"parameters": [ # Optional. The collection of parameters associated with the intent.

2684

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2685

"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]

2686

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2687

# - a constant string,

2688

# - a parameter value defined as `$parameter_name`,

2689

# - an original parameter value defined as `$parameter_name.original`,

2690

# - a parameter value from some context defined as

2691

# `#context_name.parameter_name`.

2692

"displayName": "A String", # Required. The name of the parameter.

2693

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

2694

# describes values of the parameter. If the parameter is

2695

# required, this must be provided.

2696

"prompts": [ # Optional. The collection of prompts that the agent can present to the

2697

# user in order to collect a value for the parameter.

2698

"A String",

2699

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2700

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

2701

# whether the intent cannot be completed without collecting the parameter

2702

# value.

2703

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

2704

# result.

2705

# Default values can be extracted from contexts by using the following

2706

# syntax: `#context_name.parameter_name`.

2707

"name": "A String", # The unique identifier of this parameter.

2708

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2709

},

2710

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2711

},

2712

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2713

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

2714

# more results in the list.

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>

2720

<pre>Retrieves the next page of results.

2721

2722

Args:

2723

previous_request: The request for the previous page. (required)

2724

previous_response: The response from the request for the previous page. (required)

2725

2726

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2727

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]

2728

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]

2733

<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]

2734

<pre>Updates the specified intent.

2735

2736

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2737

name: string, Optional. The unique identifier of this intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2738

Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2739

methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2740

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

2741

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2742

The object takes the form of:

2743

2744

{ # Represents an intent.

2745

# Intents convert a number of user expressions or patterns into an action. An

2746

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2747

"events": [ # Optional. The collection of event names that trigger the intent.

2748

# If the collection of input contexts is not empty, all of the contexts must

2749

# be present in the active user session for an event to trigger this intent.

2750

# Event names are limited to 150 characters.

2751

"A String",

2752

],

2753

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

2754

# chain of followup intents. You can set this field when creating an intent,

2755

# for example with CreateIntent or

2756

# BatchUpdateIntents, in order to make this

2757

# intent a followup intent.

2758

#

2759

# It identifies the parent followup intent.

2760

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2761

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

2762

# priorities.

2763

#

2764

# - If the supplied value is unspecified or 0, the service

2765

# translates the value to 500,000, which corresponds to the

2766

# `Normal` priority in the console.

2767

# - If the supplied value is negative, the intent is ignored

2768

# in runtime detect intent requests.

2769

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

2770

# is matched. Context messages in this collection should not set the

2771

# parameters field. Setting the `lifespan_count` to 0 will reset the context

2772

# when the intent is matched.

2773

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2774

{ # Represents a context.

2775

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

2776

# context expires. The default is `0`. If set to `0`, the context expires

2777

# immediately. Contexts expire automatically after 20 minutes if there

2778

# are no matching queries.

2779

"name": "A String", # Required. The unique identifier of the context. Format:

2780

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

2781

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

2782

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

2783

#

2784

# The `Context ID` is always converted to lowercase, may only contain

2785

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2786

#

2787

# If `Environment ID` is not specified, we assume default 'draft'

2788

# environment. If `User ID` is not specified, we assume default '-' user.

2789

#

2790

# The following context names are reserved for internal use by Dialogflow.

2791

# You should not use these contexts or create contexts with these names:

2792

#

2793

# * `__system_counters__`

2794

# * `*_id_dialog_context`

2795

# * `*_dialog_params_size`

2796

"parameters": { # Optional. The collection of parameters associated with this context.

2797

#

2798

# Depending on your protocol or client library language, this is a

2799

# map, associative array, symbol table, dictionary, or JSON object

2800

# composed of a collection of (MapKey, MapValue) pairs:

2801

#

2802

# - MapKey type: string

2803

# - MapKey value: parameter name

2804

# - MapValue type:

2805

# - If parameter's entity type is a composite entity: map

2806

# - Else: string or number, depending on parameter value type

2807

# - MapValue value:

2808

# - If parameter's entity type is a composite entity:

2809

# map from composite entity property names to property values

2810

# - Else: parameter value

2811

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2816

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2817

"A String",

2818

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2819

"action": "A String", # Optional. The name of the action associated with the intent.

2820

# Note: The action name must not contain whitespaces.

2821

"name": "A String", # Optional. The unique identifier of this intent.

2822

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2823

# methods.

2824

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2825

"messages": [ # Optional. The collection of rich messages corresponding to the

2826

# `Response` field in the Dialogflow console.

2827

{ # A rich response message.

2828

# Corresponds to the intent `Response` field in the Dialogflow console.

2829

# For more information, see

2830

# [Rich response

2831

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2832

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2833

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2834

"mediaObjects": [ # Required. List of media objects.

2835

{ # Response media object for media content card.

2836

"name": "A String", # Required. Name of media card.

2837

"description": "A String", # Optional. Description of media card.

2838

"contentUrl": "A String", # Required. Url where the media is stored.

2839

"icon": { # The image response message. # Optional. Icon to display above media content.

2840

"imageUri": "A String", # Optional. The public URI to an image file.

2841

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2842

# e.g., screen readers.

2843

},

2844

"largeImage": { # The image response message. # Optional. Image to display above media content.

2845

"imageUri": "A String", # Optional. The public URI to an image file.

2846

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2847

# e.g., screen readers.

},

},

],

},

"image": { # The image response message. # The image response.

2853

"imageUri": "A String", # Optional. The public URI to an image file.

2854

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2855

# e.g., screen readers.

2856

},

2857

"payload": { # A custom platform-specific response.

2858

"a_key": "", # Properties of the object.

2859

},

2860

"text": { # The text response message. # The text response.

2861

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2866

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

2867

"suggestions": [ # Required. The list of suggested replies.

2868

{ # The suggestion chip message that the user can tap to quickly post a reply

2869

# to the conversation.

2870

"title": "A String", # Required. The text shown the in the suggestion chip.

2871

},

2872

],

2873

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2874

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2875

"subtitle": "A String", # Optional. Subtitle of the list.

2876

"items": [ # Required. List items.

2877

{ # An item in the list.

2878

"title": "A String", # Required. The title of the list item.

2879

"image": { # The image response message. # Optional. The image to display.

2880

"imageUri": "A String", # Optional. The public URI to an image file.

2881

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2882

# e.g., screen readers.

2883

},

2884

"description": "A String", # Optional. The main text describing the item.

2885

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2886

# dialog.

2887

"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.

},

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2896

"title": "A String", # Optional. The overall title of the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2897

},

2898

"quickReplies": { # The quick replies response message. # The quick replies response.

2899

"title": "A String", # Optional. The title of the collection of quick replies.

2900

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"card": { # The card response message. # The card response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2905

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2906

"title": "A String", # Optional. The title of the card.

2907

"buttons": [ # Optional. The collection of card buttons.

2908

{ # Contains information about a button.

2909

"text": "A String", # Optional. The text to show on the button.

2910

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2915

},

2916

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

2917

"title": "A String", # Optional. The title of the card.

2918

"image": { # The image response message. # Optional. The image for the card.

2919

"imageUri": "A String", # Optional. The public URI to an image file.

2920

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2921

# e.g., screen readers.

2922

},

2923

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2924

"buttons": [ # Optional. The collection of card buttons.

2925

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2926

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2927

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2928

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2929

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2930

},

2931

],

2932

"subtitle": "A String", # Optional. The subtitle of the card.

2933

},

2934

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2935

"title": "A String", # Required. Title of the card.

2936

"rows": [ # Optional. Rows in this table of data.

2937

{ # Row of TableCard.

2938

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2939

"cells": [ # Optional. List of cells that make up this row.

2940

{ # Cell of TableCardRow.

2941

"text": "A String", # Required. Text in this cell.

},

],

},

],

"subtitle": "A String", # Optional. Subtitle to the title.

2947

"columnProperties": [ # Optional. Display properties for the columns in this table.

2948

{ # Column properties for TableCard.

2949

"header": "A String", # Required. Column heading.

2950

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2951

},

2952

],

2953

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2954

"imageUri": "A String", # Optional. The public URI to an image file.

2955

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2956

# e.g., screen readers.

2957

},

2958

"buttons": [ # Optional. List of buttons for the card.

2959

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2960

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2961

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2962

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2963

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

2968

"items": [ # Required. Carousel items.

2969

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2970

"description": "A String", # Optional. The body text of the card.

2971

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2972

# dialog.

2973

"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

2978

# response is given.

2979

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2980

"title": "A String", # Required. Title of the carousel item.

2981

"image": { # The image response message. # Optional. The image to display.

2982

"imageUri": "A String", # Optional. The public URI to an image file.

2983

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

2984

# e.g., screen readers.

2985

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

2990

# or website associated with this agent.

2991

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2992

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2993

# suggestion chip.

2994

},

2995

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2996

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2997

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2998

# items, maximum of ten.

2999

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3000

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

3001

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

3002

# the URL. Defaults to opening via web browser.

3003

"url": "A String", # Required. URL

3004

},

3005

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

3006

# Card. Maximum of one line of text.

3007

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

3008

"image": { # The image response message. # Optional. Hero image for the carousel item.

3009

"imageUri": "A String", # Optional. The public URI to an image file.

3010

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3011

# e.g., screen readers.

3012

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3013

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

3014

# text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3015

},

3016

],

3017

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

3018

# items.

3019

},

3020

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

3021

# This message in `QueryResult.fulfillment_messages` and

3022

# `WebhookResponse.fulfillment_messages` should contain only one

3023

# `SimpleResponse`.

3024

"simpleResponses": [ # Required. The list of simple responses.

3025

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3026

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

3027

# speech output. Mutually exclusive with ssml.

3028

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

3029

# response to the user in the SSML format. Mutually exclusive with

3030

# text_to_speech.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3031

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3032

},

3033

],

3034

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3035

},

3036

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3037

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3038

"inputContextNames": [ # Optional. The list of context names required for this intent to be

3039

# triggered.

3040

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3041

"A String",

3042

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3043

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

3044

# a direct or indirect parent. We populate this field only in the output.

3045

{ # Represents a single followup intent in the chain.

3046

"followupIntentName": "A String", # The unique identifier of the followup intent.

3047

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3048

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

3049

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3050

},

3051

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3052

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

3053

# followup intents. It identifies the correct followup intents chain for

3054

# this intent. We populate this field only in the output.

3055

#

3056

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3057

"displayName": "A String", # Required. The name of this intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3058

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

3059

# Note: If `ml_disabled` setting is set to true, then this intent is not

3060

# taken into account during inference in `ML ONLY` match mode. Also,

3061

# auto-markup in the UI is turned off.

3062

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

3063

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3064

# trained on.

3065

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3066

"name": "A String", # Output only. The unique identifier of this training phrase.

3067

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

3068

# the intent. Each time a developer adds an existing sample by editing an

3069

# intent or training, this counter is increased.

3070

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3071

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3072

# The parts are concatenated in order to form the training phrase.

3073

#

3074

# Note: The API does not automatically annotate training phrases like the

3075

# Dialogflow Console does.

3076

#

3077

# Note: Do not forget to include whitespace at part boundaries,

3078

# so the training phrase is well formatted when the parts are concatenated.

3079

#

3080

# If the training phrase does not need to be annotated with parameters,

3081

# you just need a single part with only the Part.text field set.

3082

#

3083

# If you want to annotate the training phrase, you must create multiple

3084

# parts, where the fields of each part are populated in one of two ways:

3085

#

3086

# - `Part.text` is set to a part of the phrase that has no parameters.

3087

# - `Part.text` is set to a part of the phrase that you want to annotate,

3088

# and the `entity_type`, `alias`, and `user_defined` fields are all

3089

# set.

3090

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3091

"text": "A String", # Required. The text for this part.

3092

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3093

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3094

"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]

3095

# annotated part of the example.

3096

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3097

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3098

# This field is set to true when the Dialogflow Console is used to

3099

# manually annotate the part. When creating an annotated part with the

3100

# API, you must set this to true.

3101

},

3102

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3103

},

3104

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3105

"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]

3106

# session when this intent is matched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3107

"parameters": [ # Optional. The collection of parameters associated with the intent.

3108

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3109

"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]

3110

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3111

# - a constant string,

3112

# - a parameter value defined as `$parameter_name`,

3113

# - an original parameter value defined as `$parameter_name.original`,

3114

# - a parameter value from some context defined as

3115

# `#context_name.parameter_name`.

3116

"displayName": "A String", # Required. The name of the parameter.

3117

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3118

# describes values of the parameter. If the parameter is

3119

# required, this must be provided.

3120

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3121

# user in order to collect a value for the parameter.

3122

"A String",

3123

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3124

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3125

# whether the intent cannot be completed without collecting the parameter

3126

# value.

3127

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3128

# result.

3129

# Default values can be extracted from contexts by using the following

3130

# syntax: `#context_name.parameter_name`.

3131

"name": "A String", # The unique identifier of this parameter.

3132

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3133

},

3134

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3135

}

3136

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3137

intentView: string, Optional. The resource view to apply to the returned intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3138

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3139

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3140

For more information, see

3141

[Multilingual intent and entity

3142

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3143

updateMask: string, Optional. The mask to control which fields get updated.

3144

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3151

3152

{ # Represents an intent.

3153

# Intents convert a number of user expressions or patterns into an action. An

3154

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3155

"events": [ # Optional. The collection of event names that trigger the intent.

3156

# If the collection of input contexts is not empty, all of the contexts must

3157

# be present in the active user session for an event to trigger this intent.

3158

# Event names are limited to 150 characters.

3159

"A String",

3160

],

3161

"parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the

3162

# chain of followup intents. You can set this field when creating an intent,

3163

# for example with CreateIntent or

3164

# BatchUpdateIntents, in order to make this

3165

# intent a followup intent.

3166

#

3167

# It identifies the parent followup intent.

3168

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3169

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

3170

# priorities.

3171

#

3172

# - If the supplied value is unspecified or 0, the service

3173

# translates the value to 500,000, which corresponds to the

3174

# `Normal` priority in the console.

3175

# - If the supplied value is negative, the intent is ignored

3176

# in runtime detect intent requests.

3177

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3178

# is matched. Context messages in this collection should not set the

3179

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3180

# when the intent is matched.

3181

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3182

{ # Represents a context.

3183

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3184

# context expires. The default is `0`. If set to `0`, the context expires

3185

# immediately. Contexts expire automatically after 20 minutes if there

3186

# are no matching queries.

3187

"name": "A String", # Required. The unique identifier of the context. Format:

3188

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3189

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3190

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3191

#

3192

# The `Context ID` is always converted to lowercase, may only contain

3193

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3194

#

3195

# If `Environment ID` is not specified, we assume default 'draft'

3196

# environment. If `User ID` is not specified, we assume default '-' user.

3197

#

3198

# The following context names are reserved for internal use by Dialogflow.

3199

# You should not use these contexts or create contexts with these names:

3200

#

3201

# * `__system_counters__`

3202

# * `*_id_dialog_context`

3203

# * `*_dialog_params_size`

3204

"parameters": { # Optional. The collection of parameters associated with this context.

3205

#

3206

# Depending on your protocol or client library language, this is a

3207

# map, associative array, symbol table, dictionary, or JSON object

3208

# composed of a collection of (MapKey, MapValue) pairs:

3209

#

3210

# - MapKey type: string

3211

# - MapKey value: parameter name

3212

# - MapValue type:

3213

# - If parameter's entity type is a composite entity: map

3214

# - Else: string or number, depending on parameter value type

3215

# - MapValue value:

3216

# - If parameter's entity type is a composite entity:

3217

# map from composite entity property names to property values

3218

# - Else: parameter value

3219

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3224

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3225

"A String",

3226

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3227

"action": "A String", # Optional. The name of the action associated with the intent.

3228

# Note: The action name must not contain whitespaces.

3229

"name": "A String", # Optional. The unique identifier of this intent.

3230

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

3231

# methods.

3232

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3233

"messages": [ # Optional. The collection of rich messages corresponding to the

3234

# `Response` field in the Dialogflow console.

3235

{ # A rich response message.

3236

# Corresponds to the intent `Response` field in the Dialogflow console.

3237

# For more information, see

3238

# [Rich response

3239

# messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3240

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

3241

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

3242

"mediaObjects": [ # Required. List of media objects.

3243

{ # Response media object for media content card.

3244

"name": "A String", # Required. Name of media card.

3245

"description": "A String", # Optional. Description of media card.

3246

"contentUrl": "A String", # Required. Url where the media is stored.

3247

"icon": { # The image response message. # Optional. Icon to display above media content.

3248

"imageUri": "A String", # Optional. The public URI to an image file.

3249

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3250

# e.g., screen readers.

3251

},

3252

"largeImage": { # The image response message. # Optional. Image to display above media content.

3253

"imageUri": "A String", # Optional. The public URI to an image file.

3254

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3255

# e.g., screen readers.

},

},

],

},

"image": { # The image response message. # The image response.

3261

"imageUri": "A String", # Optional. The public URI to an image file.

3262

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3263

# e.g., screen readers.

3264

},

3265

"payload": { # A custom platform-specific response.

3266

"a_key": "", # Properties of the object.

3267

},

3268

"text": { # The text response message. # The text response.

3269

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

3274

"suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.

3275

"suggestions": [ # Required. The list of suggested replies.

3276

{ # The suggestion chip message that the user can tap to quickly post a reply

3277

# to the conversation.

3278

"title": "A String", # Required. The text shown the in the suggestion chip.

3279

},

3280

],

3281

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3282

"listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3283

"subtitle": "A String", # Optional. Subtitle of the list.

3284

"items": [ # Required. List items.

3285

{ # An item in the list.

3286

"title": "A String", # Required. The title of the list item.

3287

"image": { # The image response message. # Optional. The image to display.

3288

"imageUri": "A String", # Optional. The public URI to an image file.

3289

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3290

# e.g., screen readers.

3291

},

3292

"description": "A String", # Optional. The main text describing the item.

3293

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3294

# dialog.

3295

"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.

},

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3304

"title": "A String", # Optional. The overall title of the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3305

},

3306

"quickReplies": { # The quick replies response message. # The quick replies response.

3307

"title": "A String", # Optional. The title of the collection of quick replies.

3308

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"card": { # The card response message. # The card response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3313

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3314

"title": "A String", # Optional. The title of the card.

3315

"buttons": [ # Optional. The collection of card buttons.

3316

{ # Contains information about a button.

3317

"text": "A String", # Optional. The text to show on the button.

3318

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3323

},

3324

"basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.

3325

"title": "A String", # Optional. The title of the card.

3326

"image": { # The image response message. # Optional. The image for the card.

3327

"imageUri": "A String", # Optional. The public URI to an image file.

3328

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3329

# e.g., screen readers.

3330

},

3331

"formattedText": "A String", # Required, unless image is present. The body text of the card.

3332

"buttons": [ # Optional. The collection of card buttons.

3333

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3334

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3335

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3336

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

3337

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3338

},

3339

],

3340

"subtitle": "A String", # Optional. The subtitle of the card.

3341

},

3342

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

3343

"title": "A String", # Required. Title of the card.

3344

"rows": [ # Optional. Rows in this table of data.

3345

{ # Row of TableCard.

3346

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

3347

"cells": [ # Optional. List of cells that make up this row.

3348

{ # Cell of TableCardRow.

3349

"text": "A String", # Required. Text in this cell.

},

],

},

],

"subtitle": "A String", # Optional. Subtitle to the title.

3355

"columnProperties": [ # Optional. Display properties for the columns in this table.

3356

{ # Column properties for TableCard.

3357

"header": "A String", # Required. Column heading.

3358

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

3359

},

3360

],

3361

"image": { # The image response message. # Optional. Image which should be displayed on the card.

3362

"imageUri": "A String", # Optional. The public URI to an image file.

3363

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3364

# e.g., screen readers.

3365

},

3366

"buttons": [ # Optional. List of buttons for the card.

3367

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3368

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3369

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3370

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

3371

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.

3376

"items": [ # Required. Carousel items.

3377

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3378

"description": "A String", # Optional. The body text of the card.

3379

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

3380

# dialog.

3381

"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

3386

# response is given.

3387

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3388

"title": "A String", # Required. Title of the carousel item.

3389

"image": { # The image response message. # Optional. The image to display.

3390

"imageUri": "A String", # Optional. The public URI to an image file.

3391

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3392

# e.g., screen readers.

3393

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.

3398

# or website associated with this agent.

3399

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

3400

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

3401

# suggestion chip.

3402

},

3403

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

3404

# https://developers.google.com/actions/assistant/responses#browsing_carousel

3405

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

3406

# items, maximum of ten.

3407

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3408

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

3409

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

3410

# the URL. Defaults to opening via web browser.

3411

"url": "A String", # Required. URL

3412

},

3413

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

3414

# Card. Maximum of one line of text.

3415

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

3416

"image": { # The image response message. # Optional. Hero image for the carousel item.

3417

"imageUri": "A String", # Optional. The public URI to an image file.

3418

"accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,

3419

# e.g., screen readers.

3420

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3421

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

3422

# text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3423

},

3424

],

3425

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

3426

# items.

3427

},

3428

"simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.

3429

# This message in `QueryResult.fulfillment_messages` and

3430

# `WebhookResponse.fulfillment_messages` should contain only one

3431

# `SimpleResponse`.

3432

"simpleResponses": [ # Required. The list of simple responses.

3433

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3434

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

3435

# speech output. Mutually exclusive with ssml.

3436

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

3437

# response to the user in the SSML format. Mutually exclusive with

3438

# text_to_speech.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3439

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3440

},

3441

],

3442

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3443

},

3444

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3445

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3446

"inputContextNames": [ # Optional. The list of context names required for this intent to be

3447

# triggered.

3448

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3449

"A String",

3450

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3451

"followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as

3452

# a direct or indirect parent. We populate this field only in the output.

3453

{ # Represents a single followup intent in the chain.

3454

"followupIntentName": "A String", # The unique identifier of the followup intent.

3455

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3456

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

3457

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3458

},

3459

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3460

"rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of

3461

# followup intents. It identifies the correct followup intents chain for

3462

# this intent. We populate this field only in the output.

3463

#

3464

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3465

"displayName": "A String", # Required. The name of this intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3466

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

3467

# Note: If `ml_disabled` setting is set to true, then this intent is not

3468

# taken into account during inference in `ML ONLY` match mode. Also,

3469

# auto-markup in the UI is turned off.

3470

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

3471

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3472

# trained on.

3473

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3474

"name": "A String", # Output only. The unique identifier of this training phrase.

3475

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

3476

# the intent. Each time a developer adds an existing sample by editing an

3477

# intent or training, this counter is increased.

3478

"type": "A String", # Required. The type of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3479

"parts": [ # Required. The ordered list of training phrase parts.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3480

# The parts are concatenated in order to form the training phrase.

3481

#

3482

# Note: The API does not automatically annotate training phrases like the

3483

# Dialogflow Console does.

3484

#

3485

# Note: Do not forget to include whitespace at part boundaries,

3486

# so the training phrase is well formatted when the parts are concatenated.

3487

#

3488

# If the training phrase does not need to be annotated with parameters,

3489

# you just need a single part with only the Part.text field set.

3490

#

3491

# If you want to annotate the training phrase, you must create multiple

3492

# parts, where the fields of each part are populated in one of two ways:

3493

#

3494

# - `Part.text` is set to a part of the phrase that has no parameters.

3495

# - `Part.text` is set to a part of the phrase that you want to annotate,

3496

# and the `entity_type`, `alias`, and `user_defined` fields are all

3497

# set.

3498

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3499

"text": "A String", # Required. The text for this part.

3500

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3501

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3502

"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]

3503

# annotated part of the example.

3504

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3505

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3506

# This field is set to true when the Dialogflow Console is used to

3507

# manually annotate the part. When creating an annotated part with the

3508

# API, you must set this to true.

3509

},

3510

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3511

},

3512

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3513

"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]

3514

# session when this intent is matched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3515

"parameters": [ # Optional. The collection of parameters associated with the intent.

3516

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3517

"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]

3518

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3519

# - a constant string,

3520

# - a parameter value defined as `$parameter_name`,

3521

# - an original parameter value defined as `$parameter_name.original`,

3522

# - a parameter value from some context defined as

3523

# `#context_name.parameter_name`.

3524

"displayName": "A String", # Required. The name of the parameter.

3525

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3526

# describes values of the parameter. If the parameter is

3527

# required, this must be provided.

3528

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3529

# user in order to collect a value for the parameter.

3530

"A String",

3531

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3532

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3533

# whether the intent cannot be completed without collecting the parameter

3534

# value.

3535

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3536

# result.

3537

# Default values can be extracted from contexts by using the following

3538

# syntax: `#context_name.parameter_name`.

3539

"name": "A String", # The unique identifier of this parameter.

3540

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3541

},

3542

],

Bu Sun Kim