Blame - docs/dyn/dialogflow_v2beta1.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, languageCode=None, pageToken=None, pageSize=None, intentView=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

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

Dan O'Meara

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

[diff] [blame]

121

# trained on.

122

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

Bu Sun Kim

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

[diff] [blame^]

123

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

Dan O'Meara

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

[diff] [blame]

124

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

125

#

126

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

127

# Dialogflow Console does.

128

#

129

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

130

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

131

#

132

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

133

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

134

#

135

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

136

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

137

#

138

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

139

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

140

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

141

# set.

142

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame^]

143

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

Dan O'Meara

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

[diff] [blame]

144

# annotated part of the example.

145

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

Bu Sun Kim

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

[diff] [blame^]

146

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

Dan O'Meara

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

[diff] [blame]

147

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

148

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

149

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

150

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

151

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

152

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

Dan O'Meara

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

[diff] [blame]

153

},

154

],

Bu Sun Kim

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

[diff] [blame^]

155

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

156

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

Dan O'Meara

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

[diff] [blame]

157

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

158

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame^]

159

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

Dan O'Meara

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

[diff] [blame]

160

},

161

],

Bu Sun Kim

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

[diff] [blame^]

162

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

163

# session when this intent is matched.

164

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

165

{ # Represents intent parameters.

166

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

167

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

168

# describes values of the parameter. If the parameter is

169

# required, this must be provided.

170

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

171

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

172

"A String",

173

],

174

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

175

# result.

176

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

177

# syntax: `#context_name.parameter_name`.

178

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

179

# whether the intent cannot be completed without collecting the parameter

180

# value.

181

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

182

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

183

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

184

#

185

# - a constant string,

186

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

187

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

188

# - a parameter value from some context defined as

189

# `#context_name.parameter_name`.

190

},

Bu Sun Kim

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

[diff] [blame]

191

],

Bu Sun Kim

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

[diff] [blame^]

192

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

193

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

194

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

195

# Event names are limited to 150 characters.

196

"A String",

197

],

198

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

199

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

200

# for example with CreateIntent or

201

# BatchUpdateIntents, in order to make this

202

# intent a followup intent.

203

#

204

# It identifies the parent followup intent.

205

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

206

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

Dan O'Meara

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

[diff] [blame]

207

# priorities.

Bu Sun Kim

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

[diff] [blame]

208

#

Dan O'Meara

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

[diff] [blame]

209

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

210

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

211

# `Normal` priority in the console.

212

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

213

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame^]

214

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

215

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

216

# to close interaction with an end user. Default is false.

217

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

218

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

219

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

220

# when the intent is matched.

221

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

222

{ # Represents a context.

223

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

224

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

225

# immediately. Contexts expire automatically after 20 minutes if there

226

# are no matching queries.

227

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

228

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

229

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

230

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

231

#

232

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

233

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

234

#

235

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

236

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

237

#

238

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

239

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

240

#

241

# * `__system_counters__`

242

# * `*_id_dialog_context`

243

# * `*_dialog_params_size`

244

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

245

#

246

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

247

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

248

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

249

#

250

# - MapKey type: string

251

# - MapKey value: parameter name

252

# - MapValue type:

253

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

254

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

255

# - MapValue value:

256

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

257

# map from composite entity property names to property values

258

# - Else: parameter value

259

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

},

},

],

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

264

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

265

"A String",

266

],

267

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

268

# `Response` field in the Dialogflow console.

269

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

270

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

271

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

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

276

#

277

# Rich cards allow you to respond to users with more vivid content, e.g.

278

# with media and suggestions.

279

#

280

# For more details about RBM rich cards, please see:

281

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

282

# If you want to show a single card with more control over the layout,

283

# please use RbmStandaloneCard instead.

284

"cardWidth": "A String", # Required. The width of the cards in the carousel.

285

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

286

# 2 cards and at most 10.

287

{ # Rich Business Messaging (RBM) Card content

288

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

289

#

290

# At least one of the title, description or media must be set.

291

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

292

# be set. Media (image, GIF or a video) to include in the card.

293

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

311

# provide a thumbnail URI, the RBM platform displays a blank

312

# placeholder thumbnail until the user's device downloads the file.

313

# Depending on the user's setting, the file may not download

314

# automatically and may require the user to tap a download button.

315

"height": "A String", # Required for cards with vertical orientation. The height of the media

316

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

317

# For a standalone card with horizontal layout, height is not

318

# customizable, and this field is ignored.

319

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

320

# determines the MIME type of the file from the content-type field in

321

# the HTTP headers when the platform fetches the file. The content-type

322

# field must be present and accurate in the HTTP response from the URL.

323

},

324

"suggestions": [ # Optional. List of suggestions to include in the card.

325

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

326

# easily select/click a predefined response or perform an action (like

327

# opening a web uri).

328

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

329

# instead of typing in their own response.

330

"text": "A String", # Suggested reply text.

331

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

332

# when the user taps the suggested reply. This data will be also

333

# forwarded to webhook to allow performing custom business logic.

334

},

335

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

336

# can choose from the card.

337

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

338

# when the user taps the suggested action. This data will be also

339

# forwarded to webhook to allow performing custom business logic.

340

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

341

# to send back to the agent (https://goo.gl/GXotJW).

342

},

343

"text": "A String", # Text to display alongside the action.

344

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

345

# (https://goo.gl/6GLJD2). If the user has an app installed that is

346

# registered as the default handler for the URL, then this app will be

347

# opened instead, and its icon will be used in the suggested action UI.

348

"uri": "A String", # Required. The uri to open on the user device

349

},

350

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

351

# but does not dial automatically (https://goo.gl/ergbB2).

352

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

353

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

354

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

361

#

362

# At least one of the title, description or media must be set.

},

],

},

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

367

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

368

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

369

# to the conversation.

370

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

},

],

},

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

375

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

376

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

377

# play, e.g., "gs://bucket/object". The object must contain a single

378

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

379

#

380

# This object must be readable by the `service-<Project

381

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

382

# where <Project Number> is the number of the Telephony Gateway project

383

# (usually the same as the Dialogflow agent project). If the Google Cloud

384

# Storage bucket is in the Telephony Gateway project, this permission is

385

# added by default when enabling the Dialogflow V2 API.

386

#

387

# For audio from other sources, consider using the

388

# `TelephonySynthesizeSpeech` message with SSML.

389

},

390

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

391

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

392

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

393

"items": [ # Required. List items.

394

{ # An item in the list.

395

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

396

# dialog.

397

"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

402

# response is given.

403

},

404

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

405

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

406

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

407

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

408

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

409

},

410

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

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

415

#

416

# RBM allows businesses to send enriched and branded versions of SMS. See

417

# https://jibe.google.com/business-messaging.

418

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

419

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

420

# easily select/click a predefined response or perform an action (like

421

# opening a web uri).

422

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

423

# instead of typing in their own response.

424

"text": "A String", # Suggested reply text.

425

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

426

# when the user taps the suggested reply. This data will be also

427

# forwarded to webhook to allow performing custom business logic.

428

},

429

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

430

# can choose from the card.

431

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

432

# when the user taps the suggested action. This data will be also

433

# forwarded to webhook to allow performing custom business logic.

434

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

435

# to send back to the agent (https://goo.gl/GXotJW).

436

},

437

"text": "A String", # Text to display alongside the action.

438

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

439

# (https://goo.gl/6GLJD2). If the user has an app installed that is

440

# registered as the default handler for the URL, then this app will be

441

# opened instead, and its icon will be used in the suggested action UI.

442

"uri": "A String", # Required. The uri to open on the user device

443

},

444

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

445

# but does not dial automatically (https://goo.gl/ergbB2).

446

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

447

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

448

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

455

},

456

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

457

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

458

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

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

463

# Telephony Gateway.

464

#

465

# Telephony Gateway takes the synthesizer settings from

466

# `DetectIntentResponse.output_audio_config` which can either be set

467

# at request-level or can come from the agent-level synthesizer config.

468

"text": "A String", # The raw text to be synthesized.

469

"ssml": "A String", # The SSML to be synthesized. For more information, see

470

# [SSML](https://developers.google.com/actions/reference/ssml).

471

},

472

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

473

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

474

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

475

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

476

{ # Optional. Contains information about a button.

477

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

478

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

483

},

484

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

485

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

486

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

487

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

488

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

489

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

490

},

491

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

492

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

493

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

494

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

495

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

496

},

497

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

498

},

499

],

500

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

501

},

502

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

503

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

504

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

505

{ # Column properties for TableCard.

506

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

507

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

508

},

509

],

510

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

511

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

512

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

513

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

514

},

515

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

516

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

517

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

518

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

519

},

520

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

521

},

522

],

523

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

524

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

525

{ # Row of TableCard.

526

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

527

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

528

{ # Cell of TableCardRow.

529

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

},

],

},

],

},

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

536

"items": [ # Required. Carousel items.

537

{ # An item in the carousel.

538

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

539

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

540

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

541

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

542

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

543

},

544

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

545

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

546

# dialog.

547

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

},

},

],

},

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

558

# or website associated with this agent.

559

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

560

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

561

# suggestion chip.

562

},

563

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

564

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

565

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

566

# items.

567

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

568

# items, maximum of ten.

569

{ # Browsing carousel tile

570

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

571

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

572

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

573

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

574

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

575

},

576

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

577

# text.

578

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

579

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

580

# the URL. Defaults to opening via web browser.

581

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

582

},

583

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

584

# Card. Maximum of one line of text.

},

],

},

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

589

# This message in `QueryResult.fulfillment_messages` and

590

# `WebhookResponse.fulfillment_messages` should contain only one

591

# `SimpleResponse`.

592

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

593

{ # The simple response message containing speech or text.

594

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

595

# speech output. Mutually exclusive with ssml.

596

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

597

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

598

# text_to_speech.

599

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

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

604

"phoneNumber": "A String", # Required. The phone number to transfer the call to

605

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

606

#

607

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

608

},

609

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

610

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

611

{ # Response media object for media content card.

612

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

613

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

614

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

615

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

616

},

617

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

618

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

619

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

620

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

621

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

622

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

623

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

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

628

},

629

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

630

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

631

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

632

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

633

},

634

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

635

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

636

},

637

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

638

#

639

# Rich cards allow you to respond to users with more vivid content, e.g.

640

# with media and suggestions.

641

#

642

# For more details about RBM rich cards, please see:

643

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

644

# You can group multiple rich cards into one using RbmCarouselCard but

645

# carousel cards will give you less control over the card layout.

646

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

647

# Image preview alignment for standalone cards with horizontal layout.

648

"cardOrientation": "A String", # Required. Orientation of the card.

649

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

650

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

651

#

652

# At least one of the title, description or media must be set.

653

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

654

# be set. Media (image, GIF or a video) to include in the card.

655

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

673

# provide a thumbnail URI, the RBM platform displays a blank

674

# placeholder thumbnail until the user's device downloads the file.

675

# Depending on the user's setting, the file may not download

676

# automatically and may require the user to tap a download button.

677

"height": "A String", # Required for cards with vertical orientation. The height of the media

678

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

679

# For a standalone card with horizontal layout, height is not

680

# customizable, and this field is ignored.

681

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

682

# determines the MIME type of the file from the content-type field in

683

# the HTTP headers when the platform fetches the file. The content-type

684

# field must be present and accurate in the HTTP response from the URL.

685

},

686

"suggestions": [ # Optional. List of suggestions to include in the card.

687

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

688

# easily select/click a predefined response or perform an action (like

689

# opening a web uri).

690

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

691

# instead of typing in their own response.

692

"text": "A String", # Suggested reply text.

693

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

694

# when the user taps the suggested reply. This data will be also

695

# forwarded to webhook to allow performing custom business logic.

696

},

697

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

698

# can choose from the card.

699

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

700

# when the user taps the suggested action. This data will be also

701

# forwarded to webhook to allow performing custom business logic.

702

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

703

# to send back to the agent (https://goo.gl/GXotJW).

704

},

705

"text": "A String", # Text to display alongside the action.

706

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

707

# (https://goo.gl/6GLJD2). If the user has an app installed that is

708

# registered as the default handler for the URL, then this app will be

709

# opened instead, and its icon will be used in the suggested action UI.

710

"uri": "A String", # Required. The uri to open on the user device

711

},

712

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

713

# but does not dial automatically (https://goo.gl/ergbB2).

714

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

715

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

716

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

723

#

724

# At least one of the title, description or media must be set.

},

},

},

],

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

730

# Note: The action name must not contain whitespaces.

731

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

732

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

733

# methods.

Dan O'Meara

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

[diff] [blame]

734

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

Bu Sun Kim

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

[diff] [blame^]

735

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

736

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

Bu Sun Kim

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

[diff] [blame]

737

# triggered.

Dan O'Meara

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

[diff] [blame]

738

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

Bu Sun Kim

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

[diff] [blame^]

739

"A String",

Bu Sun Kim

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

[diff] [blame]

740

],

Bu Sun Kim

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

[diff] [blame^]

741

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

742

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

743

{ # Represents a single followup intent in the chain.

744

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

745

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

746

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

747

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

748

},

749

],

750

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

751

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

752

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

753

# this intent.

754

#

755

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

756

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

757

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

758

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

759

# auto-markup in the UI is turned off.

760

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

761

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

Bu Sun Kim

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

[diff] [blame]

762

# Note: If `ml_enabled` setting is set to false, then this intent is not

763

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

764

# auto-markup in the UI is turned off.

765

# DEPRECATED! Please use `ml_disabled` field instead.

766

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

767

# then the default value is determined as follows:

768

# - Before April 15th, 2018 the default is:

769

# ml_enabled = false / ml_disabled = true.

770

# - After April 15th, 2018 the default is:

771

# ml_enabled = true / ml_disabled = false.

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:

783

784

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

785

# network API call.

Bu Sun Kim

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

[diff] [blame^]

786

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

787

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

788

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

789

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

790

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

791

},

792

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

793

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

794

# available.

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame^]

803

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

Dan O'Meara

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

[diff] [blame]

804

},

Bu Sun Kim

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

[diff] [blame^]

805

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

806

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

807

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

Bu Sun Kim

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

[diff] [blame^]

808

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

809

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

810

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

811

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

812

#

813

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

814

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

Bu Sun Kim

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

[diff] [blame^]

815

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

816

# message types for APIs to use.

817

{

Bu Sun Kim

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

[diff] [blame^]

818

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

Bu Sun Kim

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

[diff] [blame]

819

},

820

],

Bu Sun Kim

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

[diff] [blame^]

821

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

822

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

823

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

824

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

Bu Sun Kim

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

[diff] [blame]

825

},

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]

830

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

831

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

832

Dan O'Meara

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

[diff] [blame]

833

Operation <response: BatchUpdateIntentsResponse>

Bu Sun Kim

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

[diff] [blame]

834

835

Args:

836

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]

837

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

838

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

839

The object takes the form of:

840

841

{ # The request message for Intents.BatchUpdateIntents.

Bu Sun Kim

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

[diff] [blame^]

842

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

843

"intents": [ # A collection of intents.

Bu Sun Kim

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

[diff] [blame]

844

{ # Represents an intent.

845

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

846

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

Bu Sun Kim

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

[diff] [blame^]

847

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

Dan O'Meara

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

[diff] [blame]

848

# trained on.

849

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

Bu Sun Kim

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

[diff] [blame^]

850

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

Dan O'Meara

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

[diff] [blame]

851

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

852

#

853

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

854

# Dialogflow Console does.

855

#

856

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

857

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

858

#

859

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

860

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

861

#

862

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

863

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

864

#

865

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

866

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

867

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

868

# set.

869

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame^]

870

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

Dan O'Meara

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

[diff] [blame]

871

# annotated part of the example.

872

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

Bu Sun Kim

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

[diff] [blame^]

873

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

Dan O'Meara

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

[diff] [blame]

874

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

875

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

876

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

877

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

878

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

879

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

Dan O'Meara

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

[diff] [blame]

880

},

881

],

Bu Sun Kim

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

[diff] [blame^]

882

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

883

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

Dan O'Meara

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

[diff] [blame]

884

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

885

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame^]

886

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

Dan O'Meara

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

[diff] [blame]

887

},

888

],

Bu Sun Kim

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

[diff] [blame^]

889

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

890

# session when this intent is matched.

891

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

892

{ # Represents intent parameters.

893

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

894

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

895

# describes values of the parameter. If the parameter is

896

# required, this must be provided.

897

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

898

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

899

"A String",

900

],

901

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

902

# result.

903

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

904

# syntax: `#context_name.parameter_name`.

905

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

906

# whether the intent cannot be completed without collecting the parameter

907

# value.

908

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

909

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

910

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

911

#

912

# - a constant string,

913

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

914

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

915

# - a parameter value from some context defined as

916

# `#context_name.parameter_name`.

917

},

Bu Sun Kim

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

[diff] [blame]

918

],

Bu Sun Kim

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

[diff] [blame^]

919

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

920

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

921

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

922

# Event names are limited to 150 characters.

923

"A String",

924

],

925

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

926

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

927

# for example with CreateIntent or

928

# BatchUpdateIntents, in order to make this

929

# intent a followup intent.

930

#

931

# It identifies the parent followup intent.

932

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

933

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

Dan O'Meara

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

[diff] [blame]

934

# priorities.

Bu Sun Kim

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

[diff] [blame]

935

#

Dan O'Meara

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

[diff] [blame]

936

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

937

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

938

# `Normal` priority in the console.

939

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

940

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame^]

941

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

942

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

943

# to close interaction with an end user. Default is false.

944

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

945

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

946

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

947

# when the intent is matched.

948

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

949

{ # Represents a context.

950

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

951

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

952

# immediately. Contexts expire automatically after 20 minutes if there

953

# are no matching queries.

954

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

955

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

956

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

957

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

958

#

959

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

960

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

961

#

962

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

963

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

964

#

965

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

966

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

967

#

968

# * `__system_counters__`

969

# * `*_id_dialog_context`

970

# * `*_dialog_params_size`

971

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

972

#

973

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

974

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

975

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

976

#

977

# - MapKey type: string

978

# - MapKey value: parameter name

979

# - MapValue type:

980

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

981

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

982

# - MapValue value:

983

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

984

# map from composite entity property names to property values

985

# - Else: parameter value

986

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

},

},

],

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

991

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

992

"A String",

993

],

994

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

995

# `Response` field in the Dialogflow console.

996

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

997

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

998

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

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

1003

#

1004

# Rich cards allow you to respond to users with more vivid content, e.g.

1005

# with media and suggestions.

1006

#

1007

# For more details about RBM rich cards, please see:

1008

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

1009

# If you want to show a single card with more control over the layout,

1010

# please use RbmStandaloneCard instead.

1011

"cardWidth": "A String", # Required. The width of the cards in the carousel.

1012

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

1013

# 2 cards and at most 10.

1014

{ # Rich Business Messaging (RBM) Card content

1015

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

1016

#

1017

# At least one of the title, description or media must be set.

1018

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

1019

# be set. Media (image, GIF or a video) to include in the card.

1020

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

1038

# provide a thumbnail URI, the RBM platform displays a blank

1039

# placeholder thumbnail until the user's device downloads the file.

1040

# Depending on the user's setting, the file may not download

1041

# automatically and may require the user to tap a download button.

1042

"height": "A String", # Required for cards with vertical orientation. The height of the media

1043

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

1044

# For a standalone card with horizontal layout, height is not

1045

# customizable, and this field is ignored.

1046

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

1047

# determines the MIME type of the file from the content-type field in

1048

# the HTTP headers when the platform fetches the file. The content-type

1049

# field must be present and accurate in the HTTP response from the URL.

1050

},

1051

"suggestions": [ # Optional. List of suggestions to include in the card.

1052

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1053

# easily select/click a predefined response or perform an action (like

1054

# opening a web uri).

1055

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1056

# instead of typing in their own response.

1057

"text": "A String", # Suggested reply text.

1058

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1059

# when the user taps the suggested reply. This data will be also

1060

# forwarded to webhook to allow performing custom business logic.

1061

},

1062

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1063

# can choose from the card.

1064

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1065

# when the user taps the suggested action. This data will be also

1066

# forwarded to webhook to allow performing custom business logic.

1067

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1068

# to send back to the agent (https://goo.gl/GXotJW).

1069

},

1070

"text": "A String", # Text to display alongside the action.

1071

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1072

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1073

# registered as the default handler for the URL, then this app will be

1074

# opened instead, and its icon will be used in the suggested action UI.

1075

"uri": "A String", # Required. The uri to open on the user device

1076

},

1077

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1078

# but does not dial automatically (https://goo.gl/ergbB2).

1079

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1080

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1081

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

1088

#

1089

# At least one of the title, description or media must be set.

},

],

},

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

1094

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

1095

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

1096

# to the conversation.

1097

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

},

],

},

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

1102

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

1103

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

1104

# play, e.g., "gs://bucket/object". The object must contain a single

1105

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

1106

#

1107

# This object must be readable by the `service-<Project

1108

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

1109

# where <Project Number> is the number of the Telephony Gateway project

1110

# (usually the same as the Dialogflow agent project). If the Google Cloud

1111

# Storage bucket is in the Telephony Gateway project, this permission is

1112

# added by default when enabling the Dialogflow V2 API.

1113

#

1114

# For audio from other sources, consider using the

1115

# `TelephonySynthesizeSpeech` message with SSML.

1116

},

1117

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

1118

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

1119

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

1120

"items": [ # Required. List items.

1121

{ # An item in the list.

1122

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

1123

# dialog.

1124

"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

1129

# response is given.

1130

},

1131

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

1132

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

1133

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

1134

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

1135

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1136

},

1137

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

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

1142

#

1143

# RBM allows businesses to send enriched and branded versions of SMS. See

1144

# https://jibe.google.com/business-messaging.

1145

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

1146

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1147

# easily select/click a predefined response or perform an action (like

1148

# opening a web uri).

1149

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1150

# instead of typing in their own response.

1151

"text": "A String", # Suggested reply text.

1152

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1153

# when the user taps the suggested reply. This data will be also

1154

# forwarded to webhook to allow performing custom business logic.

1155

},

1156

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1157

# can choose from the card.

1158

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1159

# when the user taps the suggested action. This data will be also

1160

# forwarded to webhook to allow performing custom business logic.

1161

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1162

# to send back to the agent (https://goo.gl/GXotJW).

1163

},

1164

"text": "A String", # Text to display alongside the action.

1165

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1166

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1167

# registered as the default handler for the URL, then this app will be

1168

# opened instead, and its icon will be used in the suggested action UI.

1169

"uri": "A String", # Required. The uri to open on the user device

1170

},

1171

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1172

# but does not dial automatically (https://goo.gl/ergbB2).

1173

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1174

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1175

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

1182

},

1183

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

1184

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

1185

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

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

1190

# Telephony Gateway.

1191

#

1192

# Telephony Gateway takes the synthesizer settings from

1193

# `DetectIntentResponse.output_audio_config` which can either be set

1194

# at request-level or can come from the agent-level synthesizer config.

1195

"text": "A String", # The raw text to be synthesized.

1196

"ssml": "A String", # The SSML to be synthesized. For more information, see

1197

# [SSML](https://developers.google.com/actions/reference/ssml).

1198

},

1199

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

1200

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

1201

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

1202

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

1203

{ # Optional. Contains information about a button.

1204

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

1205

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

1210

},

1211

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

1212

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

1213

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

1214

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

1215

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

1216

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1217

},

1218

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

1219

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

1220

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

1221

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

1222

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

1223

},

1224

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

1225

},

1226

],

1227

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

1228

},

1229

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

1230

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

1231

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

1232

{ # Column properties for TableCard.

1233

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

1234

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

1235

},

1236

],

1237

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

1238

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

1239

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

1240

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1241

},

1242

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

1243

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

1244

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

1245

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

1246

},

1247

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

1248

},

1249

],

1250

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

1251

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

1252

{ # Row of TableCard.

1253

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

1254

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

1255

{ # Cell of TableCardRow.

1256

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

},

],

},

],

},

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

1263

"items": [ # Required. Carousel items.

1264

{ # An item in the carousel.

1265

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

1266

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

1267

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

1268

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

1269

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1270

},

1271

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

1272

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

1273

# dialog.

1274

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

},

},

],

},

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

1285

# or website associated with this agent.

1286

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

1287

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

1288

# suggestion chip.

1289

},

1290

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

1291

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

1292

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

1293

# items.

1294

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

1295

# items, maximum of ten.

1296

{ # Browsing carousel tile

1297

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

1298

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

1299

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

1300

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

1301

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1302

},

1303

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

1304

# text.

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.

},

],

},

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

1316

# This message in `QueryResult.fulfillment_messages` and

1317

# `WebhookResponse.fulfillment_messages` should contain only one

1318

# `SimpleResponse`.

1319

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

1320

{ # The simple response message containing speech or text.

1321

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

1322

# speech output. Mutually exclusive with ssml.

1323

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

1324

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

1325

# text_to_speech.

1326

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

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

1331

"phoneNumber": "A String", # Required. The phone number to transfer the call to

1332

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

1333

#

1334

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

1335

},

1336

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

1337

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

1338

{ # Response media object for media content card.

1339

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

1340

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

1341

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

1342

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1343

},

1344

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

1345

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

1346

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

1347

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

1348

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

1349

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

1350

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

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

1355

},

1356

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

1357

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

1358

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

1359

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1360

},

1361

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

1362

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

1363

},

1364

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

1365

#

1366

# Rich cards allow you to respond to users with more vivid content, e.g.

1367

# with media and suggestions.

1368

#

1369

# For more details about RBM rich cards, please see:

1370

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

1371

# You can group multiple rich cards into one using RbmCarouselCard but

1372

# carousel cards will give you less control over the card layout.

1373

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

1374

# Image preview alignment for standalone cards with horizontal layout.

1375

"cardOrientation": "A String", # Required. Orientation of the card.

1376

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

1377

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

1378

#

1379

# At least one of the title, description or media must be set.

1380

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

1381

# be set. Media (image, GIF or a video) to include in the card.

1382

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

1400

# provide a thumbnail URI, the RBM platform displays a blank

1401

# placeholder thumbnail until the user's device downloads the file.

1402

# Depending on the user's setting, the file may not download

1403

# automatically and may require the user to tap a download button.

1404

"height": "A String", # Required for cards with vertical orientation. The height of the media

1405

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

1406

# For a standalone card with horizontal layout, height is not

1407

# customizable, and this field is ignored.

1408

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

1409

# determines the MIME type of the file from the content-type field in

1410

# the HTTP headers when the platform fetches the file. The content-type

1411

# field must be present and accurate in the HTTP response from the URL.

1412

},

1413

"suggestions": [ # Optional. List of suggestions to include in the card.

1414

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1415

# easily select/click a predefined response or perform an action (like

1416

# opening a web uri).

1417

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1418

# instead of typing in their own response.

1419

"text": "A String", # Suggested reply text.

1420

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1421

# when the user taps the suggested reply. This data will be also

1422

# forwarded to webhook to allow performing custom business logic.

1423

},

1424

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1425

# can choose from the card.

1426

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1427

# when the user taps the suggested action. This data will be also

1428

# forwarded to webhook to allow performing custom business logic.

1429

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1430

# to send back to the agent (https://goo.gl/GXotJW).

1431

},

1432

"text": "A String", # Text to display alongside the action.

1433

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1434

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1435

# registered as the default handler for the URL, then this app will be

1436

# opened instead, and its icon will be used in the suggested action UI.

1437

"uri": "A String", # Required. The uri to open on the user device

1438

},

1439

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1440

# but does not dial automatically (https://goo.gl/ergbB2).

1441

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1442

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1443

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

1450

#

1451

# At least one of the title, description or media must be set.

},

},

},

],

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

1457

# Note: The action name must not contain whitespaces.

1458

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

1459

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1460

# methods.

Dan O'Meara

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

[diff] [blame]

1461

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

Bu Sun Kim

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

[diff] [blame^]

1462

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

1463

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

Bu Sun Kim

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

[diff] [blame]

1464

# triggered.

Dan O'Meara

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

[diff] [blame]

1465

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

Bu Sun Kim

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

[diff] [blame^]

1466

"A String",

Bu Sun Kim

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

[diff] [blame]

1467

],

Bu Sun Kim

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

[diff] [blame^]

1468

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

1469

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

1470

{ # Represents a single followup intent in the chain.

1471

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

1472

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

1473

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

1474

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

1475

},

1476

],

1477

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

1478

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

1479

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

1480

# this intent.

1481

#

1482

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

1483

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

1484

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

1485

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

1486

# auto-markup in the UI is turned off.

1487

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

1488

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

Bu Sun Kim

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

[diff] [blame]

1489

# Note: If `ml_enabled` setting is set to false, then this intent is not

1490

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

1491

# auto-markup in the UI is turned off.

1492

# DEPRECATED! Please use `ml_disabled` field instead.

1493

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

1494

# then the default value is determined as follows:

1495

# - Before April 15th, 2018 the default is:

1496

# ml_enabled = false / ml_disabled = true.

1497

# - After April 15th, 2018 the default is:

1498

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

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

[diff] [blame]

1499

},

1500

],

1501

},

Bu Sun Kim

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

[diff] [blame^]

1502

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

1503

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

1504

# For more information, see

1505

# [Multilingual intent and entity

1506

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

1507

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

1508

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

1509

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

1510

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

1511

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

Bu Sun Kim

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

[diff] [blame]

1512

}

1513

1514

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1521

1522

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

1523

# network API call.

Bu Sun Kim

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

[diff] [blame^]

1524

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

1525

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

1526

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

1527

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

1528

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

1529

},

1530

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

1531

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

1532

# available.

1533

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

1534

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

1535

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

1536

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

1537

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

1538

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

1539

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

1540

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame^]

1541

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

Dan O'Meara

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

[diff] [blame]

1542

},

Bu Sun Kim

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

[diff] [blame^]

1543

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

1544

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

1545

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

Bu Sun Kim

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

[diff] [blame^]

1546

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

1547

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

1548

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

1549

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

1550

#

1551

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

1552

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

Bu Sun Kim

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

[diff] [blame^]

1553

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

1554

# message types for APIs to use.

1555

{

Bu Sun Kim

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

[diff] [blame^]

1556

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

Bu Sun Kim

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

[diff] [blame]

1557

},

1558

],

Bu Sun Kim

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

[diff] [blame^]

1559

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

1560

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

1561

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

1562

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

Bu Sun Kim

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

[diff] [blame]

1563

},

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

1568

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

1569

<pre>Creates an intent in the specified agent.

1570

1571

Args:

1572

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

Dan O'Meara

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

[diff] [blame]

1573

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

1574

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1575

The object takes the form of:

1576

1577

{ # Represents an intent.

1578

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

1579

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

Bu Sun Kim

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

[diff] [blame^]

1580

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

Dan O'Meara

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

[diff] [blame]

1581

# trained on.

1582

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

Bu Sun Kim

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

[diff] [blame^]

1583

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

Dan O'Meara

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

[diff] [blame]

1584

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

1585

#

1586

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

1587

# Dialogflow Console does.

1588

#

1589

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

1590

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

1591

#

1592

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

1593

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

1594

#

1595

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

1596

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

1597

#

1598

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

1599

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

1600

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

1601

# set.

1602

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame^]

1603

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

Dan O'Meara

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

[diff] [blame]

1604

# annotated part of the example.

1605

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

Bu Sun Kim

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

[diff] [blame^]

1606

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

Dan O'Meara

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

[diff] [blame]

1607

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

1608

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

1609

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame^]

1610

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

1611

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

1612

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

Dan O'Meara

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

[diff] [blame]

1613

},

1614

],

Bu Sun Kim

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

[diff] [blame^]

1615

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

1616

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

Dan O'Meara

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

[diff] [blame]

1617

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

1618

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame^]

1619

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

Dan O'Meara

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

[diff] [blame]

1620

},

1621

],

Bu Sun Kim

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

[diff] [blame^]

1622

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

1623

# session when this intent is matched.

1624

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

1625

{ # Represents intent parameters.

1626

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

1627

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

1628

# describes values of the parameter. If the parameter is

1629

# required, this must be provided.

1630

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

1631

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

1632

"A String",

1633

],

1634

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

1635

# result.

1636

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

1637

# syntax: `#context_name.parameter_name`.

1638

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

1639

# whether the intent cannot be completed without collecting the parameter

1640

# value.

1641

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

1642

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

1643

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

1644

#

1645

# - a constant string,

1646

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

1647

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

1648

# - a parameter value from some context defined as

1649

# `#context_name.parameter_name`.

1650

},

Bu Sun Kim

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

[diff] [blame]

1651

],

Bu Sun Kim

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

[diff] [blame^]

1652

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

1653

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

1654

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

1655

# Event names are limited to 150 characters.

1656

"A String",

1657

],

1658

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

1659

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

1660

# for example with CreateIntent or

1661

# BatchUpdateIntents, in order to make this

1662

# intent a followup intent.

1663

#

1664

# It identifies the parent followup intent.

1665

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

1666

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

Dan O'Meara

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

[diff] [blame]

1667

# priorities.

Bu Sun Kim

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

[diff] [blame]

1668

#

Dan O'Meara

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

[diff] [blame]

1669

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

1670

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

1671

# `Normal` priority in the console.

1672

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

1673

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame^]

1674

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

1675

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

1676

# to close interaction with an end user. Default is false.

1677

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

Bu Sun Kim

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

[diff] [blame]

1678

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

1679

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

1680

# when the intent is matched.

Dan O'Meara

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

[diff] [blame]

1681

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

Bu Sun Kim

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

[diff] [blame]

1682

{ # Represents a context.

Bu Sun Kim

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

[diff] [blame^]

1683

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

1684

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

1685

# immediately. Contexts expire automatically after 20 minutes if there

1686

# are no matching queries.

1687

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

Dan O'Meara

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

[diff] [blame]

1688

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

1689

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

1690

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

Bu Sun Kim

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

[diff] [blame]

1691

#

1692

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

1693

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

1694

#

Bu Sun Kim

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

[diff] [blame^]

1695

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

1696

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

Dan O'Meara

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

[diff] [blame]

1697

#

1698

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

1699

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

1700

#

1701

# * `__system_counters__`

1702

# * `*_id_dialog_context`

1703

# * `*_dialog_params_size`

Bu Sun Kim

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

[diff] [blame^]

1704

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

Dan O'Meara

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

[diff] [blame]

1705

#

1706

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

1707

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

1708

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

1709

#

1710

# - MapKey type: string

1711

# - MapKey value: parameter name

1712

# - MapValue type:

Bu Sun Kim

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

[diff] [blame^]

1713

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

Dan O'Meara

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

[diff] [blame]

1714

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

1715

# - MapValue value:

Bu Sun Kim

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

[diff] [blame^]

1716

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

Dan O'Meara

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

[diff] [blame]

1717

# map from composite entity property names to property values

1718

# - Else: parameter value

Bu Sun Kim

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

[diff] [blame^]

1719

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

Dan O'Meara

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

[diff] [blame]

1720

},

Bu Sun Kim

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

[diff] [blame]

1721

},

1722

],

Bu Sun Kim

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

[diff] [blame^]

1723

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

1724

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

1725

"A String",

Bu Sun Kim

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

[diff] [blame]

1726

],

Bu Sun Kim

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

[diff] [blame^]

1727

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

1728

# `Response` field in the Dialogflow console.

1729

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

1730

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

1731

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

1732

"A String",

Bu Sun Kim

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

[diff] [blame]

1733

],

Bu Sun Kim

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

[diff] [blame]

1734

},

Bu Sun Kim

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

[diff] [blame^]

1735

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

1736

#

1737

# Rich cards allow you to respond to users with more vivid content, e.g.

1738

# with media and suggestions.

1739

#

1740

# For more details about RBM rich cards, please see:

1741

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

1742

# If you want to show a single card with more control over the layout,

1743

# please use RbmStandaloneCard instead.

1744

"cardWidth": "A String", # Required. The width of the cards in the carousel.

1745

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

1746

# 2 cards and at most 10.

1747

{ # Rich Business Messaging (RBM) Card content

1748

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

1749

#

1750

# At least one of the title, description or media must be set.

1751

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

Dan O'Meara

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

[diff] [blame]

1752

# be set. Media (image, GIF or a video) to include in the card.

1753

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

Bu Sun Kim

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

[diff] [blame^]

1758

# * image/jpg'

Dan O'Meara

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

[diff] [blame]

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

Bu Sun Kim

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

[diff] [blame^]

1770

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

Dan O'Meara

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

[diff] [blame]

1771

# provide a thumbnail URI, the RBM platform displays a blank

Bu Sun Kim

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

[diff] [blame^]

1772

# placeholder thumbnail until the user's device downloads the file.

1773

# Depending on the user's setting, the file may not download

Dan O'Meara

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

[diff] [blame]

1774

# automatically and may require the user to tap a download button.

Bu Sun Kim

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

[diff] [blame^]

1775

"height": "A String", # Required for cards with vertical orientation. The height of the media

Dan O'Meara

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

[diff] [blame]

1776

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

1777

# For a standalone card with horizontal layout, height is not

1778

# customizable, and this field is ignored.

Bu Sun Kim

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

[diff] [blame^]

1779

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

1780

# determines the MIME type of the file from the content-type field in

1781

# the HTTP headers when the platform fetches the file. The content-type

1782

# field must be present and accurate in the HTTP response from the URL.

Dan O'Meara

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

[diff] [blame]

1783

},

Bu Sun Kim

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

[diff] [blame^]

1784

"suggestions": [ # Optional. List of suggestions to include in the card.

Dan O'Meara

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

[diff] [blame]

1785

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1786

# easily select/click a predefined response or perform an action (like

1787

# opening a web uri).

Bu Sun Kim

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

[diff] [blame^]

1788

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1789

# instead of typing in their own response.

1790

"text": "A String", # Suggested reply text.

1791

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1792

# when the user taps the suggested reply. This data will be also

1793

# forwarded to webhook to allow performing custom business logic.

1794

},

1795

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

Dan O'Meara

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

[diff] [blame]

1796

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

1797

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1798

# when the user taps the suggested action. This data will be also

1799

# forwarded to webhook to allow performing custom business logic.

1800

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

Dan O'Meara

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

[diff] [blame]

1801

# to send back to the agent (https://goo.gl/GXotJW).

1802

},

Bu Sun Kim

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

[diff] [blame^]

1803

"text": "A String", # Text to display alongside the action.

1804

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

Dan O'Meara

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

[diff] [blame]

1805

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1806

# registered as the default handler for the URL, then this app will be

1807

# opened instead, and its icon will be used in the suggested action UI.

Bu Sun Kim

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

[diff] [blame^]

1808

"uri": "A String", # Required. The uri to open on the user device

Dan O'Meara

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

[diff] [blame]

1809

},

Bu Sun Kim

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

[diff] [blame^]

1810

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Dan O'Meara

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

[diff] [blame]

1811

# but does not dial automatically (https://goo.gl/ergbB2).

Bu Sun Kim

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

[diff] [blame^]

1812

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

Dan O'Meara

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

[diff] [blame]

1813

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1814

# format. An example of a correctly formatted phone number:

1815

# +15556767888.

1816

},

Dan O'Meara

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

[diff] [blame]

1817

},

1818

},

1819

],

Bu Sun Kim

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

[diff] [blame^]

1820

"title": "A String", # Optional. Title of the card (at most 200 bytes).

Dan O'Meara

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

[diff] [blame]

1821

#

1822

# At least one of the title, description or media must be set.

1823

},

Bu Sun Kim

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

[diff] [blame^]

1824

],

1825

},

1826

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

1827

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

1828

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

1829

# to the conversation.

1830

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

Bu Sun Kim

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

[diff] [blame]

1831

},

Bu Sun Kim

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

[diff] [blame^]

1832

],

1833

},

1834

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

1835

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

1836

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

1837

# play, e.g., "gs://bucket/object". The object must contain a single

1838

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

1839

#

1840

# This object must be readable by the `service-<Project

1841

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

1842

# where <Project Number> is the number of the Telephony Gateway project

1843

# (usually the same as the Dialogflow agent project). If the Google Cloud

1844

# Storage bucket is in the Telephony Gateway project, this permission is

1845

# added by default when enabling the Dialogflow V2 API.

1846

#

1847

# For audio from other sources, consider using the

1848

# `TelephonySynthesizeSpeech` message with SSML.

1849

},

1850

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

1851

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

1852

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

1853

"items": [ # Required. List items.

1854

{ # An item in the list.

1855

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

1856

# dialog.

1857

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

1858

# item in dialog.

1859

"A String",

Dan O'Meara

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

[diff] [blame]

1860

],

Bu Sun Kim

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

[diff] [blame^]

1861

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

1862

# response is given.

Dan O'Meara

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

[diff] [blame]

1863

},

Bu Sun Kim

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

[diff] [blame^]

1864

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

1865

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

1866

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

1867

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

1868

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1869

},

1870

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

Dan O'Meara

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

[diff] [blame]

1871

},

Bu Sun Kim

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

[diff] [blame^]

1872

],

1873

},

1874

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

1875

#

1876

# RBM allows businesses to send enriched and branded versions of SMS. See

1877

# https://jibe.google.com/business-messaging.

1878

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

1879

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1880

# easily select/click a predefined response or perform an action (like

1881

# opening a web uri).

1882

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1883

# instead of typing in their own response.

1884

"text": "A String", # Suggested reply text.

1885

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1886

# when the user taps the suggested reply. This data will be also

1887

# forwarded to webhook to allow performing custom business logic.

Dan O'Meara

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

[diff] [blame]

1888

},

Bu Sun Kim

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

[diff] [blame^]

1889

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1890

# can choose from the card.

1891

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1892

# when the user taps the suggested action. This data will be also

1893

# forwarded to webhook to allow performing custom business logic.

1894

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1895

# to send back to the agent (https://goo.gl/GXotJW).

Dan O'Meara

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

[diff] [blame]

1896

},

Bu Sun Kim

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

[diff] [blame^]

1897

"text": "A String", # Text to display alongside the action.

1898

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1899

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1900

# registered as the default handler for the URL, then this app will be

1901

# opened instead, and its icon will be used in the suggested action UI.

1902

"uri": "A String", # Required. The uri to open on the user device

1903

},

1904

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1905

# but does not dial automatically (https://goo.gl/ergbB2).

1906

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1907

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1908

# format. An example of a correctly formatted phone number:

1909

# +15556767888.

1910

},

Dan O'Meara

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

[diff] [blame]

1911

},

Bu Sun Kim

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

[diff] [blame^]

1912

},

1913

],

1914

"text": "A String", # Required. Text sent and displayed to the user.

1915

},

1916

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

1917

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

1918

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

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

1923

# Telephony Gateway.

1924

#

1925

# Telephony Gateway takes the synthesizer settings from

1926

# `DetectIntentResponse.output_audio_config` which can either be set

1927

# at request-level or can come from the agent-level synthesizer config.

1928

"text": "A String", # The raw text to be synthesized.

1929

"ssml": "A String", # The SSML to be synthesized. For more information, see

1930

# [SSML](https://developers.google.com/actions/reference/ssml).

1931

},

1932

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

1933

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

1934

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

1935

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

1936

{ # Optional. Contains information about a button.

1937

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

1938

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

1943

},

1944

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

1945

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

1946

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

1947

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

1948

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

1949

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dan O'Meara

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

[diff] [blame]

1950

},

Bu Sun Kim

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

[diff] [blame^]

1951

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

1952

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

1953

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

1954

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

1955

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

Bu Sun Kim

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

[diff] [blame]

1956

},

Bu Sun Kim

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

[diff] [blame^]

1957

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

1958

},

1959

],

1960

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

1961

},

1962

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

1963

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

1964

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

1965

{ # Column properties for TableCard.

1966

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

1967

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

1968

},

1969

],

1970

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

1971

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

1972

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

1973

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

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

[diff] [blame]

1974

},

Bu Sun Kim

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

[diff] [blame^]

1975

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

1976

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

1977

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

1978

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

Bu Sun Kim

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

[diff] [blame]

1979

},

Bu Sun Kim

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

[diff] [blame^]

1980

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

1981

},

1982

],

1983

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

1984

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

1985

{ # Row of TableCard.

1986

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

1987

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

1988

{ # Cell of TableCardRow.

1989

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

},

],

},

],

},

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

1996

"items": [ # Required. Carousel items.

1997

{ # An item in the carousel.

1998

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

1999

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

2000

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

2001

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2002

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2003

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2004

"description": "A String", # Optional. The body text of the card.

2005

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2006

# dialog.

2007

"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.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

2018

# or website associated with this agent.

2019

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2020

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2021

# suggestion chip.

2022

},

2023

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2024

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2025

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2026

# items.

2027

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2028

# items, maximum of ten.

2029

{ # Browsing carousel tile

2030

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2031

"image": { # The image response message. # Optional. Hero image for the carousel item.

2032

"imageUri": "A String", # Optional. The public URI to an image file.

2033

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2034

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2035

},

2036

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2037

# text.

2038

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2039

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2040

# the URL. Defaults to opening via web browser.

2041

"url": "A String", # Required. URL

2042

},

2043

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2044

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

2049

# This message in `QueryResult.fulfillment_messages` and

2050

# `WebhookResponse.fulfillment_messages` should contain only one

2051

# `SimpleResponse`.

2052

"simpleResponses": [ # Required. The list of simple responses.

2053

{ # The simple response message containing speech or text.

2054

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2055

# speech output. Mutually exclusive with ssml.

2056

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2057

# response to the user in the SSML format. Mutually exclusive with

2058

# text_to_speech.

2059

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2064

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2065

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2066

#

2067

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2068

},

2069

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2070

"mediaObjects": [ # Required. List of media objects.

2071

{ # Response media object for media content card.

2072

"largeImage": { # The image response message. # Optional. Image to display above media content.

2073

"imageUri": "A String", # Optional. The public URI to an image file.

2074

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2075

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2076

},

2077

"name": "A String", # Required. Name of media card.

2078

"description": "A String", # Optional. Description of media card.

2079

"contentUrl": "A String", # Required. Url where the media is stored.

2080

"icon": { # The image response message. # Optional. Icon to display above media content.

2081

"imageUri": "A String", # Optional. The public URI to an image file.

2082

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2083

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2088

},

2089

"image": { # The image response message. # Displays an image.

2090

"imageUri": "A String", # Optional. The public URI to an image file.

2091

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2092

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2093

},

2094

"payload": { # A custom platform-specific response.

2095

"a_key": "", # Properties of the object.

2096

},

2097

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2098

#

2099

# Rich cards allow you to respond to users with more vivid content, e.g.

2100

# with media and suggestions.

2101

#

2102

# For more details about RBM rich cards, please see:

2103

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2104

# You can group multiple rich cards into one using RbmCarouselCard but

2105

# carousel cards will give you less control over the card layout.

2106

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2107

# Image preview alignment for standalone cards with horizontal layout.

2108

"cardOrientation": "A String", # Required. Orientation of the card.

2109

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

2110

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2111

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2112

# At least one of the title, description or media must be set.

2113

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2114

# be set. Media (image, GIF or a video) to include in the card.

2115

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2133

# provide a thumbnail URI, the RBM platform displays a blank

2134

# placeholder thumbnail until the user's device downloads the file.

2135

# Depending on the user's setting, the file may not download

2136

# automatically and may require the user to tap a download button.

2137

"height": "A String", # Required for cards with vertical orientation. The height of the media

2138

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2139

# For a standalone card with horizontal layout, height is not

2140

# customizable, and this field is ignored.

2141

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2142

# determines the MIME type of the file from the content-type field in

2143

# the HTTP headers when the platform fetches the file. The content-type

2144

# field must be present and accurate in the HTTP response from the URL.

2145

},

2146

"suggestions": [ # Optional. List of suggestions to include in the card.

2147

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2148

# easily select/click a predefined response or perform an action (like

2149

# opening a web uri).

2150

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2151

# instead of typing in their own response.

2152

"text": "A String", # Suggested reply text.

2153

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2154

# when the user taps the suggested reply. This data will be also

2155

# forwarded to webhook to allow performing custom business logic.

2156

},

2157

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2158

# can choose from the card.

2159

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2160

# when the user taps the suggested action. This data will be also

2161

# forwarded to webhook to allow performing custom business logic.

2162

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2163

# to send back to the agent (https://goo.gl/GXotJW).

2164

},

2165

"text": "A String", # Text to display alongside the action.

2166

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2167

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2168

# registered as the default handler for the URL, then this app will be

2169

# opened instead, and its icon will be used in the suggested action UI.

2170

"uri": "A String", # Required. The uri to open on the user device

2171

},

2172

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2173

# but does not dial automatically (https://goo.gl/ergbB2).

2174

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2175

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2176

# format. An example of a correctly formatted phone number:

2177

# +15556767888.

2178

},

2179

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2180

},

2181

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2182

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2183

#

2184

# At least one of the title, description or media must be set.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2185

},

2186

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2187

},

2188

],

2189

"action": "A String", # Optional. The name of the action associated with the intent.

2190

# Note: The action name must not contain whitespaces.

2191

"name": "A String", # Optional. The unique identifier of this intent.

2192

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2193

# methods.

2194

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2195

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

2196

"inputContextNames": [ # Optional. The list of context names required for this intent to be

2197

# triggered.

2198

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2199

"A String",

2200

],

2201

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

2202

# a direct or indirect parent. We populate this field only in the output.

2203

{ # Represents a single followup intent in the chain.

2204

"followupIntentName": "A String", # The unique identifier of the followup intent.

2205

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2206

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2207

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2208

},

2209

],

2210

"displayName": "A String", # Required. The name of this intent.

2211

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

2212

# followup intents. It identifies the correct followup intents chain for

2213

# this intent.

2214

#

2215

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2216

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2217

# Note: If `ml_disabled` setting is set to true, then this intent is not

2218

# taken into account during inference in `ML ONLY` match mode. Also,

2219

# auto-markup in the UI is turned off.

2220

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2221

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

2222

# Note: If `ml_enabled` setting is set to false, then this intent is not

2223

# taken into account during inference in `ML ONLY` match mode. Also,

2224

# auto-markup in the UI is turned off.

2225

# DEPRECATED! Please use `ml_disabled` field instead.

2226

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

2227

# then the default value is determined as follows:

2228

# - Before April 15th, 2018 the default is:

2229

# ml_enabled = false / ml_disabled = true.

2230

# - After April 15th, 2018 the default is:

2231

# ml_enabled = true / ml_disabled = false.

2232

}

2233

2234

intentView: string, Optional. The resource view to apply to the returned intent.

2235

languageCode: string, Optional. The language used to access language-specific data.

2236

If not specified, the agent's default language is used.

2237

For more information, see

2238

[Multilingual intent and entity

2239

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

2240

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2247

2248

{ # Represents an intent.

2249

# Intents convert a number of user expressions or patterns into an action. An

2250

# action is an extraction of a user command or sentence semantics.

2251

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2252

# trained on.

2253

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2254

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2255

# The parts are concatenated in order to form the training phrase.

2256

#

2257

# Note: The API does not automatically annotate training phrases like the

2258

# Dialogflow Console does.

2259

#

2260

# Note: Do not forget to include whitespace at part boundaries,

2261

# so the training phrase is well formatted when the parts are concatenated.

2262

#

2263

# If the training phrase does not need to be annotated with parameters,

2264

# you just need a single part with only the Part.text field set.

2265

#

2266

# If you want to annotate the training phrase, you must create multiple

2267

# parts, where the fields of each part are populated in one of two ways:

2268

#

2269

# - `Part.text` is set to a part of the phrase that has no parameters.

2270

# - `Part.text` is set to a part of the phrase that you want to annotate,

2271

# and the `entity_type`, `alias`, and `user_defined` fields are all

2272

# set.

2273

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2274

"alias": "A String", # Optional. The parameter name for the value extracted from the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2275

# annotated part of the example.

2276

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2277

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2278

# This field is set to true when the Dialogflow Console is used to

2279

# manually annotate the part. When creating an annotated part with the

2280

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2281

"text": "A String", # Required. The text for this part.

2282

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2283

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2284

},

2285

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2286

"name": "A String", # Output only. The unique identifier of this training phrase.

2287

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2288

# the intent. Each time a developer adds an existing sample by editing an

2289

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2290

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2291

},

2292

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2293

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

2294

# session when this intent is matched.

2295

"parameters": [ # Optional. The collection of parameters associated with the intent.

2296

{ # Represents intent parameters.

2297

"displayName": "A String", # Required. The name of the parameter.

2298

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

2299

# describes values of the parameter. If the parameter is

2300

# required, this must be provided.

2301

"prompts": [ # Optional. The collection of prompts that the agent can present to the

2302

# user in order to collect a value for the parameter.

2303

"A String",

2304

],

2305

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

2306

# result.

2307

# Default values can be extracted from contexts by using the following

2308

# syntax: `#context_name.parameter_name`.

2309

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

2310

# whether the intent cannot be completed without collecting the parameter

2311

# value.

2312

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2313

"name": "A String", # The unique identifier of this parameter.

2314

"value": "A String", # Optional. The definition of the parameter value. It can be:

2315

#

2316

# - a constant string,

2317

# - a parameter value defined as `$parameter_name`,

2318

# - an original parameter value defined as `$parameter_name.original`,

2319

# - a parameter value from some context defined as

2320

# `#context_name.parameter_name`.

2321

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2322

],

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", # Optional. 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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2338

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2339

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2345

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

2346

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

2347

# to close interaction with an end user. Default is false.

2348

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

2349

# is matched. Context messages in this collection should not set the

2350

# parameters field. Setting the `lifespan_count` to 0 will reset the context

2351

# when the intent is matched.

2352

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2353

{ # Represents a context.

2354

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

2355

# context expires. The default is `0`. If set to `0`, the context expires

2356

# immediately. Contexts expire automatically after 20 minutes if there

2357

# are no matching queries.

2358

"name": "A String", # Required. The unique identifier of the context. Format:

2359

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

2360

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

2361

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

2362

#

2363

# The `Context ID` is always converted to lowercase, may only contain

2364

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2365

#

2366

# If `Environment ID` is not specified, we assume default 'draft'

2367

# environment. If `User ID` is not specified, we assume default '-' user.

2368

#

2369

# The following context names are reserved for internal use by Dialogflow.

2370

# You should not use these contexts or create contexts with these names:

2371

#

2372

# * `__system_counters__`

2373

# * `*_id_dialog_context`

2374

# * `*_dialog_params_size`

2375

"parameters": { # Optional. The collection of parameters associated with this context.

2376

#

2377

# Depending on your protocol or client library language, this is a

2378

# map, associative array, symbol table, dictionary, or JSON object

2379

# composed of a collection of (MapKey, MapValue) pairs:

2380

#

2381

# - MapKey type: string

2382

# - MapKey value: parameter name

2383

# - MapValue type:

2384

# - If parameter's entity type is a composite entity: map

2385

# - Else: string or number, depending on parameter value type

2386

# - MapValue value:

2387

# - If parameter's entity type is a composite entity:

2388

# map from composite entity property names to property values

2389

# - Else: parameter value

2390

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2395

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2396

"A String",

2397

],

2398

"messages": [ # Optional. The collection of rich messages corresponding to the

2399

# `Response` field in the Dialogflow console.

2400

{ # Corresponds to the `Response` field in the Dialogflow console.

2401

"text": { # The text response message. # Returns a text response.

2402

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

2407

#

2408

# Rich cards allow you to respond to users with more vivid content, e.g.

2409

# with media and suggestions.

2410

#

2411

# For more details about RBM rich cards, please see:

2412

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2413

# If you want to show a single card with more control over the layout,

2414

# please use RbmStandaloneCard instead.

2415

"cardWidth": "A String", # Required. The width of the cards in the carousel.

2416

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

2417

# 2 cards and at most 10.

2418

{ # Rich Business Messaging (RBM) Card content

2419

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2420

#

2421

# At least one of the title, description or media must be set.

2422

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2423

# be set. Media (image, GIF or a video) to include in the card.

2424

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2442

# provide a thumbnail URI, the RBM platform displays a blank

2443

# placeholder thumbnail until the user's device downloads the file.

2444

# Depending on the user's setting, the file may not download

2445

# automatically and may require the user to tap a download button.

2446

"height": "A String", # Required for cards with vertical orientation. The height of the media

2447

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2448

# For a standalone card with horizontal layout, height is not

2449

# customizable, and this field is ignored.

2450

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2451

# determines the MIME type of the file from the content-type field in

2452

# the HTTP headers when the platform fetches the file. The content-type

2453

# field must be present and accurate in the HTTP response from the URL.

2454

},

2455

"suggestions": [ # Optional. List of suggestions to include in the card.

2456

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2457

# easily select/click a predefined response or perform an action (like

2458

# opening a web uri).

2459

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2460

# instead of typing in their own response.

2461

"text": "A String", # Suggested reply text.

2462

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2463

# when the user taps the suggested reply. This data will be also

2464

# forwarded to webhook to allow performing custom business logic.

2465

},

2466

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2467

# can choose from the card.

2468

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2469

# when the user taps the suggested action. This data will be also

2470

# forwarded to webhook to allow performing custom business logic.

2471

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2472

# to send back to the agent (https://goo.gl/GXotJW).

2473

},

2474

"text": "A String", # Text to display alongside the action.

2475

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2476

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2477

# registered as the default handler for the URL, then this app will be

2478

# opened instead, and its icon will be used in the suggested action UI.

2479

"uri": "A String", # Required. The uri to open on the user device

2480

},

2481

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2482

# but does not dial automatically (https://goo.gl/ergbB2).

2483

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2484

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2485

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2492

#

2493

# At least one of the title, description or media must be set.

},

],

},

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2498

"suggestions": [ # Required. The list of suggested replies.

2499

{ # The suggestion chip message that the user can tap to quickly post a reply

2500

# to the conversation.

2501

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2506

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2507

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

2508

# play, e.g., "gs://bucket/object". The object must contain a single

2509

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

2510

#

2511

# This object must be readable by the `service-<Project

2512

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

2513

# where <Project Number> is the number of the Telephony Gateway project

2514

# (usually the same as the Dialogflow agent project). If the Google Cloud

2515

# Storage bucket is in the Telephony Gateway project, this permission is

2516

# added by default when enabling the Dialogflow V2 API.

2517

#

2518

# For audio from other sources, consider using the

2519

# `TelephonySynthesizeSpeech` message with SSML.

2520

},

2521

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

2522

"title": "A String", # Optional. The overall title of the list.

2523

"subtitle": "A String", # Optional. Subtitle of the list.

2524

"items": [ # Required. List items.

2525

{ # An item in the list.

2526

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2527

# dialog.

2528

"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

2533

# response is given.

2534

},

2535

"title": "A String", # Required. The title of the list item.

2536

"image": { # The image response message. # Optional. The image to display.

2537

"imageUri": "A String", # Optional. The public URI to an image file.

2538

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2539

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2540

},

2541

"description": "A String", # Optional. The main text describing the item.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

2546

#

2547

# RBM allows businesses to send enriched and branded versions of SMS. See

2548

# https://jibe.google.com/business-messaging.

2549

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2550

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2551

# easily select/click a predefined response or perform an action (like

2552

# opening a web uri).

2553

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2554

# instead of typing in their own response.

2555

"text": "A String", # Suggested reply text.

2556

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2557

# when the user taps the suggested reply. This data will be also

2558

# forwarded to webhook to allow performing custom business logic.

2559

},

2560

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2561

# can choose from the card.

2562

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2563

# when the user taps the suggested action. This data will be also

2564

# forwarded to webhook to allow performing custom business logic.

2565

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2566

# to send back to the agent (https://goo.gl/GXotJW).

2567

},

2568

"text": "A String", # Text to display alongside the action.

2569

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2570

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2571

# registered as the default handler for the URL, then this app will be

2572

# opened instead, and its icon will be used in the suggested action UI.

2573

"uri": "A String", # Required. The uri to open on the user device

2574

},

2575

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2576

# but does not dial automatically (https://goo.gl/ergbB2).

2577

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2578

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2579

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

2586

},

2587

"quickReplies": { # The quick replies response message. # Displays quick replies.

2588

"title": "A String", # Optional. The title of the collection of quick replies.

2589

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

2594

# Telephony Gateway.

2595

#

2596

# Telephony Gateway takes the synthesizer settings from

2597

# `DetectIntentResponse.output_audio_config` which can either be set

2598

# at request-level or can come from the agent-level synthesizer config.

2599

"text": "A String", # The raw text to be synthesized.

2600

"ssml": "A String", # The SSML to be synthesized. For more information, see

2601

# [SSML](https://developers.google.com/actions/reference/ssml).

2602

},

2603

"card": { # The card response message. # Displays a card.

2604

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2605

"title": "A String", # Optional. The title of the card.

2606

"buttons": [ # Optional. The collection of card buttons.

2607

{ # Optional. Contains information about a button.

2608

"text": "A String", # Optional. The text to show on the button.

2609

"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.

2614

},

2615

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

2616

"title": "A String", # Optional. The title of the card.

2617

"image": { # The image response message. # Optional. The image for the card.

2618

"imageUri": "A String", # Optional. The public URI to an image file.

2619

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2620

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2621

},

2622

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2623

"buttons": [ # Optional. The collection of card buttons.

2624

{ # The button object that appears at the bottom of a card.

2625

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2626

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2627

},

2628

"title": "A String", # Required. The title of the button.

2629

},

2630

],

2631

"subtitle": "A String", # Optional. The subtitle of the card.

2632

},

2633

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2634

"subtitle": "A String", # Optional. Subtitle to the title.

2635

"columnProperties": [ # Optional. Display properties for the columns in this table.

2636

{ # Column properties for TableCard.

2637

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2638

"header": "A String", # Required. Column heading.

2639

},

2640

],

2641

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2642

"imageUri": "A String", # Optional. The public URI to an image file.

2643

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2644

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2645

},

2646

"buttons": [ # Optional. List of buttons for the card.

2647

{ # The button object that appears at the bottom of a card.

2648

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2649

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2650

},

2651

"title": "A String", # Required. The title of the button.

2652

},

2653

],

2654

"title": "A String", # Required. Title of the card.

2655

"rows": [ # Optional. Rows in this table of data.

2656

{ # Row of TableCard.

2657

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2658

"cells": [ # Optional. List of cells that make up this row.

2659

{ # Cell of TableCardRow.

2660

"text": "A String", # Required. Text in this cell.

},

],

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2667

"items": [ # Required. Carousel items.

2668

{ # An item in the carousel.

2669

"title": "A String", # Required. Title of the carousel item.

2670

"image": { # The image response message. # Optional. The image to display.

2671

"imageUri": "A String", # Optional. The public URI to an image file.

2672

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2673

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2674

},

2675

"description": "A String", # Optional. The body text of the card.

2676

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2677

# dialog.

2678

"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.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

2689

# or website associated with this agent.

2690

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2691

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2692

# suggestion chip.

2693

},

2694

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2695

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2696

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2697

# items.

2698

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2699

# items, maximum of ten.

2700

{ # Browsing carousel tile

2701

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2702

"image": { # The image response message. # Optional. Hero image for the carousel item.

2703

"imageUri": "A String", # Optional. The public URI to an image file.

2704

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2705

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2706

},

2707

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2708

# text.

2709

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2710

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2711

# the URL. Defaults to opening via web browser.

2712

"url": "A String", # Required. URL

2713

},

2714

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2715

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

2720

# This message in `QueryResult.fulfillment_messages` and

2721

# `WebhookResponse.fulfillment_messages` should contain only one

2722

# `SimpleResponse`.

2723

"simpleResponses": [ # Required. The list of simple responses.

2724

{ # The simple response message containing speech or text.

2725

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2726

# speech output. Mutually exclusive with ssml.

2727

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2728

# response to the user in the SSML format. Mutually exclusive with

2729

# text_to_speech.

2730

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2735

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2736

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2737

#

2738

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2739

},

2740

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2741

"mediaObjects": [ # Required. List of media objects.

2742

{ # Response media object for media content card.

2743

"largeImage": { # The image response message. # Optional. Image to display above media content.

2744

"imageUri": "A String", # Optional. The public URI to an image file.

2745

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2746

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2747

},

2748

"name": "A String", # Required. Name of media card.

2749

"description": "A String", # Optional. Description of media card.

2750

"contentUrl": "A String", # Required. Url where the media is stored.

2751

"icon": { # The image response message. # Optional. Icon to display above media content.

2752

"imageUri": "A String", # Optional. The public URI to an image file.

2753

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2754

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2759

},

2760

"image": { # The image response message. # Displays an image.

2761

"imageUri": "A String", # Optional. The public URI to an image file.

2762

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2763

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2764

},

2765

"payload": { # A custom platform-specific response.

2766

"a_key": "", # Properties of the object.

2767

},

2768

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2769

#

2770

# Rich cards allow you to respond to users with more vivid content, e.g.

2771

# with media and suggestions.

2772

#

2773

# For more details about RBM rich cards, please see:

2774

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2775

# You can group multiple rich cards into one using RbmCarouselCard but

2776

# carousel cards will give you less control over the card layout.

2777

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2778

# Image preview alignment for standalone cards with horizontal layout.

2779

"cardOrientation": "A String", # Required. Orientation of the card.

2780

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

2781

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2782

#

2783

# At least one of the title, description or media must be set.

2784

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2785

# be set. Media (image, GIF or a video) to include in the card.

2786

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2804

# provide a thumbnail URI, the RBM platform displays a blank

2805

# placeholder thumbnail until the user's device downloads the file.

2806

# Depending on the user's setting, the file may not download

2807

# automatically and may require the user to tap a download button.

2808

"height": "A String", # Required for cards with vertical orientation. The height of the media

2809

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2810

# For a standalone card with horizontal layout, height is not

2811

# customizable, and this field is ignored.

2812

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2813

# determines the MIME type of the file from the content-type field in

2814

# the HTTP headers when the platform fetches the file. The content-type

2815

# field must be present and accurate in the HTTP response from the URL.

2816

},

2817

"suggestions": [ # Optional. List of suggestions to include in the card.

2818

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2819

# easily select/click a predefined response or perform an action (like

2820

# opening a web uri).

2821

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2822

# instead of typing in their own response.

2823

"text": "A String", # Suggested reply text.

2824

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2825

# when the user taps the suggested reply. This data will be also

2826

# forwarded to webhook to allow performing custom business logic.

2827

},

2828

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2829

# can choose from the card.

2830

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2831

# when the user taps the suggested action. This data will be also

2832

# forwarded to webhook to allow performing custom business logic.

2833

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2834

# to send back to the agent (https://goo.gl/GXotJW).

2835

},

2836

"text": "A String", # Text to display alongside the action.

2837

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2838

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2839

# registered as the default handler for the URL, then this app will be

2840

# opened instead, and its icon will be used in the suggested action UI.

2841

"uri": "A String", # Required. The uri to open on the user device

2842

},

2843

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2844

# but does not dial automatically (https://goo.gl/ergbB2).

2845

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2846

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2847

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2854

#

2855

# At least one of the title, description or media must be set.

},

},

},

],

"action": "A String", # Optional. The name of the action associated with the intent.

2861

# Note: The action name must not contain whitespaces.

2862

"name": "A String", # Optional. The unique identifier of this intent.

2863

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2864

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2865

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2866

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

2867

"inputContextNames": [ # Optional. The list of context names required for this intent to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2868

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2869

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2870

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2871

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2872

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

2873

# a direct or indirect parent. We populate this field only in the output.

2874

{ # Represents a single followup intent in the chain.

2875

"followupIntentName": "A String", # The unique identifier of the followup intent.

2876

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2877

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2878

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2879

},

2880

],

2881

"displayName": "A String", # Required. The name of this intent.

2882

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

2883

# followup intents. It identifies the correct followup intents chain for

2884

# this intent.

2885

#

2886

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2887

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2888

# Note: If `ml_disabled` setting is set to true, then this intent is not

2889

# taken into account during inference in `ML ONLY` match mode. Also,

2890

# auto-markup in the UI is turned off.

2891

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2892

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2893

# Note: If `ml_enabled` setting is set to false, then this intent is not

2894

# taken into account during inference in `ML ONLY` match mode. Also,

2895

# auto-markup in the UI is turned off.

2896

# DEPRECATED! Please use `ml_disabled` field instead.

2897

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

2898

# then the default value is determined as follows:

2899

# - Before April 15th, 2018 the default is:

2900

# ml_enabled = false / ml_disabled = true.

2901

# - After April 15th, 2018 the default is:

2902

# ml_enabled = true / ml_disabled = false.

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>

2908

<pre>Deletes the specified intent and its direct or indirect followup intents.

2909

2910

Args:

2911

name: string, Required. The name of the intent to delete. If this intent has direct or

2912

indirect followup intents, we also delete them.

2913

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2914

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2915

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2922

2923

{ # A generic empty message that you can re-use to avoid defining duplicated

2924

# empty messages in your APIs. A typical example is to use it as the request

2925

# or the response type of an API method. For instance:

2926

#

2927

# service Foo {

2928

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

2929

# }

2930

#

2931

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2936

<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]

2937

<pre>Retrieves the specified intent.

2938

2939

Args:

2940

name: string, Required. The name of the intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2941

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2942

intentView: string, Optional. The resource view to apply to the returned intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2943

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2944

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2945

For more information, see

2946

[Multilingual intent and entity

2947

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2948

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2955

2956

{ # Represents an intent.

2957

# Intents convert a number of user expressions or patterns into an action. An

2958

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2959

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2960

# trained on.

2961

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2962

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2963

# The parts are concatenated in order to form the training phrase.

2964

#

2965

# Note: The API does not automatically annotate training phrases like the

2966

# Dialogflow Console does.

2967

#

2968

# Note: Do not forget to include whitespace at part boundaries,

2969

# so the training phrase is well formatted when the parts are concatenated.

2970

#

2971

# If the training phrase does not need to be annotated with parameters,

2972

# you just need a single part with only the Part.text field set.

2973

#

2974

# If you want to annotate the training phrase, you must create multiple

2975

# parts, where the fields of each part are populated in one of two ways:

2976

#

2977

# - `Part.text` is set to a part of the phrase that has no parameters.

2978

# - `Part.text` is set to a part of the phrase that you want to annotate,

2979

# and the `entity_type`, `alias`, and `user_defined` fields are all

2980

# set.

2981

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2982

"alias": "A String", # Optional. The parameter name for the value extracted from the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2983

# annotated part of the example.

2984

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2985

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2986

# This field is set to true when the Dialogflow Console is used to

2987

# manually annotate the part. When creating an annotated part with the

2988

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2989

"text": "A String", # Required. The text for this part.

2990

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2991

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2992

},

2993

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2994

"name": "A String", # Output only. The unique identifier of this training phrase.

2995

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2996

# the intent. Each time a developer adds an existing sample by editing an

2997

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2998

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2999

},

3000

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3001

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

3002

# session when this intent is matched.

3003

"parameters": [ # Optional. The collection of parameters associated with the intent.

3004

{ # Represents intent parameters.

3005

"displayName": "A String", # Required. The name of the parameter.

3006

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3007

# describes values of the parameter. If the parameter is

3008

# required, this must be provided.

3009

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3010

# user in order to collect a value for the parameter.

3011

"A String",

3012

],

3013

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3014

# result.

3015

# Default values can be extracted from contexts by using the following

3016

# syntax: `#context_name.parameter_name`.

3017

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3018

# whether the intent cannot be completed without collecting the parameter

3019

# value.

3020

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

3021

"name": "A String", # The unique identifier of this parameter.

3022

"value": "A String", # Optional. The definition of the parameter value. It can be:

3023

#

3024

# - a constant string,

3025

# - a parameter value defined as `$parameter_name`,

3026

# - an original parameter value defined as `$parameter_name.original`,

3027

# - a parameter value from some context defined as

3028

# `#context_name.parameter_name`.

3029

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3030

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3031

"events": [ # Optional. The collection of event names that trigger the intent.

3032

# If the collection of input contexts is not empty, all of the contexts must

3033

# be present in the active user session for an event to trigger this intent.

3034

# Event names are limited to 150 characters.

3035

"A String",

3036

],

3037

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

3038

# chain of followup intents. You can set this field when creating an intent,

3039

# for example with CreateIntent or

3040

# BatchUpdateIntents, in order to make this

3041

# intent a followup intent.

3042

#

3043

# It identifies the parent followup intent.

3044

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3045

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3046

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3047

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3048

# - If the supplied value is unspecified or 0, the service

3049

# translates the value to 500,000, which corresponds to the

3050

# `Normal` priority in the console.

3051

# - If the supplied value is negative, the intent is ignored

3052

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3053

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

3054

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

3055

# to close interaction with an end user. Default is false.

3056

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3057

# is matched. Context messages in this collection should not set the

3058

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3059

# when the intent is matched.

3060

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3061

{ # Represents a context.

3062

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3063

# context expires. The default is `0`. If set to `0`, the context expires

3064

# immediately. Contexts expire automatically after 20 minutes if there

3065

# are no matching queries.

3066

"name": "A String", # Required. The unique identifier of the context. Format:

3067

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3068

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3069

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3070

#

3071

# The `Context ID` is always converted to lowercase, may only contain

3072

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3073

#

3074

# If `Environment ID` is not specified, we assume default 'draft'

3075

# environment. If `User ID` is not specified, we assume default '-' user.

3076

#

3077

# The following context names are reserved for internal use by Dialogflow.

3078

# You should not use these contexts or create contexts with these names:

3079

#

3080

# * `__system_counters__`

3081

# * `*_id_dialog_context`

3082

# * `*_dialog_params_size`

3083

"parameters": { # Optional. The collection of parameters associated with this context.

3084

#

3085

# Depending on your protocol or client library language, this is a

3086

# map, associative array, symbol table, dictionary, or JSON object

3087

# composed of a collection of (MapKey, MapValue) pairs:

3088

#

3089

# - MapKey type: string

3090

# - MapKey value: parameter name

3091

# - MapValue type:

3092

# - If parameter's entity type is a composite entity: map

3093

# - Else: string or number, depending on parameter value type

3094

# - MapValue value:

3095

# - If parameter's entity type is a composite entity:

3096

# map from composite entity property names to property values

3097

# - Else: parameter value

3098

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3103

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3104

"A String",

3105

],

3106

"messages": [ # Optional. The collection of rich messages corresponding to the

3107

# `Response` field in the Dialogflow console.

3108

{ # Corresponds to the `Response` field in the Dialogflow console.

3109

"text": { # The text response message. # Returns a text response.

3110

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

3115

#

3116

# Rich cards allow you to respond to users with more vivid content, e.g.

3117

# with media and suggestions.

3118

#

3119

# For more details about RBM rich cards, please see:

3120

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

3121

# If you want to show a single card with more control over the layout,

3122

# please use RbmStandaloneCard instead.

3123

"cardWidth": "A String", # Required. The width of the cards in the carousel.

3124

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

3125

# 2 cards and at most 10.

3126

{ # Rich Business Messaging (RBM) Card content

3127

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

3128

#

3129

# At least one of the title, description or media must be set.

3130

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3131

# be set. Media (image, GIF or a video) to include in the card.

3132

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

3150

# provide a thumbnail URI, the RBM platform displays a blank

3151

# placeholder thumbnail until the user's device downloads the file.

3152

# Depending on the user's setting, the file may not download

3153

# automatically and may require the user to tap a download button.

3154

"height": "A String", # Required for cards with vertical orientation. The height of the media

3155

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

3156

# For a standalone card with horizontal layout, height is not

3157

# customizable, and this field is ignored.

3158

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

3159

# determines the MIME type of the file from the content-type field in

3160

# the HTTP headers when the platform fetches the file. The content-type

3161

# field must be present and accurate in the HTTP response from the URL.

3162

},

3163

"suggestions": [ # Optional. List of suggestions to include in the card.

3164

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3165

# easily select/click a predefined response or perform an action (like

3166

# opening a web uri).

3167

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3168

# instead of typing in their own response.

3169

"text": "A String", # Suggested reply text.

3170

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3171

# when the user taps the suggested reply. This data will be also

3172

# forwarded to webhook to allow performing custom business logic.

3173

},

3174

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3175

# can choose from the card.

3176

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3177

# when the user taps the suggested action. This data will be also

3178

# forwarded to webhook to allow performing custom business logic.

3179

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3180

# to send back to the agent (https://goo.gl/GXotJW).

3181

},

3182

"text": "A String", # Text to display alongside the action.

3183

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3184

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3185

# registered as the default handler for the URL, then this app will be

3186

# opened instead, and its icon will be used in the suggested action UI.

3187

"uri": "A String", # Required. The uri to open on the user device

3188

},

3189

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3190

# but does not dial automatically (https://goo.gl/ergbB2).

3191

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3192

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3193

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

3200

#

3201

# At least one of the title, description or media must be set.

},

],

},

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

3206

"suggestions": [ # Required. The list of suggested replies.

3207

{ # The suggestion chip message that the user can tap to quickly post a reply

3208

# to the conversation.

3209

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

3214

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

3215

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

3216

# play, e.g., "gs://bucket/object". The object must contain a single

3217

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

3218

#

3219

# This object must be readable by the `service-<Project

3220

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

3221

# where <Project Number> is the number of the Telephony Gateway project

3222

# (usually the same as the Dialogflow agent project). If the Google Cloud

3223

# Storage bucket is in the Telephony Gateway project, this permission is

3224

# added by default when enabling the Dialogflow V2 API.

3225

#

3226

# For audio from other sources, consider using the

3227

# `TelephonySynthesizeSpeech` message with SSML.

3228

},

3229

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

3230

"title": "A String", # Optional. The overall title of the list.

3231

"subtitle": "A String", # Optional. Subtitle of the list.

3232

"items": [ # Required. List items.

3233

{ # An item in the list.

3234

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3235

# dialog.

3236

"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

3241

# response is given.

3242

},

3243

"title": "A String", # Required. The title of the list item.

3244

"image": { # The image response message. # Optional. The image to display.

3245

"imageUri": "A String", # Optional. The public URI to an image file.

3246

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3247

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3248

},

3249

"description": "A String", # Optional. The main text describing the item.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

3254

#

3255

# RBM allows businesses to send enriched and branded versions of SMS. See

3256

# https://jibe.google.com/business-messaging.

3257

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

3258

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3259

# easily select/click a predefined response or perform an action (like

3260

# opening a web uri).

3261

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3262

# instead of typing in their own response.

3263

"text": "A String", # Suggested reply text.

3264

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3265

# when the user taps the suggested reply. This data will be also

3266

# forwarded to webhook to allow performing custom business logic.

3267

},

3268

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3269

# can choose from the card.

3270

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3271

# when the user taps the suggested action. This data will be also

3272

# forwarded to webhook to allow performing custom business logic.

3273

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3274

# to send back to the agent (https://goo.gl/GXotJW).

3275

},

3276

"text": "A String", # Text to display alongside the action.

3277

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3278

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3279

# registered as the default handler for the URL, then this app will be

3280

# opened instead, and its icon will be used in the suggested action UI.

3281

"uri": "A String", # Required. The uri to open on the user device

3282

},

3283

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3284

# but does not dial automatically (https://goo.gl/ergbB2).

3285

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3286

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3287

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

3294

},

3295

"quickReplies": { # The quick replies response message. # Displays quick replies.

3296

"title": "A String", # Optional. The title of the collection of quick replies.

3297

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

3302

# Telephony Gateway.

3303

#

3304

# Telephony Gateway takes the synthesizer settings from

3305

# `DetectIntentResponse.output_audio_config` which can either be set

3306

# at request-level or can come from the agent-level synthesizer config.

3307

"text": "A String", # The raw text to be synthesized.

3308

"ssml": "A String", # The SSML to be synthesized. For more information, see

3309

# [SSML](https://developers.google.com/actions/reference/ssml).

3310

},

3311

"card": { # The card response message. # Displays a card.

3312

"imageUri": "A String", # Optional. The public URI to an image file for the card.

3313

"title": "A String", # Optional. The title of the card.

3314

"buttons": [ # Optional. The collection of card buttons.

3315

{ # Optional. Contains information about a button.

3316

"text": "A String", # Optional. The text to show on the button.

3317

"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.

3322

},

3323

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

3324

"title": "A String", # Optional. The title of the card.

3325

"image": { # The image response message. # Optional. The image for the card.

3326

"imageUri": "A String", # Optional. The public URI to an image file.

3327

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3328

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3329

},

3330

"formattedText": "A String", # Required, unless image is present. The body text of the card.

3331

"buttons": [ # Optional. The collection of card buttons.

3332

{ # The button object that appears at the bottom of a card.

3333

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3334

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

3335

},

3336

"title": "A String", # Required. The title of the button.

3337

},

3338

],

3339

"subtitle": "A String", # Optional. The subtitle of the card.

3340

},

3341

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

3342

"subtitle": "A String", # Optional. Subtitle to the title.

3343

"columnProperties": [ # Optional. Display properties for the columns in this table.

3344

{ # Column properties for TableCard.

3345

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

3346

"header": "A String", # Required. Column heading.

3347

},

3348

],

3349

"image": { # The image response message. # Optional. Image which should be displayed on the card.

3350

"imageUri": "A String", # Optional. The public URI to an image file.

3351

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3352

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3353

},

3354

"buttons": [ # Optional. List of buttons for the card.

3355

{ # The button object that appears at the bottom of a card.

3356

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3357

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

3358

},

3359

"title": "A String", # Required. The title of the button.

3360

},

3361

],

3362

"title": "A String", # Required. Title of the card.

3363

"rows": [ # Optional. Rows in this table of data.

3364

{ # Row of TableCard.

3365

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

3366

"cells": [ # Optional. List of cells that make up this row.

3367

{ # Cell of TableCardRow.

3368

"text": "A String", # Required. Text in this cell.

},

],

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

3375

"items": [ # Required. Carousel items.

3376

{ # An item in the carousel.

3377

"title": "A String", # Required. Title of the carousel item.

3378

"image": { # The image response message. # Optional. The image to display.

3379

"imageUri": "A String", # Optional. The public URI to an image file.

3380

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3381

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3382

},

3383

"description": "A String", # Optional. The body text of the card.

3384

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

3385

# dialog.

3386

"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.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

3397

# or website associated with this agent.

3398

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

3399

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

3400

# suggestion chip.

3401

},

3402

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

3403

# https://developers.google.com/actions/assistant/responses#browsing_carousel

3404

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

3405

# items.

3406

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

3407

# items, maximum of ten.

3408

{ # Browsing carousel tile

3409

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

3410

"image": { # The image response message. # Optional. Hero image for the carousel item.

3411

"imageUri": "A String", # Optional. The public URI to an image file.

3412

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3413

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3414

},

3415

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

3416

# text.

3417

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

3418

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

3419

# the URL. Defaults to opening via web browser.

3420

"url": "A String", # Required. URL

3421

},

3422

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

3423

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

3428

# This message in `QueryResult.fulfillment_messages` and

3429

# `WebhookResponse.fulfillment_messages` should contain only one

3430

# `SimpleResponse`.

3431

"simpleResponses": [ # Required. The list of simple responses.

3432

{ # The simple response message containing speech or text.

3433

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

3434

# speech output. Mutually exclusive with ssml.

3435

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

3436

# response to the user in the SSML format. Mutually exclusive with

3437

# text_to_speech.

3438

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

3443

"phoneNumber": "A String", # Required. The phone number to transfer the call to

3444

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

3445

#

3446

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

3447

},

3448

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

3449

"mediaObjects": [ # Required. List of media objects.

3450

{ # Response media object for media content card.

3451

"largeImage": { # The image response message. # Optional. Image to display above media content.

3452

"imageUri": "A String", # Optional. The public URI to an image file.

3453

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3454

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3455

},

3456

"name": "A String", # Required. Name of media card.

3457

"description": "A String", # Optional. Description of media card.

3458

"contentUrl": "A String", # Required. Url where the media is stored.

3459

"icon": { # The image response message. # Optional. Icon to display above media content.

3460

"imageUri": "A String", # Optional. The public URI to an image file.

3461

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3462

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

3467

},

3468

"image": { # The image response message. # Displays an image.

3469

"imageUri": "A String", # Optional. The public URI to an image file.

3470

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3471

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3472

},

3473

"payload": { # A custom platform-specific response.

3474

"a_key": "", # Properties of the object.

3475

},

3476

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

3477

#

3478

# Rich cards allow you to respond to users with more vivid content, e.g.

3479

# with media and suggestions.

3480

#

3481

# For more details about RBM rich cards, please see:

3482

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

3483

# You can group multiple rich cards into one using RbmCarouselCard but

3484

# carousel cards will give you less control over the card layout.

3485

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

3486

# Image preview alignment for standalone cards with horizontal layout.

3487

"cardOrientation": "A String", # Required. Orientation of the card.

3488

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

3489

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

3490

#

3491

# At least one of the title, description or media must be set.

3492

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3493

# be set. Media (image, GIF or a video) to include in the card.

3494

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

3512

# provide a thumbnail URI, the RBM platform displays a blank

3513

# placeholder thumbnail until the user's device downloads the file.

3514

# Depending on the user's setting, the file may not download

3515

# automatically and may require the user to tap a download button.

3516

"height": "A String", # Required for cards with vertical orientation. The height of the media

3517

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

3518

# For a standalone card with horizontal layout, height is not

3519

# customizable, and this field is ignored.

3520

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

3521

# determines the MIME type of the file from the content-type field in

3522

# the HTTP headers when the platform fetches the file. The content-type

3523

# field must be present and accurate in the HTTP response from the URL.

3524

},

3525

"suggestions": [ # Optional. List of suggestions to include in the card.

3526

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3527

# easily select/click a predefined response or perform an action (like

3528

# opening a web uri).

3529

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3530

# instead of typing in their own response.

3531

"text": "A String", # Suggested reply text.

3532

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3533

# when the user taps the suggested reply. This data will be also

3534

# forwarded to webhook to allow performing custom business logic.

3535

},

3536

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3537

# can choose from the card.

3538

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3539

# when the user taps the suggested action. This data will be also

3540

# forwarded to webhook to allow performing custom business logic.

3541

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3542

# to send back to the agent (https://goo.gl/GXotJW).

3543

},

3544

"text": "A String", # Text to display alongside the action.

3545

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3546

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3547

# registered as the default handler for the URL, then this app will be

3548

# opened instead, and its icon will be used in the suggested action UI.

3549

"uri": "A String", # Required. The uri to open on the user device

3550

},

3551

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3552

# but does not dial automatically (https://goo.gl/ergbB2).

3553

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3554

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3555

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

3562

#

3563

# At least one of the title, description or media must be set.

},

},

},

],

"action": "A String", # Optional. The name of the action associated with the intent.

3569

# Note: The action name must not contain whitespaces.

3570

"name": "A String", # Optional. The unique identifier of this intent.

3571

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

3572

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3573

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3574

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

3575

"inputContextNames": [ # Optional. The list of context names required for this intent to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3576

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3577

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3578

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3579

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3580

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

3581

# a direct or indirect parent. We populate this field only in the output.

3582

{ # Represents a single followup intent in the chain.

3583

"followupIntentName": "A String", # The unique identifier of the followup intent.

3584

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3585

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

3586

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3587

},

3588

],

3589

"displayName": "A String", # Required. The name of this intent.

3590

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

3591

# followup intents. It identifies the correct followup intents chain for

3592

# this intent.

3593

#

3594

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3595

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

3596

# Note: If `ml_disabled` setting is set to true, then this intent is not

3597

# taken into account during inference in `ML ONLY` match mode. Also,

3598

# auto-markup in the UI is turned off.

3599

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

3600

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3601

# Note: If `ml_enabled` setting is set to false, then this intent is not

3602

# taken into account during inference in `ML ONLY` match mode. Also,

3603

# auto-markup in the UI is turned off.

3604

# DEPRECATED! Please use `ml_disabled` field instead.

3605

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

3606

# then the default value is determined as follows:

3607

# - Before April 15th, 2018 the default is:

3608

# ml_enabled = false / ml_disabled = true.

3609

# - After April 15th, 2018 the default is:

3610

# ml_enabled = true / ml_disabled = false.

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^]

3615

<code class="details" id="list">list(parent, languageCode=None, pageToken=None, pageSize=None, intentView=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3616

<pre>Returns the list of all intents in the specified agent.

3617

3618

Args:

3619

parent: string, Required. The agent to list all intents from.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3620

Format: `projects/<Project ID>/agent`. (required)

3621

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3622

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3623

For more information, see

3624

[Multilingual intent and entity

3625

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3626

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]

3627

pageSize: integer, Optional. The maximum number of items to return in a single page. By

3628

default 100 and at most 1000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3629

intentView: string, Optional. The resource view to apply to the returned intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3630

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3637

3638

{ # The response message for Intents.ListIntents.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3639

"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]

3640

# returned based on the page_size field in the request.

3641

{ # Represents an intent.

3642

# Intents convert a number of user expressions or patterns into an action. An

3643

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3644

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3645

# trained on.

3646

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3647

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3648

# The parts are concatenated in order to form the training phrase.

3649

#

3650

# Note: The API does not automatically annotate training phrases like the

3651

# Dialogflow Console does.

3652

#

3653

# Note: Do not forget to include whitespace at part boundaries,

3654

# so the training phrase is well formatted when the parts are concatenated.

3655

#

3656

# If the training phrase does not need to be annotated with parameters,

3657

# you just need a single part with only the Part.text field set.

3658

#

3659

# If you want to annotate the training phrase, you must create multiple

3660

# parts, where the fields of each part are populated in one of two ways:

3661

#

3662

# - `Part.text` is set to a part of the phrase that has no parameters.

3663

# - `Part.text` is set to a part of the phrase that you want to annotate,

3664

# and the `entity_type`, `alias`, and `user_defined` fields are all

3665

# set.

3666

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3667

"alias": "A String", # Optional. The parameter name for the value extracted from the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3668

# annotated part of the example.

3669

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3670

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3671

# This field is set to true when the Dialogflow Console is used to

3672

# manually annotate the part. When creating an annotated part with the

3673

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3674

"text": "A String", # Required. The text for this part.

3675

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3676

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3677

},

3678

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3679

"name": "A String", # Output only. The unique identifier of this training phrase.

3680

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3681

# the intent. Each time a developer adds an existing sample by editing an

3682

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3683

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3684

},

3685

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3686

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

3687

# session when this intent is matched.

3688

"parameters": [ # Optional. The collection of parameters associated with the intent.

3689

{ # Represents intent parameters.

3690

"displayName": "A String", # Required. The name of the parameter.

3691

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3692

# describes values of the parameter. If the parameter is

3693

# required, this must be provided.

3694

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3695

# user in order to collect a value for the parameter.

3696

"A String",

3697

],

3698

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3699

# result.

3700

# Default values can be extracted from contexts by using the following

3701

# syntax: `#context_name.parameter_name`.

3702

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3703

# whether the intent cannot be completed without collecting the parameter

3704

# value.

3705

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

3706

"name": "A String", # The unique identifier of this parameter.

3707

"value": "A String", # Optional. The definition of the parameter value. It can be:

3708

#

3709

# - a constant string,

3710

# - a parameter value defined as `$parameter_name`,

3711

# - an original parameter value defined as `$parameter_name.original`,

3712

# - a parameter value from some context defined as

3713

# `#context_name.parameter_name`.

3714

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3715

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3716

"events": [ # Optional. The collection of event names that trigger the intent.

3717

# If the collection of input contexts is not empty, all of the contexts must

3718

# be present in the active user session for an event to trigger this intent.

3719

# Event names are limited to 150 characters.

3720

"A String",

3721

],

3722

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

3723

# chain of followup intents. You can set this field when creating an intent,

3724

# for example with CreateIntent or

3725

# BatchUpdateIntents, in order to make this

3726

# intent a followup intent.

3727

#

3728

# It identifies the parent followup intent.

3729

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3730

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3731

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3732

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3733

# - If the supplied value is unspecified or 0, the service

3734

# translates the value to 500,000, which corresponds to the

3735

# `Normal` priority in the console.

3736

# - If the supplied value is negative, the intent is ignored

3737

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3738

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

3739

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

3740

# to close interaction with an end user. Default is false.

3741

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3742

# is matched. Context messages in this collection should not set the

3743

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3744

# when the intent is matched.

3745

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3746

{ # Represents a context.

3747

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3748

# context expires. The default is `0`. If set to `0`, the context expires

3749

# immediately. Contexts expire automatically after 20 minutes if there

3750

# are no matching queries.

3751

"name": "A String", # Required. The unique identifier of the context. Format:

3752

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3753

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3754

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3755

#

3756

# The `Context ID` is always converted to lowercase, may only contain

3757

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3758

#

3759

# If `Environment ID` is not specified, we assume default 'draft'

3760

# environment. If `User ID` is not specified, we assume default '-' user.

3761

#

3762

# The following context names are reserved for internal use by Dialogflow.

3763

# You should not use these contexts or create contexts with these names:

3764

#

3765

# * `__system_counters__`

3766

# * `*_id_dialog_context`

3767

# * `*_dialog_params_size`

3768

"parameters": { # Optional. The collection of parameters associated with this context.

3769

#

3770

# Depending on your protocol or client library language, this is a

3771

# map, associative array, symbol table, dictionary, or JSON object

3772

# composed of a collection of (MapKey, MapValue) pairs:

3773

#

3774

# - MapKey type: string

3775

# - MapKey value: parameter name

3776

# - MapValue type:

3777

# - If parameter's entity type is a composite entity: map

3778

# - Else: string or number, depending on parameter value type

3779

# - MapValue value:

3780

# - If parameter's entity type is a composite entity:

3781

# map from composite entity property names to property values

3782

# - Else: parameter value

3783

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3788

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3789

"A String",

3790

],

3791

"messages": [ # Optional. The collection of rich messages corresponding to the

3792

# `Response` field in the Dialogflow console.

3793

{ # Corresponds to the `Response` field in the Dialogflow console.

3794

"text": { # The text response message. # Returns a text response.

3795

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

3800

#

3801

# Rich cards allow you to respond to users with more vivid content, e.g.

3802

# with media and suggestions.

3803

#

3804

# For more details about RBM rich cards, please see:

3805

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

3806

# If you want to show a single card with more control over the layout,

3807

# please use RbmStandaloneCard instead.

3808

"cardWidth": "A String", # Required. The width of the cards in the carousel.

3809

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

3810

# 2 cards and at most 10.

3811

{ # Rich Business Messaging (RBM) Card content

3812

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

3813

#

3814

# At least one of the title, description or media must be set.

3815

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3816

# be set. Media (image, GIF or a video) to include in the card.

3817

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

3835

# provide a thumbnail URI, the RBM platform displays a blank

3836

# placeholder thumbnail until the user's device downloads the file.

3837

# Depending on the user's setting, the file may not download

3838

# automatically and may require the user to tap a download button.

3839

"height": "A String", # Required for cards with vertical orientation. The height of the media

3840

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

3841

# For a standalone card with horizontal layout, height is not

3842

# customizable, and this field is ignored.

3843

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

3844

# determines the MIME type of the file from the content-type field in

3845

# the HTTP headers when the platform fetches the file. The content-type

3846

# field must be present and accurate in the HTTP response from the URL.

3847

},

3848

"suggestions": [ # Optional. List of suggestions to include in the card.

3849

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3850

# easily select/click a predefined response or perform an action (like

3851

# opening a web uri).

3852

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3853

# instead of typing in their own response.

3854

"text": "A String", # Suggested reply text.

3855

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3856

# when the user taps the suggested reply. This data will be also

3857

# forwarded to webhook to allow performing custom business logic.

3858

},

3859

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3860

# can choose from the card.

3861

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3862

# when the user taps the suggested action. This data will be also

3863

# forwarded to webhook to allow performing custom business logic.

3864

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3865

# to send back to the agent (https://goo.gl/GXotJW).

3866

},

3867

"text": "A String", # Text to display alongside the action.

3868

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3869

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3870

# registered as the default handler for the URL, then this app will be

3871

# opened instead, and its icon will be used in the suggested action UI.

3872

"uri": "A String", # Required. The uri to open on the user device

3873

},

3874

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3875

# but does not dial automatically (https://goo.gl/ergbB2).

3876

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3877

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3878

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

3885

#

3886

# At least one of the title, description or media must be set.

},

],

},

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

3891

"suggestions": [ # Required. The list of suggested replies.

3892

{ # The suggestion chip message that the user can tap to quickly post a reply

3893

# to the conversation.

3894

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

3899

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

3900

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

3901

# play, e.g., "gs://bucket/object". The object must contain a single

3902

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

3903

#

3904

# This object must be readable by the `service-<Project

3905

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

3906

# where <Project Number> is the number of the Telephony Gateway project

3907

# (usually the same as the Dialogflow agent project). If the Google Cloud

3908

# Storage bucket is in the Telephony Gateway project, this permission is

3909

# added by default when enabling the Dialogflow V2 API.

3910

#

3911

# For audio from other sources, consider using the

3912

# `TelephonySynthesizeSpeech` message with SSML.

3913

},

3914

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

3915

"title": "A String", # Optional. The overall title of the list.

3916

"subtitle": "A String", # Optional. Subtitle of the list.

3917

"items": [ # Required. List items.

3918

{ # An item in the list.

3919

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3920

# dialog.

3921

"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

3926

# response is given.

3927

},

3928

"title": "A String", # Required. The title of the list item.

3929

"image": { # The image response message. # Optional. The image to display.

3930

"imageUri": "A String", # Optional. The public URI to an image file.

3931

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3932

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3933

},

3934

"description": "A String", # Optional. The main text describing the item.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

3939

#

3940

# RBM allows businesses to send enriched and branded versions of SMS. See

3941

# https://jibe.google.com/business-messaging.

3942

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

3943

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3944

# easily select/click a predefined response or perform an action (like

3945

# opening a web uri).

3946

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3947

# instead of typing in their own response.

3948

"text": "A String", # Suggested reply text.

3949

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3950

# when the user taps the suggested reply. This data will be also

3951

# forwarded to webhook to allow performing custom business logic.

3952

},

3953

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3954

# can choose from the card.

3955

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3956

# when the user taps the suggested action. This data will be also

3957

# forwarded to webhook to allow performing custom business logic.

3958

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3959

# to send back to the agent (https://goo.gl/GXotJW).

3960

},

3961

"text": "A String", # Text to display alongside the action.

3962

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3963

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3964

# registered as the default handler for the URL, then this app will be

3965

# opened instead, and its icon will be used in the suggested action UI.

3966

"uri": "A String", # Required. The uri to open on the user device

3967

},

3968

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3969

# but does not dial automatically (https://goo.gl/ergbB2).

3970

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3971

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3972

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

3979

},

3980

"quickReplies": { # The quick replies response message. # Displays quick replies.

3981

"title": "A String", # Optional. The title of the collection of quick replies.

3982

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

3987

# Telephony Gateway.

3988

#

3989

# Telephony Gateway takes the synthesizer settings from

3990

# `DetectIntentResponse.output_audio_config` which can either be set

3991

# at request-level or can come from the agent-level synthesizer config.

3992

"text": "A String", # The raw text to be synthesized.

3993

"ssml": "A String", # The SSML to be synthesized. For more information, see

3994

# [SSML](https://developers.google.com/actions/reference/ssml).

3995

},

3996

"card": { # The card response message. # Displays a card.

3997

"imageUri": "A String", # Optional. The public URI to an image file for the card.

3998

"title": "A String", # Optional. The title of the card.

3999

"buttons": [ # Optional. The collection of card buttons.

4000

{ # Optional. Contains information about a button.

4001

"text": "A String", # Optional. The text to show on the button.

4002

"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.

4007

},

4008

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

4009

"title": "A String", # Optional. The title of the card.

4010

"image": { # The image response message. # Optional. The image for the card.

4011

"imageUri": "A String", # Optional. The public URI to an image file.

4012

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4013

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4014

},

4015

"formattedText": "A String", # Required, unless image is present. The body text of the card.

4016

"buttons": [ # Optional. The collection of card buttons.

4017

{ # The button object that appears at the bottom of a card.

4018

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4019

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4020

},

4021

"title": "A String", # Required. The title of the button.

4022

},

4023

],

4024

"subtitle": "A String", # Optional. The subtitle of the card.

4025

},

4026

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

4027

"subtitle": "A String", # Optional. Subtitle to the title.

4028

"columnProperties": [ # Optional. Display properties for the columns in this table.

4029

{ # Column properties for TableCard.

4030

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

4031

"header": "A String", # Required. Column heading.

4032

},

4033

],

4034

"image": { # The image response message. # Optional. Image which should be displayed on the card.

4035

"imageUri": "A String", # Optional. The public URI to an image file.

4036

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4037

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4038

},

4039

"buttons": [ # Optional. List of buttons for the card.

4040

{ # The button object that appears at the bottom of a card.

4041

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4042

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4043

},

4044

"title": "A String", # Required. The title of the button.

4045

},

4046

],

4047

"title": "A String", # Required. Title of the card.

4048

"rows": [ # Optional. Rows in this table of data.

4049

{ # Row of TableCard.

4050

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

4051

"cells": [ # Optional. List of cells that make up this row.

4052

{ # Cell of TableCardRow.

4053

"text": "A String", # Required. Text in this cell.

},

],

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

4060

"items": [ # Required. Carousel items.

4061

{ # An item in the carousel.

4062

"title": "A String", # Required. Title of the carousel item.

4063

"image": { # The image response message. # Optional. The image to display.

4064

"imageUri": "A String", # Optional. The public URI to an image file.

4065

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4066

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4067

},

4068

"description": "A String", # Optional. The body text of the card.

4069

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

4070

# dialog.

4071

"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.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

4082

# or website associated with this agent.

4083

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

4084

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

4085

# suggestion chip.

4086

},

4087

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

4088

# https://developers.google.com/actions/assistant/responses#browsing_carousel

4089

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

4090

# items.

4091

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

4092

# items, maximum of ten.

4093

{ # Browsing carousel tile

4094

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

4095

"image": { # The image response message. # Optional. Hero image for the carousel item.

4096

"imageUri": "A String", # Optional. The public URI to an image file.

4097

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4098

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4099

},

4100

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

4101

# text.

4102

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

4103

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

4104

# the URL. Defaults to opening via web browser.

4105

"url": "A String", # Required. URL

4106

},

4107

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

4108

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

4113

# This message in `QueryResult.fulfillment_messages` and

4114

# `WebhookResponse.fulfillment_messages` should contain only one

4115

# `SimpleResponse`.

4116

"simpleResponses": [ # Required. The list of simple responses.

4117

{ # The simple response message containing speech or text.

4118

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

4119

# speech output. Mutually exclusive with ssml.

4120

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

4121

# response to the user in the SSML format. Mutually exclusive with

4122

# text_to_speech.

4123

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

4128

"phoneNumber": "A String", # Required. The phone number to transfer the call to

4129

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

4130

#

4131

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

4132

},

4133

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

4134

"mediaObjects": [ # Required. List of media objects.

4135

{ # Response media object for media content card.

4136

"largeImage": { # The image response message. # Optional. Image to display above media content.

4137

"imageUri": "A String", # Optional. The public URI to an image file.

4138

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4139

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4140

},

4141

"name": "A String", # Required. Name of media card.

4142

"description": "A String", # Optional. Description of media card.

4143

"contentUrl": "A String", # Required. Url where the media is stored.

4144

"icon": { # The image response message. # Optional. Icon to display above media content.

4145

"imageUri": "A String", # Optional. The public URI to an image file.

4146

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4147

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

4152

},

4153

"image": { # The image response message. # Displays an image.

4154

"imageUri": "A String", # Optional. The public URI to an image file.

4155

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4156

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4157

},

4158

"payload": { # A custom platform-specific response.

4159

"a_key": "", # Properties of the object.

4160

},

4161

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

4162

#

4163

# Rich cards allow you to respond to users with more vivid content, e.g.

4164

# with media and suggestions.

4165

#

4166

# For more details about RBM rich cards, please see:

4167

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

4168

# You can group multiple rich cards into one using RbmCarouselCard but

4169

# carousel cards will give you less control over the card layout.

4170

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

4171

# Image preview alignment for standalone cards with horizontal layout.

4172

"cardOrientation": "A String", # Required. Orientation of the card.

4173

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

4174

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4175

#

4176

# At least one of the title, description or media must be set.

4177

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4178

# be set. Media (image, GIF or a video) to include in the card.

4179

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

4197

# provide a thumbnail URI, the RBM platform displays a blank

4198

# placeholder thumbnail until the user's device downloads the file.

4199

# Depending on the user's setting, the file may not download

4200

# automatically and may require the user to tap a download button.

4201

"height": "A String", # Required for cards with vertical orientation. The height of the media

4202

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

4203

# For a standalone card with horizontal layout, height is not

4204

# customizable, and this field is ignored.

4205

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4206

# determines the MIME type of the file from the content-type field in

4207

# the HTTP headers when the platform fetches the file. The content-type

4208

# field must be present and accurate in the HTTP response from the URL.

4209

},

4210

"suggestions": [ # Optional. List of suggestions to include in the card.

4211

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4212

# easily select/click a predefined response or perform an action (like

4213

# opening a web uri).

4214

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4215

# instead of typing in their own response.

4216

"text": "A String", # Suggested reply text.

4217

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4218

# when the user taps the suggested reply. This data will be also

4219

# forwarded to webhook to allow performing custom business logic.

4220

},

4221

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4222

# can choose from the card.

4223

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4224

# when the user taps the suggested action. This data will be also

4225

# forwarded to webhook to allow performing custom business logic.

4226

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4227

# to send back to the agent (https://goo.gl/GXotJW).

4228

},

4229

"text": "A String", # Text to display alongside the action.

4230

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4231

# (https://goo.gl/6GLJD2). If the user has an app installed that is

4232

# registered as the default handler for the URL, then this app will be

4233

# opened instead, and its icon will be used in the suggested action UI.

4234

"uri": "A String", # Required. The uri to open on the user device

4235

},

4236

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4237

# but does not dial automatically (https://goo.gl/ergbB2).

4238

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4239

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4240

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4247

#

4248

# At least one of the title, description or media must be set.

},

},

},

],

"action": "A String", # Optional. The name of the action associated with the intent.

4254

# Note: The action name must not contain whitespaces.

4255

"name": "A String", # Optional. The unique identifier of this intent.

4256

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

4257

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4258

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4259

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

4260

"inputContextNames": [ # Optional. The list of context names required for this intent to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4261

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4262

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4263

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4264

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4265

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

4266

# a direct or indirect parent. We populate this field only in the output.

4267

{ # Represents a single followup intent in the chain.

4268

"followupIntentName": "A String", # The unique identifier of the followup intent.

4269

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4270

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

4271

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4272

},

4273

],

4274

"displayName": "A String", # Required. The name of this intent.

4275

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

4276

# followup intents. It identifies the correct followup intents chain for

4277

# this intent.

4278

#

4279

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4280

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

4281

# Note: If `ml_disabled` setting is set to true, then this intent is not

4282

# taken into account during inference in `ML ONLY` match mode. Also,

4283

# auto-markup in the UI is turned off.

4284

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

4285

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4286

# Note: If `ml_enabled` setting is set to false, then this intent is not

4287

# taken into account during inference in `ML ONLY` match mode. Also,

4288

# auto-markup in the UI is turned off.

4289

# DEPRECATED! Please use `ml_disabled` field instead.

4290

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

4291

# then the default value is determined as follows:

4292

# - Before April 15th, 2018 the default is:

4293

# ml_enabled = false / ml_disabled = true.

4294

# - After April 15th, 2018 the default is:

4295

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4296

},

4297

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4298

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

4299

# 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>

4305

<pre>Retrieves the next page of results.

4306

4307

Args:

4308

previous_request: The request for the previous page. (required)

4309

previous_response: The response from the request for the previous page. (required)

4310

4311

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4312

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]

4313

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^]

4318

<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]

4319

<pre>Updates the specified intent.

4320

4321

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4322

name: string, Optional. The unique identifier of this intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4323

Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

4324

methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4325

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

4326

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4327

The object takes the form of:

4328

4329

{ # Represents an intent.

4330

# Intents convert a number of user expressions or patterns into an action. An

4331

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4332

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4333

# trained on.

4334

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4335

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4336

# The parts are concatenated in order to form the training phrase.

4337

#

4338

# Note: The API does not automatically annotate training phrases like the

4339

# Dialogflow Console does.

4340

#

4341

# Note: Do not forget to include whitespace at part boundaries,

4342

# so the training phrase is well formatted when the parts are concatenated.

4343

#

4344

# If the training phrase does not need to be annotated with parameters,

4345

# you just need a single part with only the Part.text field set.

4346

#

4347

# If you want to annotate the training phrase, you must create multiple

4348

# parts, where the fields of each part are populated in one of two ways:

4349

#

4350

# - `Part.text` is set to a part of the phrase that has no parameters.

4351

# - `Part.text` is set to a part of the phrase that you want to annotate,

4352

# and the `entity_type`, `alias`, and `user_defined` fields are all

4353

# set.

4354

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4355

"alias": "A String", # Optional. The parameter name for the value extracted from the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4356

# annotated part of the example.

4357

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4358

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4359

# This field is set to true when the Dialogflow Console is used to

4360

# manually annotate the part. When creating an annotated part with the

4361

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4362

"text": "A String", # Required. The text for this part.

4363

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

4364

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4365

},

4366

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4367

"name": "A String", # Output only. The unique identifier of this training phrase.

4368

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4369

# the intent. Each time a developer adds an existing sample by editing an

4370

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4371

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4372

},

4373

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4374

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

4375

# session when this intent is matched.

4376

"parameters": [ # Optional. The collection of parameters associated with the intent.

4377

{ # Represents intent parameters.

4378

"displayName": "A String", # Required. The name of the parameter.

4379

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

4380

# describes values of the parameter. If the parameter is

4381

# required, this must be provided.

4382

"prompts": [ # Optional. The collection of prompts that the agent can present to the

4383

# user in order to collect a value for the parameter.

4384

"A String",

4385

],

4386

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

4387

# result.

4388

# Default values can be extracted from contexts by using the following

4389

# syntax: `#context_name.parameter_name`.

4390

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

4391

# whether the intent cannot be completed without collecting the parameter

4392

# value.

4393

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

4394

"name": "A String", # The unique identifier of this parameter.

4395

"value": "A String", # Optional. The definition of the parameter value. It can be:

4396

#

4397

# - a constant string,

4398

# - a parameter value defined as `$parameter_name`,

4399

# - an original parameter value defined as `$parameter_name.original`,

4400

# - a parameter value from some context defined as

4401

# `#context_name.parameter_name`.

4402

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4403

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4404

"events": [ # Optional. The collection of event names that trigger the intent.

4405

# If the collection of input contexts is not empty, all of the contexts must

4406

# be present in the active user session for an event to trigger this intent.

4407

# Event names are limited to 150 characters.

4408

"A String",

4409

],

4410

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

4411

# chain of followup intents. You can set this field when creating an intent,

4412

# for example with CreateIntent or

4413

# BatchUpdateIntents, in order to make this

4414

# intent a followup intent.

4415

#

4416

# It identifies the parent followup intent.

4417

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4418

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4419

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4420

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4421

# - If the supplied value is unspecified or 0, the service

4422

# translates the value to 500,000, which corresponds to the

4423

# `Normal` priority in the console.

4424

# - If the supplied value is negative, the intent is ignored

4425

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4426

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

4427

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

4428

# to close interaction with an end user. Default is false.

4429

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

4430

# is matched. Context messages in this collection should not set the

4431

# parameters field. Setting the `lifespan_count` to 0 will reset the context

4432

# when the intent is matched.

4433

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

4434

{ # Represents a context.

4435

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

4436

# context expires. The default is `0`. If set to `0`, the context expires

4437

# immediately. Contexts expire automatically after 20 minutes if there

4438

# are no matching queries.

4439

"name": "A String", # Required. The unique identifier of the context. Format:

4440

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

4441

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

4442

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

4443

#

4444

# The `Context ID` is always converted to lowercase, may only contain

4445

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

4446

#

4447

# If `Environment ID` is not specified, we assume default 'draft'

4448

# environment. If `User ID` is not specified, we assume default '-' user.

4449

#

4450

# The following context names are reserved for internal use by Dialogflow.

4451

# You should not use these contexts or create contexts with these names:

4452

#

4453

# * `__system_counters__`

4454

# * `*_id_dialog_context`

4455

# * `*_dialog_params_size`

4456

"parameters": { # Optional. The collection of parameters associated with this context.

4457

#

4458

# Depending on your protocol or client library language, this is a

4459

# map, associative array, symbol table, dictionary, or JSON object

4460

# composed of a collection of (MapKey, MapValue) pairs:

4461

#

4462

# - MapKey type: string

4463

# - MapKey value: parameter name

4464

# - MapValue type:

4465

# - If parameter's entity type is a composite entity: map

4466

# - Else: string or number, depending on parameter value type

4467

# - MapValue value:

4468

# - If parameter's entity type is a composite entity:

4469

# map from composite entity property names to property values

4470

# - Else: parameter value

4471

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

4476

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

4477

"A String",

4478

],

4479

"messages": [ # Optional. The collection of rich messages corresponding to the

4480

# `Response` field in the Dialogflow console.

4481

{ # Corresponds to the `Response` field in the Dialogflow console.

4482

"text": { # The text response message. # Returns a text response.

4483

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

4488

#

4489

# Rich cards allow you to respond to users with more vivid content, e.g.

4490

# with media and suggestions.

4491

#

4492

# For more details about RBM rich cards, please see:

4493

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

4494

# If you want to show a single card with more control over the layout,

4495

# please use RbmStandaloneCard instead.

4496

"cardWidth": "A String", # Required. The width of the cards in the carousel.

4497

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

4498

# 2 cards and at most 10.

4499

{ # Rich Business Messaging (RBM) Card content

4500

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4501

#

4502

# At least one of the title, description or media must be set.

4503

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4504

# be set. Media (image, GIF or a video) to include in the card.

4505

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

4523

# provide a thumbnail URI, the RBM platform displays a blank

4524

# placeholder thumbnail until the user's device downloads the file.

4525

# Depending on the user's setting, the file may not download

4526

# automatically and may require the user to tap a download button.

4527

"height": "A String", # Required for cards with vertical orientation. The height of the media

4528

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

4529

# For a standalone card with horizontal layout, height is not

4530

# customizable, and this field is ignored.

4531

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4532

# determines the MIME type of the file from the content-type field in

4533

# the HTTP headers when the platform fetches the file. The content-type

4534

# field must be present and accurate in the HTTP response from the URL.

4535

},

4536

"suggestions": [ # Optional. List of suggestions to include in the card.

4537

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4538

# easily select/click a predefined response or perform an action (like

4539

# opening a web uri).

4540

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4541

# instead of typing in their own response.

4542

"text": "A String", # Suggested reply text.

4543

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4544

# when the user taps the suggested reply. This data will be also

4545

# forwarded to webhook to allow performing custom business logic.

4546

},

4547

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4548

# can choose from the card.

4549

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4550

# when the user taps the suggested action. This data will be also

4551

# forwarded to webhook to allow performing custom business logic.

4552

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4553

# to send back to the agent (https://goo.gl/GXotJW).

4554

},

4555

"text": "A String", # Text to display alongside the action.

4556

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4557

# (https://goo.gl/6GLJD2). If the user has an app installed that is

4558

# registered as the default handler for the URL, then this app will be

4559

# opened instead, and its icon will be used in the suggested action UI.

4560

"uri": "A String", # Required. The uri to open on the user device

4561

},

4562

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4563

# but does not dial automatically (https://goo.gl/ergbB2).

4564

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4565

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4566

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4573

#

4574

# At least one of the title, description or media must be set.

},

],

},

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

4579

"suggestions": [ # Required. The list of suggested replies.

4580

{ # The suggestion chip message that the user can tap to quickly post a reply

4581

# to the conversation.

4582

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

4587

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

4588

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

4589

# play, e.g., "gs://bucket/object". The object must contain a single

4590

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

4591

#

4592

# This object must be readable by the `service-<Project

4593

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

4594

# where <Project Number> is the number of the Telephony Gateway project

4595

# (usually the same as the Dialogflow agent project). If the Google Cloud

4596

# Storage bucket is in the Telephony Gateway project, this permission is

4597

# added by default when enabling the Dialogflow V2 API.

4598

#

4599

# For audio from other sources, consider using the

4600

# `TelephonySynthesizeSpeech` message with SSML.

4601

},

4602

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

4603

"title": "A String", # Optional. The overall title of the list.

4604

"subtitle": "A String", # Optional. Subtitle of the list.

4605

"items": [ # Required. List items.

4606

{ # An item in the list.

4607

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

4608

# dialog.

4609

"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

4614

# response is given.

4615

},

4616

"title": "A String", # Required. The title of the list item.

4617

"image": { # The image response message. # Optional. The image to display.

4618

"imageUri": "A String", # Optional. The public URI to an image file.

4619

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4620

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4621

},

4622

"description": "A String", # Optional. The main text describing the item.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

4627

#

4628

# RBM allows businesses to send enriched and branded versions of SMS. See

4629

# https://jibe.google.com/business-messaging.

4630

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

4631

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4632

# easily select/click a predefined response or perform an action (like

4633

# opening a web uri).

4634

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4635

# instead of typing in their own response.

4636

"text": "A String", # Suggested reply text.

4637

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4638

# when the user taps the suggested reply. This data will be also

4639

# forwarded to webhook to allow performing custom business logic.

4640

},

4641

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4642

# can choose from the card.

4643

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4644

# when the user taps the suggested action. This data will be also

4645

# forwarded to webhook to allow performing custom business logic.

4646

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4647

# to send back to the agent (https://goo.gl/GXotJW).

4648

},

4649

"text": "A String", # Text to display alongside the action.

4650

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4651

# (https://goo.gl/6GLJD2). If the user has an app installed that is

4652

# registered as the default handler for the URL, then this app will be

4653

# opened instead, and its icon will be used in the suggested action UI.

4654

"uri": "A String", # Required. The uri to open on the user device

4655

},

4656

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4657

# but does not dial automatically (https://goo.gl/ergbB2).

4658

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4659

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4660

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

4667

},

4668

"quickReplies": { # The quick replies response message. # Displays quick replies.

4669

"title": "A String", # Optional. The title of the collection of quick replies.

4670

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

4675

# Telephony Gateway.

4676

#

4677

# Telephony Gateway takes the synthesizer settings from

4678

# `DetectIntentResponse.output_audio_config` which can either be set

4679

# at request-level or can come from the agent-level synthesizer config.

4680

"text": "A String", # The raw text to be synthesized.

4681

"ssml": "A String", # The SSML to be synthesized. For more information, see

4682

# [SSML](https://developers.google.com/actions/reference/ssml).

4683

},

4684

"card": { # The card response message. # Displays a card.

4685

"imageUri": "A String", # Optional. The public URI to an image file for the card.

4686

"title": "A String", # Optional. The title of the card.

4687

"buttons": [ # Optional. The collection of card buttons.

4688

{ # Optional. Contains information about a button.

4689

"text": "A String", # Optional. The text to show on the button.

4690

"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.

4695

},

4696

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

4697

"title": "A String", # Optional. The title of the card.

4698

"image": { # The image response message. # Optional. The image for the card.

4699

"imageUri": "A String", # Optional. The public URI to an image file.

4700

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4701

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4702

},

4703

"formattedText": "A String", # Required, unless image is present. The body text of the card.

4704

"buttons": [ # Optional. The collection of card buttons.

4705

{ # The button object that appears at the bottom of a card.

4706

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4707

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4708

},

4709

"title": "A String", # Required. The title of the button.

4710

},

4711

],

4712

"subtitle": "A String", # Optional. The subtitle of the card.

4713

},

4714

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

4715

"subtitle": "A String", # Optional. Subtitle to the title.

4716

"columnProperties": [ # Optional. Display properties for the columns in this table.

4717

{ # Column properties for TableCard.

4718

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

4719

"header": "A String", # Required. Column heading.

4720

},

4721

],

4722

"image": { # The image response message. # Optional. Image which should be displayed on the card.

4723

"imageUri": "A String", # Optional. The public URI to an image file.

4724

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4725

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4726

},

4727

"buttons": [ # Optional. List of buttons for the card.

4728

{ # The button object that appears at the bottom of a card.

4729

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4730

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4731

},

4732

"title": "A String", # Required. The title of the button.

4733

},

4734

],

4735

"title": "A String", # Required. Title of the card.

4736

"rows": [ # Optional. Rows in this table of data.

4737

{ # Row of TableCard.

4738

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

4739

"cells": [ # Optional. List of cells that make up this row.

4740

{ # Cell of TableCardRow.

4741

"text": "A String", # Required. Text in this cell.

},

],

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

4748

"items": [ # Required. Carousel items.

4749

{ # An item in the carousel.

4750

"title": "A String", # Required. Title of the carousel item.

4751

"image": { # The image response message. # Optional. The image to display.

4752

"imageUri": "A String", # Optional. The public URI to an image file.

4753

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4754

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4755

},

4756

"description": "A String", # Optional. The body text of the card.

4757

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

4758

# dialog.

4759

"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.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

4770

# or website associated with this agent.

4771

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

4772

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

4773

# suggestion chip.

4774

},

4775

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

4776

# https://developers.google.com/actions/assistant/responses#browsing_carousel

4777

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

4778

# items.

4779

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

4780

# items, maximum of ten.

4781

{ # Browsing carousel tile

4782

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

4783

"image": { # The image response message. # Optional. Hero image for the carousel item.

4784

"imageUri": "A String", # Optional. The public URI to an image file.

4785

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4786

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4787

},

4788

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

4789

# text.

4790

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

4791

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

4792

# the URL. Defaults to opening via web browser.

4793

"url": "A String", # Required. URL

4794

},

4795

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

4796

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

4801

# This message in `QueryResult.fulfillment_messages` and

4802

# `WebhookResponse.fulfillment_messages` should contain only one

4803

# `SimpleResponse`.

4804

"simpleResponses": [ # Required. The list of simple responses.

4805

{ # The simple response message containing speech or text.

4806

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

4807

# speech output. Mutually exclusive with ssml.

4808

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

4809

# response to the user in the SSML format. Mutually exclusive with

4810

# text_to_speech.

4811

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

4816

"phoneNumber": "A String", # Required. The phone number to transfer the call to

4817

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

4818

#

4819

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

4820

},

4821

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

4822

"mediaObjects": [ # Required. List of media objects.

4823

{ # Response media object for media content card.

4824

"largeImage": { # The image response message. # Optional. Image to display above media content.

4825

"imageUri": "A String", # Optional. The public URI to an image file.

4826

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4827

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4828

},

4829

"name": "A String", # Required. Name of media card.

4830

"description": "A String", # Optional. Description of media card.

4831

"contentUrl": "A String", # Required. Url where the media is stored.

4832

"icon": { # The image response message. # Optional. Icon to display above media content.

4833

"imageUri": "A String", # Optional. The public URI to an image file.

4834

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4835

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

4840

},

4841

"image": { # The image response message. # Displays an image.

4842

"imageUri": "A String", # Optional. The public URI to an image file.

4843

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4844

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4845

},

4846

"payload": { # A custom platform-specific response.

4847

"a_key": "", # Properties of the object.

4848

},

4849

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

4850

#

4851

# Rich cards allow you to respond to users with more vivid content, e.g.

4852

# with media and suggestions.

4853

#

4854

# For more details about RBM rich cards, please see:

4855

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

4856

# You can group multiple rich cards into one using RbmCarouselCard but

4857

# carousel cards will give you less control over the card layout.

4858

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

4859

# Image preview alignment for standalone cards with horizontal layout.

4860

"cardOrientation": "A String", # Required. Orientation of the card.

4861

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

4862

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4863

#

4864

# At least one of the title, description or media must be set.

4865

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4866

# be set. Media (image, GIF or a video) to include in the card.

4867

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

4885

# provide a thumbnail URI, the RBM platform displays a blank

4886

# placeholder thumbnail until the user's device downloads the file.

4887

# Depending on the user's setting, the file may not download

4888

# automatically and may require the user to tap a download button.

4889

"height": "A String", # Required for cards with vertical orientation. The height of the media

4890

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

4891

# For a standalone card with horizontal layout, height is not

4892

# customizable, and this field is ignored.

4893

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4894

# determines the MIME type of the file from the content-type field in

4895

# the HTTP headers when the platform fetches the file. The content-type

4896

# field must be present and accurate in the HTTP response from the URL.

4897

},

4898

"suggestions": [ # Optional. List of suggestions to include in the card.

4899

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4900

# easily select/click a predefined response or perform an action (like

4901

# opening a web uri).

4902

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4903

# instead of typing in their own response.

4904

"text": "A String", # Suggested reply text.

4905

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4906

# when the user taps the suggested reply. This data will be also

4907

# forwarded to webhook to allow performing custom business logic.

4908

},

4909

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4910

# can choose from the card.

4911

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4912

# when the user taps the suggested action. This data will be also

4913

# forwarded to webhook to allow performing custom business logic.

4914

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4915

# to send back to the agent (https://goo.gl/GXotJW).

4916

},

4917

"text": "A String", # Text to display alongside the action.

4918

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4919

# (https://goo.gl/6GLJD2). If the user has an app installed that is

4920

# registered as the default handler for the URL, then this app will be

4921

# opened instead, and its icon will be used in the suggested action UI.

4922

"uri": "A String", # Required. The uri to open on the user device

4923

},

4924

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4925

# but does not dial automatically (https://goo.gl/ergbB2).

4926

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4927

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4928

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4935

#

4936

# At least one of the title, description or media must be set.

},

},

},

],

"action": "A String", # Optional. The name of the action associated with the intent.

4942

# Note: The action name must not contain whitespaces.

4943

"name": "A String", # Optional. The unique identifier of this intent.

4944

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

4945

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4946

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4947

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

4948

"inputContextNames": [ # Optional. The list of context names required for this intent to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4949

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4950

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4951

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4952

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4953

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

4954

# a direct or indirect parent. We populate this field only in the output.

4955

{ # Represents a single followup intent in the chain.

4956

"followupIntentName": "A String", # The unique identifier of the followup intent.

4957

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4958

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

4959

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4960

},

4961

],

4962

"displayName": "A String", # Required. The name of this intent.

4963

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

4964

# followup intents. It identifies the correct followup intents chain for

4965

# this intent.

4966

#

4967

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4968

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

4969

# Note: If `ml_disabled` setting is set to true, then this intent is not

4970

# taken into account during inference in `ML ONLY` match mode. Also,

4971

# auto-markup in the UI is turned off.

4972

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

4973

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4974

# Note: If `ml_enabled` setting is set to false, then this intent is not

4975

# taken into account during inference in `ML ONLY` match mode. Also,

4976

# auto-markup in the UI is turned off.

4977

# DEPRECATED! Please use `ml_disabled` field instead.

4978

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

4979

# then the default value is determined as follows:

4980

# - Before April 15th, 2018 the default is:

4981

# ml_enabled = false / ml_disabled = true.

4982

# - After April 15th, 2018 the default is:

4983

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4984

}

4985

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4986

intentView: string, Optional. The resource view to apply to the returned intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4987

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4988

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4989

For more information, see

4990

[Multilingual intent and entity

4991

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4992

updateMask: string, Optional. The mask to control which fields get updated.

4993

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5000

5001

{ # Represents an intent.

5002

# Intents convert a number of user expressions or patterns into an action. An

5003

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5004

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5005

# trained on.

5006

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5007

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5008

# The parts are concatenated in order to form the training phrase.

5009

#

5010

# Note: The API does not automatically annotate training phrases like the

5011

# Dialogflow Console does.

5012

#

5013

# Note: Do not forget to include whitespace at part boundaries,

5014

# so the training phrase is well formatted when the parts are concatenated.

5015

#

5016

# If the training phrase does not need to be annotated with parameters,

5017

# you just need a single part with only the Part.text field set.

5018

#

5019

# If you want to annotate the training phrase, you must create multiple

5020

# parts, where the fields of each part are populated in one of two ways:

5021

#

5022

# - `Part.text` is set to a part of the phrase that has no parameters.

5023

# - `Part.text` is set to a part of the phrase that you want to annotate,

5024

# and the `entity_type`, `alias`, and `user_defined` fields are all

5025

# set.

5026

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5027

"alias": "A String", # Optional. The parameter name for the value extracted from the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5028

# annotated part of the example.

5029

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5030

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5031

# This field is set to true when the Dialogflow Console is used to

5032

# manually annotate the part. When creating an annotated part with the

5033

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5034

"text": "A String", # Required. The text for this part.

5035

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

5036

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5037

},

5038

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5039

"name": "A String", # Output only. The unique identifier of this training phrase.

5040

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5041

# the intent. Each time a developer adds an existing sample by editing an

5042

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5043

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5044

},

5045

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5046

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

5047

# session when this intent is matched.

5048

"parameters": [ # Optional. The collection of parameters associated with the intent.

5049

{ # Represents intent parameters.

5050

"displayName": "A String", # Required. The name of the parameter.

5051

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

5052

# describes values of the parameter. If the parameter is

5053

# required, this must be provided.

5054

"prompts": [ # Optional. The collection of prompts that the agent can present to the

5055

# user in order to collect a value for the parameter.

5056

"A String",

5057

],

5058

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

5059

# result.

5060

# Default values can be extracted from contexts by using the following

5061

# syntax: `#context_name.parameter_name`.

5062

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

5063

# whether the intent cannot be completed without collecting the parameter

5064

# value.

5065

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

5066

"name": "A String", # The unique identifier of this parameter.

5067

"value": "A String", # Optional. The definition of the parameter value. It can be:

5068

#

5069

# - a constant string,

5070

# - a parameter value defined as `$parameter_name`,

5071

# - an original parameter value defined as `$parameter_name.original`,

5072

# - a parameter value from some context defined as

5073

# `#context_name.parameter_name`.

5074

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5075

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5076

"events": [ # Optional. The collection of event names that trigger the intent.

5077

# If the collection of input contexts is not empty, all of the contexts must

5078

# be present in the active user session for an event to trigger this intent.

5079

# Event names are limited to 150 characters.

5080

"A String",

5081

],

5082

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

5083

# chain of followup intents. You can set this field when creating an intent,

5084

# for example with CreateIntent or

5085

# BatchUpdateIntents, in order to make this

5086

# intent a followup intent.

5087

#

5088

# It identifies the parent followup intent.

5089

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5090

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5091

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5092

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5093

# - If the supplied value is unspecified or 0, the service

5094

# translates the value to 500,000, which corresponds to the

5095

# `Normal` priority in the console.

5096

# - If the supplied value is negative, the intent is ignored

5097

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5098

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

5099

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

5100

# to close interaction with an end user. Default is false.

5101

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

5102

# is matched. Context messages in this collection should not set the

5103

# parameters field. Setting the `lifespan_count` to 0 will reset the context

5104

# when the intent is matched.

5105

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

5106

{ # Represents a context.

5107

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

5108

# context expires. The default is `0`. If set to `0`, the context expires

5109

# immediately. Contexts expire automatically after 20 minutes if there

5110

# are no matching queries.

5111

"name": "A String", # Required. The unique identifier of the context. Format:

5112

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

5113

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

5114

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

5115

#

5116

# The `Context ID` is always converted to lowercase, may only contain

5117

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

5118

#

5119

# If `Environment ID` is not specified, we assume default 'draft'

5120

# environment. If `User ID` is not specified, we assume default '-' user.

5121

#

5122

# The following context names are reserved for internal use by Dialogflow.

5123

# You should not use these contexts or create contexts with these names:

5124

#

5125

# * `__system_counters__`

5126

# * `*_id_dialog_context`

5127

# * `*_dialog_params_size`

5128

"parameters": { # Optional. The collection of parameters associated with this context.

5129

#

5130

# Depending on your protocol or client library language, this is a

5131

# map, associative array, symbol table, dictionary, or JSON object

5132

# composed of a collection of (MapKey, MapValue) pairs:

5133

#

5134

# - MapKey type: string

5135

# - MapKey value: parameter name

5136

# - MapValue type:

5137

# - If parameter's entity type is a composite entity: map

5138

# - Else: string or number, depending on parameter value type

5139

# - MapValue value:

5140

# - If parameter's entity type is a composite entity:

5141

# map from composite entity property names to property values

5142

# - Else: parameter value

5143

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

5148

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

5149

"A String",

5150

],

5151

"messages": [ # Optional. The collection of rich messages corresponding to the

5152

# `Response` field in the Dialogflow console.

5153

{ # Corresponds to the `Response` field in the Dialogflow console.

5154

"text": { # The text response message. # Returns a text response.

5155

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

5160

#

5161

# Rich cards allow you to respond to users with more vivid content, e.g.

5162

# with media and suggestions.

5163

#

5164

# For more details about RBM rich cards, please see:

5165

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

5166

# If you want to show a single card with more control over the layout,

5167

# please use RbmStandaloneCard instead.

5168

"cardWidth": "A String", # Required. The width of the cards in the carousel.

5169

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

5170

# 2 cards and at most 10.

5171

{ # Rich Business Messaging (RBM) Card content

5172

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

5173

#

5174

# At least one of the title, description or media must be set.

5175

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

5176

# be set. Media (image, GIF or a video) to include in the card.

5177

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

5195

# provide a thumbnail URI, the RBM platform displays a blank

5196

# placeholder thumbnail until the user's device downloads the file.

5197

# Depending on the user's setting, the file may not download

5198

# automatically and may require the user to tap a download button.

5199

"height": "A String", # Required for cards with vertical orientation. The height of the media

5200

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

5201

# For a standalone card with horizontal layout, height is not

5202

# customizable, and this field is ignored.

5203

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

5204

# determines the MIME type of the file from the content-type field in

5205

# the HTTP headers when the platform fetches the file. The content-type

5206

# field must be present and accurate in the HTTP response from the URL.

5207

},

5208

"suggestions": [ # Optional. List of suggestions to include in the card.

5209

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5210

# easily select/click a predefined response or perform an action (like

5211

# opening a web uri).

5212

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5213

# instead of typing in their own response.

5214

"text": "A String", # Suggested reply text.

5215

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5216

# when the user taps the suggested reply. This data will be also

5217

# forwarded to webhook to allow performing custom business logic.

5218

},

5219

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5220

# can choose from the card.

5221

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5222

# when the user taps the suggested action. This data will be also

5223

# forwarded to webhook to allow performing custom business logic.

5224

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5225

# to send back to the agent (https://goo.gl/GXotJW).

5226

},

5227

"text": "A String", # Text to display alongside the action.

5228

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5229

# (https://goo.gl/6GLJD2). If the user has an app installed that is

5230

# registered as the default handler for the URL, then this app will be

5231

# opened instead, and its icon will be used in the suggested action UI.

5232

"uri": "A String", # Required. The uri to open on the user device

5233

},

5234

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

5235

# but does not dial automatically (https://goo.gl/ergbB2).

5236

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5237

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5238

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

5245

#

5246

# At least one of the title, description or media must be set.

},

],

},

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

5251

"suggestions": [ # Required. The list of suggested replies.

5252

{ # The suggestion chip message that the user can tap to quickly post a reply

5253

# to the conversation.

5254

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

5259

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

5260

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

5261

# play, e.g., "gs://bucket/object". The object must contain a single

5262

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

5263

#

5264

# This object must be readable by the `service-<Project

5265

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

5266

# where <Project Number> is the number of the Telephony Gateway project

5267

# (usually the same as the Dialogflow agent project). If the Google Cloud

5268

# Storage bucket is in the Telephony Gateway project, this permission is

5269

# added by default when enabling the Dialogflow V2 API.

5270

#

5271

# For audio from other sources, consider using the

5272

# `TelephonySynthesizeSpeech` message with SSML.

5273

},

5274

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

5275

"title": "A String", # Optional. The overall title of the list.

5276

"subtitle": "A String", # Optional. Subtitle of the list.

5277

"items": [ # Required. List items.

5278

{ # An item in the list.

5279

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

5280

# dialog.

5281

"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

5286

# response is given.

5287

},

5288

"title": "A String", # Required. The title of the list item.

5289

"image": { # The image response message. # Optional. The image to display.

5290

"imageUri": "A String", # Optional. The public URI to an image file.

5291

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5292

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5293

},

5294

"description": "A String", # Optional. The main text describing the item.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

5299

#

5300

# RBM allows businesses to send enriched and branded versions of SMS. See

5301

# https://jibe.google.com/business-messaging.

5302

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

5303

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5304

# easily select/click a predefined response or perform an action (like

5305

# opening a web uri).

5306

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5307

# instead of typing in their own response.

5308

"text": "A String", # Suggested reply text.

5309

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5310

# when the user taps the suggested reply. This data will be also

5311

# forwarded to webhook to allow performing custom business logic.

5312

},

5313

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5314

# can choose from the card.

5315

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5316

# when the user taps the suggested action. This data will be also

5317

# forwarded to webhook to allow performing custom business logic.

5318

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5319

# to send back to the agent (https://goo.gl/GXotJW).

5320

},

5321

"text": "A String", # Text to display alongside the action.

5322

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5323

# (https://goo.gl/6GLJD2). If the user has an app installed that is

5324

# registered as the default handler for the URL, then this app will be

5325

# opened instead, and its icon will be used in the suggested action UI.

5326

"uri": "A String", # Required. The uri to open on the user device

5327

},

5328

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

5329

# but does not dial automatically (https://goo.gl/ergbB2).

5330

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5331

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5332

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

5339

},

5340

"quickReplies": { # The quick replies response message. # Displays quick replies.

5341

"title": "A String", # Optional. The title of the collection of quick replies.

5342

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

5347

# Telephony Gateway.

5348

#

5349

# Telephony Gateway takes the synthesizer settings from

5350

# `DetectIntentResponse.output_audio_config` which can either be set

5351

# at request-level or can come from the agent-level synthesizer config.

5352

"text": "A String", # The raw text to be synthesized.

5353

"ssml": "A String", # The SSML to be synthesized. For more information, see

5354

# [SSML](https://developers.google.com/actions/reference/ssml).

5355

},

5356

"card": { # The card response message. # Displays a card.

5357

"imageUri": "A String", # Optional. The public URI to an image file for the card.

5358

"title": "A String", # Optional. The title of the card.

5359

"buttons": [ # Optional. The collection of card buttons.

5360

{ # Optional. Contains information about a button.

5361

"text": "A String", # Optional. The text to show on the button.

5362

"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.

5367

},

5368

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

5369

"title": "A String", # Optional. The title of the card.

5370

"image": { # The image response message. # Optional. The image for the card.

5371

"imageUri": "A String", # Optional. The public URI to an image file.

5372

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5373

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5374

},

5375

"formattedText": "A String", # Required, unless image is present. The body text of the card.

5376

"buttons": [ # Optional. The collection of card buttons.

5377

{ # The button object that appears at the bottom of a card.

5378

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

5379

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

5380

},

5381

"title": "A String", # Required. The title of the button.

5382

},

5383

],

5384

"subtitle": "A String", # Optional. The subtitle of the card.

5385

},

5386

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

5387

"subtitle": "A String", # Optional. Subtitle to the title.

5388

"columnProperties": [ # Optional. Display properties for the columns in this table.

5389

{ # Column properties for TableCard.

5390

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

5391

"header": "A String", # Required. Column heading.

5392

},

5393

],

5394

"image": { # The image response message. # Optional. Image which should be displayed on the card.

5395

"imageUri": "A String", # Optional. The public URI to an image file.

5396

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5397

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5398

},

5399

"buttons": [ # Optional. List of buttons for the card.

5400

{ # The button object that appears at the bottom of a card.

5401

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

5402

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

5403

},

5404

"title": "A String", # Required. The title of the button.

5405

},

5406

],

5407

"title": "A String", # Required. Title of the card.

5408

"rows": [ # Optional. Rows in this table of data.

5409

{ # Row of TableCard.

5410

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

5411

"cells": [ # Optional. List of cells that make up this row.

5412

{ # Cell of TableCardRow.

5413

"text": "A String", # Required. Text in this cell.

},

],

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

5420

"items": [ # Required. Carousel items.

5421

{ # An item in the carousel.

5422

"title": "A String", # Required. Title of the carousel item.

5423

"image": { # The image response message. # Optional. The image to display.

5424

"imageUri": "A String", # Optional. The public URI to an image file.

5425

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5426

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5427

},

5428

"description": "A String", # Optional. The body text of the card.

5429

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

5430

# dialog.

5431

"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.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

5442

# or website associated with this agent.

5443

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

5444

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

5445

# suggestion chip.

5446

},

5447

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

5448

# https://developers.google.com/actions/assistant/responses#browsing_carousel

5449

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

5450

# items.

5451

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

5452

# items, maximum of ten.

5453

{ # Browsing carousel tile

5454

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

5455

"image": { # The image response message. # Optional. Hero image for the carousel item.

5456

"imageUri": "A String", # Optional. The public URI to an image file.

5457

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5458

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5459

},

5460

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

5461

# text.

5462

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

5463

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

5464

# the URL. Defaults to opening via web browser.

5465

"url": "A String", # Required. URL

5466

},

5467

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

5468

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

5473

# This message in `QueryResult.fulfillment_messages` and

5474

# `WebhookResponse.fulfillment_messages` should contain only one

5475

# `SimpleResponse`.

5476

"simpleResponses": [ # Required. The list of simple responses.

5477

{ # The simple response message containing speech or text.

5478

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

5479

# speech output. Mutually exclusive with ssml.

5480

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

5481

# response to the user in the SSML format. Mutually exclusive with

5482

# text_to_speech.

5483

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

5488

"phoneNumber": "A String", # Required. The phone number to transfer the call to

5489

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

5490

#

5491

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

5492

},

5493

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

5494

"mediaObjects": [ # Required. List of media objects.

5495

{ # Response media object for media content card.

5496

"largeImage": { # The image response message. # Optional. Image to display above media content.

5497

"imageUri": "A String", # Optional. The public URI to an image file.

5498

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5499

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5500

},

5501

"name": "A String", # Required. Name of media card.

5502

"description": "A String", # Optional. Description of media card.

5503

"contentUrl": "A String", # Required. Url where the media is stored.

5504

"icon": { # The image response message. # Optional. Icon to display above media content.

5505

"imageUri": "A String", # Optional. The public URI to an image file.

5506

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5507

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

5512

},

5513

"image": { # The image response message. # Displays an image.

5514

"imageUri": "A String", # Optional. The public URI to an image file.

5515

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5516

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5517

},

5518

"payload": { # A custom platform-specific response.

5519

"a_key": "", # Properties of the object.

5520

},

5521

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

5522

#

5523

# Rich cards allow you to respond to users with more vivid content, e.g.

5524

# with media and suggestions.

5525

#

5526

# For more details about RBM rich cards, please see:

5527

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

5528

# You can group multiple rich cards into one using RbmCarouselCard but

5529

# carousel cards will give you less control over the card layout.

5530

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

5531

# Image preview alignment for standalone cards with horizontal layout.

5532

"cardOrientation": "A String", # Required. Orientation of the card.

5533

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

5534

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

5535

#

5536

# At least one of the title, description or media must be set.

5537

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

5538

# be set. Media (image, GIF or a video) to include in the card.

5539

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

5557

# provide a thumbnail URI, the RBM platform displays a blank

5558

# placeholder thumbnail until the user's device downloads the file.

5559

# Depending on the user's setting, the file may not download

5560

# automatically and may require the user to tap a download button.

5561

"height": "A String", # Required for cards with vertical orientation. The height of the media

5562

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

5563

# For a standalone card with horizontal layout, height is not

5564

# customizable, and this field is ignored.

5565

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

5566

# determines the MIME type of the file from the content-type field in

5567

# the HTTP headers when the platform fetches the file. The content-type

5568

# field must be present and accurate in the HTTP response from the URL.

5569

},

5570

"suggestions": [ # Optional. List of suggestions to include in the card.

5571

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5572

# easily select/click a predefined response or perform an action (like

5573

# opening a web uri).

5574

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5575

# instead of typing in their own response.

5576

"text": "A String", # Suggested reply text.

5577

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5578

# when the user taps the suggested reply. This data will be also

5579

# forwarded to webhook to allow performing custom business logic.

5580

},

5581

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5582

# can choose from the card.

5583

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5584

# when the user taps the suggested action. This data will be also

5585

# forwarded to webhook to allow performing custom business logic.

5586

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5587

# to send back to the agent (https://goo.gl/GXotJW).

5588

},

5589

"text": "A String", # Text to display alongside the action.

5590

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5591

# (https://goo.gl/6GLJD2). If the user has an app installed that is

5592

# registered as the default handler for the URL, then this app will be

5593

# opened instead, and its icon will be used in the suggested action UI.

5594

"uri": "A String", # Required. The uri to open on the user device

5595

},

5596

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

5597

# but does not dial automatically (https://goo.gl/ergbB2).

5598

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5599

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5600

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

5607

#

5608

# At least one of the title, description or media must be set.

},

},

},

],

"action": "A String", # Optional. The name of the action associated with the intent.

5614

# Note: The action name must not contain whitespaces.

5615

"name": "A String", # Optional. The unique identifier of this intent.

5616

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

5617

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5618

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5619

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

5620

"inputContextNames": [ # Optional. The list of context names required for this intent to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5621

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5622

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5623

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5624

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5625

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

5626

# a direct or indirect parent. We populate this field only in the output.

5627

{ # Represents a single followup intent in the chain.

5628

"followupIntentName": "A String", # The unique identifier of the followup intent.

5629

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5630

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

5631

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5632

},

5633

],

5634

"displayName": "A String", # Required. The name of this intent.

5635

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

5636

# followup intents. It identifies the correct followup intents chain for

5637

# this intent.

5638

#

5639

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5640

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

5641

# Note: If `ml_disabled` setting is set to true, then this intent is not

5642

# taken into account during inference in `ML ONLY` match mode. Also,

5643

# auto-markup in the UI is turned off.

5644

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

5645

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5646

# Note: If `ml_enabled` setting is set to false, then this intent is not

5647

# taken into account during inference in `ML ONLY` match mode. Also,

5648

# auto-markup in the UI is turned off.

5649

# DEPRECATED! Please use `ml_disabled` field instead.

5650

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

5651

# then the default value is determined as follows:

5652

# - Before April 15th, 2018 the default is:

5653

# ml_enabled = false / ml_disabled = true.

5654

# - After April 15th, 2018 the default is:

5655

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim