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-27 12:20:54 -0700

[diff] [blame^]

84

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

Bu Sun Kim

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

[diff] [blame]

85

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

86

87

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

88

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

89

Bu Sun Kim

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

Bu Sun Kim

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

[diff] [blame^]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

95

96

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

97

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

98

Bu Sun Kim

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

101

<h3>Method Details</h3>

102

Dan O'Meara

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

[diff] [blame]

103

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

Bu Sun Kim

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

[diff] [blame]

104

<pre>Deletes intents in the specified agent.

105

Dan O'Meara

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

[diff] [blame]

106

Operation <response: google.protobuf.Empty>

Bu Sun Kim

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

[diff] [blame]

107

108

Args:

109

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

Dan O'Meara

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

[diff] [blame]

110

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

111

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

112

The object takes the form of:

113

114

{ # The request message for Intents.BatchDeleteIntents.

Bu Sun Kim

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

[diff] [blame]

115

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

Bu Sun Kim

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

[diff] [blame]

116

# filled in.

117

{ # Represents an intent.

118

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

119

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

Bu Sun Kim

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

[diff] [blame^]

120

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

121

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

122

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

123

# this intent.

124

#

125

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

126

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

127

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

128

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

129

# auto-markup in the UI is turned off.

130

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

131

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

132

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

133

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

134

# auto-markup in the UI is turned off.

135

# DEPRECATED! Please use `ml_disabled` field instead.

136

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

137

# then the default value is determined as follows:

138

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

139

# ml_enabled = false / ml_disabled = true.

140

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

141

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

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

[diff] [blame]

142

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

Dan O'Meara

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

[diff] [blame]

143

# trained on.

144

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

Bu Sun Kim

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

[diff] [blame]

145

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

Dan O'Meara

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

[diff] [blame]

146

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

147

#

148

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

149

# Dialogflow Console does.

150

#

151

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

152

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

153

#

154

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

155

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

156

#

157

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

158

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

159

#

160

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

161

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

162

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

163

# set.

164

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

165

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

166

# annotated part of the example.

167

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

Bu Sun Kim

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

[diff] [blame]

168

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

Dan O'Meara

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

[diff] [blame]

169

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

170

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

171

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame]

172

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

173

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

174

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

Dan O'Meara

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

[diff] [blame]

175

},

176

],

Bu Sun Kim

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

[diff] [blame]

177

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

178

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

Dan O'Meara

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

[diff] [blame]

179

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

180

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

181

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

Dan O'Meara

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

[diff] [blame]

182

},

183

],

Bu Sun Kim

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

[diff] [blame]

184

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

185

# session when this intent is matched.

186

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

187

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

188

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

189

# describes values of the parameter. If the parameter is

190

# required, this must be provided.

191

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

192

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

193

"A String",

194

],

Bu Sun Kim

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

[diff] [blame^]

195

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

196

# whether the intent cannot be completed without collecting the parameter

197

# value.

Bu Sun Kim

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

[diff] [blame]

198

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

199

# result.

200

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

201

# syntax: `#context_name.parameter_name`.

Bu Sun Kim

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

[diff] [blame]

202

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

203

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

204

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

205

#

206

# - a constant string,

207

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

208

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

209

# - a parameter value from some context defined as

210

# `#context_name.parameter_name`.

Bu Sun Kim

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

[diff] [blame^]

211

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

Bu Sun Kim

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

[diff] [blame]

212

},

Bu Sun Kim

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

[diff] [blame]

213

],

Bu Sun Kim

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

[diff] [blame]

214

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

215

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

216

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

217

# Event names are limited to 150 characters.

218

"A String",

219

],

220

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

221

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

222

# for example with CreateIntent or

223

# BatchUpdateIntents, in order to make this

224

# intent a followup intent.

225

#

226

# It identifies the parent followup intent.

227

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

228

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

Dan O'Meara

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

[diff] [blame]

229

# priorities.

Bu Sun Kim

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

[diff] [blame]

230

#

Dan O'Meara

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

[diff] [blame]

231

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

232

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

233

# `Normal` priority in the console.

234

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

235

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

236

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

237

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

238

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

239

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

240

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

241

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

242

# when the intent is matched.

243

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

244

{ # Represents a context.

245

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

246

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

247

# immediately. Contexts expire automatically after 20 minutes if there

248

# are no matching queries.

249

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

250

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

251

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

252

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

253

#

254

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

255

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

256

#

257

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

258

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

259

#

260

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

261

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

262

#

263

# * `__system_counters__`

264

# * `*_id_dialog_context`

265

# * `*_dialog_params_size`

266

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

267

#

268

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

269

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

270

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

271

#

272

# - MapKey type: string

273

# - MapKey value: parameter name

274

# - MapValue type:

275

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

276

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

277

# - MapValue value:

278

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

279

# map from composite entity property names to property values

280

# - Else: parameter value

281

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

},

},

],

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

286

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

287

"A String",

288

],

289

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

290

# `Response` field in the Dialogflow console.

291

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

292

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

293

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

298

#

299

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

300

# with media and suggestions.

301

#

302

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

303

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

304

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

305

# please use RbmStandaloneCard instead.

Bu Sun Kim

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

[diff] [blame]

306

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

307

# 2 cards and at most 10.

308

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

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

[diff] [blame]

309

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

310

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

311

# 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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

# customizable, and this field is ignored.

337

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

338

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

339

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

340

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

341

},

342

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

343

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

344

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

345

# opening a web uri).

346

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

347

# instead of typing in their own response.

Bu Sun Kim

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

[diff] [blame]

348

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

349

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

350

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame^]

351

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

Bu Sun Kim

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

[diff] [blame]

352

},

353

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

354

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

355

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

356

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

357

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

358

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

359

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

360

# +15556767888.

361

},

Bu Sun Kim

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

[diff] [blame]

362

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

363

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

364

# forwarded to webhook to allow performing custom business logic.

365

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

366

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

367

},

368

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

369

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

370

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

371

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

372

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

373

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

374

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

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

379

#

380

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

Bu Sun Kim

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

[diff] [blame^]

381

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

382

#

383

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

Bu Sun Kim

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

[diff] [blame]

384

},

385

],

Bu Sun Kim

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

[diff] [blame^]

386

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

Bu Sun Kim

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

[diff] [blame]

387

},

388

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

389

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

390

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

391

# to the conversation.

392

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

},

],

},

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

397

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

398

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

399

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

400

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

401

#

402

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

403

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

404

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

405

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

406

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

407

# added by default when enabling the Dialogflow V2 API.

408

#

409

# For audio from other sources, consider using the

410

# `TelephonySynthesizeSpeech` message with SSML.

411

},

412

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

413

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

414

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

415

"items": [ # Required. List items.

416

{ # An item in the list.

Bu Sun Kim

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

[diff] [blame^]

417

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

Bu Sun Kim

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

[diff] [blame]

418

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

419

# dialog.

420

"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

425

# response is given.

426

},

427

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

428

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

429

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

430

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

431

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

432

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

437

#

438

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

439

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

440

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

441

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

442

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

443

# opening a web uri).

444

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

445

# instead of typing in their own response.

Bu Sun Kim

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

[diff] [blame]

446

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

447

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

448

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame^]

449

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

Bu Sun Kim

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

[diff] [blame]

450

},

451

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

452

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

453

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

454

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

455

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

456

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

457

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

458

# +15556767888.

459

},

Bu Sun Kim

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

[diff] [blame]

460

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

461

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

462

# forwarded to webhook to allow performing custom business logic.

463

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

464

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

465

},

466

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

467

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

468

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

469

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

470

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

471

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

472

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

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

477

},

478

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

479

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

480

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

485

# Telephony Gateway.

486

#

487

# Telephony Gateway takes the synthesizer settings from

488

# `DetectIntentResponse.output_audio_config` which can either be set

489

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

490

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

491

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

492

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

493

},

494

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

Bu Sun Kim

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

[diff] [blame]

495

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

496

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

497

{ # Optional. Contains information about a button.

498

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

499

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

# open.

},

],

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

Bu Sun Kim

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

[diff] [blame^]

504

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

Bu Sun Kim

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

[diff] [blame]

505

},

506

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

507

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

508

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

509

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

510

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

511

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

512

},

513

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

514

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

515

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

Bu Sun Kim

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

[diff] [blame^]

516

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

Bu Sun Kim

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

[diff] [blame]

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

},

Bu Sun Kim

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

[diff] [blame]

520

},

521

],

522

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

523

},

524

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

Bu Sun Kim

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

[diff] [blame]

525

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

526

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

527

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

528

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

529

},

530

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

531

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

Bu Sun Kim

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

[diff] [blame^]

532

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

Bu Sun Kim

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

[diff] [blame]

533

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

534

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

535

},

Bu Sun Kim

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

[diff] [blame]

536

},

537

],

538

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

539

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

540

{ # Row of TableCard.

541

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

542

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

543

{ # Cell of TableCardRow.

544

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame^]

549

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

550

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

551

{ # Column properties for TableCard.

552

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

553

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

554

},

555

],

Bu Sun Kim

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

[diff] [blame]

556

},

557

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

558

"items": [ # Required. Carousel items.

559

{ # An item in the carousel.

Bu Sun Kim

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

[diff] [blame]

560

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

561

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

562

# dialog.

563

"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

568

# response is given.

569

},

Bu Sun Kim

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

[diff] [blame^]

570

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

571

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

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

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

580

# or website associated with this agent.

581

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

582

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

583

# suggestion chip.

584

},

585

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

586

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

587

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

588

# items.

589

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

590

# items, maximum of ten.

591

{ # Browsing carousel tile

Bu Sun Kim

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

[diff] [blame]

592

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

593

# text.

594

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

595

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

596

# the URL. Defaults to opening via web browser.

597

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

598

},

599

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

600

# Card. Maximum of one line of text.

Bu Sun Kim

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

[diff] [blame^]

601

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

602

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

603

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

604

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

605

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

606

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

611

# This message in `QueryResult.fulfillment_messages` and

612

# `WebhookResponse.fulfillment_messages` should contain only one

613

# `SimpleResponse`.

614

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

615

{ # The simple response message containing speech or text.

Bu Sun Kim

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

[diff] [blame]

616

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

617

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

618

# text_to_speech.

619

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

Bu Sun Kim

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

[diff] [blame^]

620

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

621

# speech output. Mutually exclusive with ssml.

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

626

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

627

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

628

#

629

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

630

},

631

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

632

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

633

{ # Response media object for media content card.

Bu Sun Kim

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

[diff] [blame]

634

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

635

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

636

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

637

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

638

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

639

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

640

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

641

},

Bu Sun Kim

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

[diff] [blame^]

642

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

643

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

644

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

645

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

646

},

Bu Sun Kim

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

[diff] [blame]

647

},

648

],

649

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

650

},

651

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

652

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

653

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

654

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

655

},

Bu Sun Kim

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

[diff] [blame]

656

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

657

#

658

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

659

# with media and suggestions.

660

#

661

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

662

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

663

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

664

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

665

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

666

# Image preview alignment for standalone cards with horizontal layout.

667

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

668

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

Bu Sun Kim

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

[diff] [blame]

669

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

670

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

671

# 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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

# customizable, and this field is ignored.

697

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

698

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

699

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

700

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

701

},

702

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

703

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

704

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

705

# opening a web uri).

706

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

707

# instead of typing in their own response.

Bu Sun Kim

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

[diff] [blame]

708

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

709

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

710

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame^]

711

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

Bu Sun Kim

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

[diff] [blame]

712

},

713

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

714

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

715

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

716

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

717

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

718

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

719

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

720

# +15556767888.

721

},

Bu Sun Kim

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

[diff] [blame]

722

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

723

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

724

# forwarded to webhook to allow performing custom business logic.

725

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

726

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

727

},

728

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

729

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

730

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

731

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

732

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

733

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

734

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

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

739

#

740

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

Bu Sun Kim

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

[diff] [blame^]

741

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

742

#

743

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

Bu Sun Kim

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

[diff] [blame]

744

},

745

},

Bu Sun Kim

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

[diff] [blame^]

746

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

747

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

748

},

Bu Sun Kim

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

[diff] [blame]

749

},

750

],

751

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

752

# Note: The action name must not contain whitespaces.

753

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

754

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

755

# methods.

Dan O'Meara

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

[diff] [blame]

756

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

Bu Sun Kim

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

[diff] [blame]

757

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

758

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

759

# triggered.

Dan O'Meara

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

[diff] [blame]

760

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

Bu Sun Kim

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

[diff] [blame]

761

"A String",

Bu Sun Kim

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

[diff] [blame]

762

],

Bu Sun Kim

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

[diff] [blame]

763

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

764

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

765

{ # Represents a single followup intent in the chain.

766

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

767

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

768

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

769

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

770

},

771

],

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-27 12:20:54 -0700

[diff] [blame^]

786

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

787

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

788

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

789

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

790

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

791

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

792

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

793

#

794

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

795

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

796

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

797

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

798

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

799

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

800

# message types for APIs to use.

801

{

802

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

803

},

804

],

805

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

806

},

Bu Sun Kim

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

[diff] [blame]

807

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

808

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

809

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

810

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

811

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

812

},

813

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

814

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

815

# available.

816

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

817

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

818

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

819

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

820

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

821

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

822

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

823

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

824

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

Dan O'Meara

2020-05-01 07:42:23 -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-27 12:20:54 -0700

[diff] [blame^]

847

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

848

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

849

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

850

# this intent.

851

#

852

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

853

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

854

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

855

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

856

# auto-markup in the UI is turned off.

857

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

858

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

859

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

860

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

861

# auto-markup in the UI is turned off.

862

# DEPRECATED! Please use `ml_disabled` field instead.

863

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

864

# then the default value is determined as follows:

865

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

866

# ml_enabled = false / ml_disabled = true.

867

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

868

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

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

[diff] [blame]

869

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

Dan O'Meara

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

[diff] [blame]

870

# trained on.

871

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

Bu Sun Kim

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

[diff] [blame]

872

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

Dan O'Meara

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

[diff] [blame]

873

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

874

#

875

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

876

# Dialogflow Console does.

877

#

878

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

879

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

880

#

881

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

882

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

883

#

884

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

885

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

886

#

887

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

888

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

889

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

890

# set.

891

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

892

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

893

# annotated part of the example.

894

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

Bu Sun Kim

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

[diff] [blame]

895

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

Dan O'Meara

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

[diff] [blame]

896

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

897

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

898

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame]

899

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

900

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

901

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

Dan O'Meara

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

[diff] [blame]

902

},

903

],

Bu Sun Kim

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

[diff] [blame]

904

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

905

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

Dan O'Meara

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

[diff] [blame]

906

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

907

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

908

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

Dan O'Meara

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

[diff] [blame]

909

},

910

],

Bu Sun Kim

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

[diff] [blame]

911

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

912

# session when this intent is matched.

913

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

914

{ # Represents intent parameters.

Bu Sun Kim

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

[diff] [blame]

915

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

916

# describes values of the parameter. If the parameter is

917

# required, this must be provided.

918

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

919

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

920

"A String",

921

],

Bu Sun Kim

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

[diff] [blame^]

922

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

923

# whether the intent cannot be completed without collecting the parameter

924

# value.

Bu Sun Kim

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

[diff] [blame]

925

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

926

# result.

927

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

928

# syntax: `#context_name.parameter_name`.

Bu Sun Kim

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

[diff] [blame]

929

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

930

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

931

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

932

#

933

# - a constant string,

934

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

935

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

936

# - a parameter value from some context defined as

937

# `#context_name.parameter_name`.

Bu Sun Kim

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

[diff] [blame^]

938

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

Bu Sun Kim

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

[diff] [blame]

939

},

Bu Sun Kim

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

[diff] [blame]

940

],

Bu Sun Kim

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

[diff] [blame]

941

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

942

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

943

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

944

# Event names are limited to 150 characters.

945

"A String",

946

],

947

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

948

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

949

# for example with CreateIntent or

950

# BatchUpdateIntents, in order to make this

951

# intent a followup intent.

952

#

953

# It identifies the parent followup intent.

954

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

955

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

Dan O'Meara

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

[diff] [blame]

956

# priorities.

Bu Sun Kim

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

[diff] [blame]

957

#

Dan O'Meara

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

[diff] [blame]

958

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

959

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

960

# `Normal` priority in the console.

961

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

962

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

963

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

964

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

965

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

966

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

967

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

968

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

969

# when the intent is matched.

970

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

971

{ # Represents a context.

972

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

973

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

974

# immediately. Contexts expire automatically after 20 minutes if there

975

# are no matching queries.

976

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

977

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

978

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

979

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

980

#

981

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

982

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

983

#

984

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

985

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

986

#

987

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

988

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

989

#

990

# * `__system_counters__`

991

# * `*_id_dialog_context`

992

# * `*_dialog_params_size`

993

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

994

#

995

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

996

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

997

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

998

#

999

# - MapKey type: string

1000

# - MapKey value: parameter name

1001

# - MapValue type:

1002

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

1003

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

1004

# - MapValue value:

1005

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

1006

# map from composite entity property names to property values

1007

# - Else: parameter value

1008

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

},

},

],

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

1013

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

1014

"A String",

1015

],

1016

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

1017

# `Response` field in the Dialogflow console.

1018

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

1019

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

1020

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

1025

#

1026

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

1027

# with media and suggestions.

1028

#

1029

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

1030

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

1031

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

1032

# please use RbmStandaloneCard instead.

Bu Sun Kim

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

[diff] [blame]

1033

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

1034

# 2 cards and at most 10.

1035

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

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

[diff] [blame]

1036

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

1037

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

1038

# 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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

# customizable, and this field is ignored.

1064

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

1065

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

1066

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

1067

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

1068

},

1069

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

1070

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

1071

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

1072

# opening a web uri).

1073

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

1074

# instead of typing in their own response.

Bu Sun Kim

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

[diff] [blame]

1075

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

1076

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

1077

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame^]

1078

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

Bu Sun Kim

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

[diff] [blame]

1079

},

1080

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

1081

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

1082

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

1083

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

1084

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

1085

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

1086

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

1087

# +15556767888.

1088

},

Bu Sun Kim

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

[diff] [blame]

1089

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

1090

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

1091

# forwarded to webhook to allow performing custom business logic.

1092

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

1093

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

1094

},

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

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

1106

#

1107

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

Bu Sun Kim

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

[diff] [blame^]

1108

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

1109

#

1110

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

Bu Sun Kim

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

[diff] [blame]

1111

},

1112

],

Bu Sun Kim

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

[diff] [blame^]

1113

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

Bu Sun Kim

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

[diff] [blame]

1114

},

1115

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

1116

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

1117

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

1118

# to the conversation.

1119

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

},

],

},

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

1124

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

1125

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

1126

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

1127

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

1128

#

1129

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

1130

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

1131

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

1132

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

1133

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

1134

# added by default when enabling the Dialogflow V2 API.

1135

#

1136

# For audio from other sources, consider using the

1137

# `TelephonySynthesizeSpeech` message with SSML.

1138

},

1139

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

1140

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

1141

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

1142

"items": [ # Required. List items.

1143

{ # An item in the list.

Bu Sun Kim

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

[diff] [blame^]

1144

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

Bu Sun Kim

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

[diff] [blame]

1145

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

1146

# dialog.

1147

"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

1152

# response is given.

1153

},

1154

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

1155

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

1156

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

1157

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

1158

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

1159

},

Bu Sun Kim

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

[diff] [blame]

},

],

},

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

1164

#

1165

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

1166

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

1167

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

1168

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

1169

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

1170

# opening a web uri).

1171

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

1172

# instead of typing in their own response.

Bu Sun Kim

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

[diff] [blame]

1173

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

1174

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

1175

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame^]

1176

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

Bu Sun Kim

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

[diff] [blame]

1177

},

1178

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

1179

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

1180

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

1181

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

1182

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

1183

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

1184

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

1185

# +15556767888.

1186

},

Bu Sun Kim

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

[diff] [blame]

1187

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

1188

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

1189

# forwarded to webhook to allow performing custom business logic.

1190

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

1191

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

1192

},

1193

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

1194

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

1195

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

1196

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

1197

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

1198

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

1199

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

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

1204

},

1205

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

1206

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

1207

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

1212

# Telephony Gateway.

1213

#

1214

# Telephony Gateway takes the synthesizer settings from

1215

# `DetectIntentResponse.output_audio_config` which can either be set

1216

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

1217

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

1218

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

1219

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

1220

},

1221

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

Bu Sun Kim

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

[diff] [blame]

1222

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

1223

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

1224

{ # Optional. Contains information about a button.

1225

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

1226

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

# open.

},

],

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

Bu Sun Kim

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

[diff] [blame^]

1231

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

Bu Sun Kim

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

[diff] [blame]

1232

},

1233

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

1234

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

1235

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

1236

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

1237

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

1238

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

1239

},

1240

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

1241

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

1242

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

Bu Sun Kim

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

[diff] [blame^]

1243

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

Bu Sun Kim

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

[diff] [blame]

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

},

Bu Sun Kim

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

[diff] [blame]

1247

},

1248

],

1249

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

1250

},

1251

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

Bu Sun Kim

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

[diff] [blame]

1252

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

1253

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

1254

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

1255

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

1256

},

1257

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

1258

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

Bu Sun Kim

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

[diff] [blame^]

1259

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

Bu Sun Kim

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

[diff] [blame]

1260

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

1261

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

1262

},

Bu Sun Kim

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

[diff] [blame]

1263

},

1264

],

1265

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

1266

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

1267

{ # Row of TableCard.

1268

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

1269

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

1270

{ # Cell of TableCardRow.

1271

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame^]

1276

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

1277

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

1278

{ # Column properties for TableCard.

1279

"header": "A String", # Required. Column heading.

1280

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

1281

},

1282

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1283

},

1284

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

1285

"items": [ # Required. Carousel items.

1286

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1287

"description": "A String", # Optional. The body text of the card.

1288

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

1289

# dialog.

1290

"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

1295

# response is given.

1296

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1297

"title": "A String", # Required. Title of the carousel item.

1298

"image": { # The image response message. # Optional. The image to display.

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

1307

# or website associated with this agent.

1308

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1309

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

1310

# suggestion chip.

1311

},

1312

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

1313

# https://developers.google.com/actions/assistant/responses#browsing_carousel

1314

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

1315

# items.

1316

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

1317

# items, maximum of ten.

1318

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1319

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

1320

# text.

1321

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1322

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

1323

# the URL. Defaults to opening via web browser.

1324

"url": "A String", # Required. URL

1325

},

1326

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

1327

# Card. Maximum of one line of text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1328

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

1329

"image": { # The image response message. # Optional. Hero image for the carousel item.

1330

"imageUri": "A String", # Optional. The public URI to an image file.

1331

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1332

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1333

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

1338

# This message in `QueryResult.fulfillment_messages` and

1339

# `WebhookResponse.fulfillment_messages` should contain only one

1340

# `SimpleResponse`.

1341

"simpleResponses": [ # Required. The list of simple responses.

1342

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1343

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

1344

# response to the user in the SSML format. Mutually exclusive with

1345

# text_to_speech.

1346

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1347

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

1348

# speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

1353

"phoneNumber": "A String", # Required. The phone number to transfer the call to

1354

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

1355

#

1356

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

1357

},

1358

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1359

"mediaObjects": [ # Required. List of media objects.

1360

{ # Response media object for media content card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1361

"name": "A String", # Required. Name of media card.

1362

"description": "A String", # Optional. Description of media card.

1363

"contentUrl": "A String", # Required. Url where the media is stored.

1364

"icon": { # The image response message. # Optional. Icon to display above media content.

1365

"imageUri": "A String", # Optional. The public URI to an image file.

1366

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1367

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1368

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1369

"largeImage": { # The image response message. # Optional. Image to display above media content.

1370

"imageUri": "A String", # Optional. The public URI to an image file.

1371

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1372

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1373

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1374

},

1375

],

1376

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1377

},

1378

"image": { # The image response message. # Displays an image.

1379

"imageUri": "A String", # Optional. The public URI to an image file.

1380

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1381

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1382

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1383

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

1384

#

1385

# Rich cards allow you to respond to users with more vivid content, e.g.

1386

# with media and suggestions.

1387

#

1388

# For more details about RBM rich cards, please see:

1389

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

1390

# You can group multiple rich cards into one using RbmCarouselCard but

1391

# carousel cards will give you less control over the card layout.

1392

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

1393

# Image preview alignment for standalone cards with horizontal layout.

1394

"cardOrientation": "A String", # Required. Orientation of the card.

1395

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1396

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

1397

# be set. Media (image, GIF or a video) to include in the card.

1398

# 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

1416

# provide a thumbnail URI, the RBM platform displays a blank

1417

# placeholder thumbnail until the user's device downloads the file.

1418

# Depending on the user's setting, the file may not download

1419

# automatically and may require the user to tap a download button.

1420

"height": "A String", # Required for cards with vertical orientation. The height of the media

1421

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

1422

# For a standalone card with horizontal layout, height is not

1423

# customizable, and this field is ignored.

1424

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

1425

# determines the MIME type of the file from the content-type field in

1426

# the HTTP headers when the platform fetches the file. The content-type

1427

# field must be present and accurate in the HTTP response from the URL.

1428

},

1429

"suggestions": [ # Optional. List of suggestions to include in the card.

1430

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1431

# easily select/click a predefined response or perform an action (like

1432

# opening a web uri).

1433

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1434

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1435

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1436

# when the user taps the suggested reply. This data will be also

1437

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1438

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1439

},

1440

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1441

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1442

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1443

# but does not dial automatically (https://goo.gl/ergbB2).

1444

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1445

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1446

# format. An example of a correctly formatted phone number:

1447

# +15556767888.

1448

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1449

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1450

# when the user taps the suggested action. This data will be also

1451

# forwarded to webhook to allow performing custom business logic.

1452

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1453

# to send back to the agent (https://goo.gl/GXotJW).

1454

},

1455

"text": "A String", # Text to display alongside the action.

1456

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1457

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1458

# registered as the default handler for the URL, then this app will be

1459

# opened instead, and its icon will be used in the suggested action UI.

1460

"uri": "A String", # Required. The uri to open on the user device

1461

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

1466

#

1467

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1468

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

1469

#

1470

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1471

},

1472

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1473

"payload": { # A custom platform-specific response.

1474

"a_key": "", # Properties of the object.

1475

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1476

},

1477

],

1478

"action": "A String", # Optional. The name of the action associated with the intent.

1479

# Note: The action name must not contain whitespaces.

1480

"name": "A String", # Optional. The unique identifier of this intent.

1481

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1482

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1483

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1484

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

1485

"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]

1486

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1487

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1488

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1489

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1490

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

1491

# a direct or indirect parent. We populate this field only in the output.

1492

{ # Represents a single followup intent in the chain.

1493

"followupIntentName": "A String", # The unique identifier of the followup intent.

1494

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1495

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

1496

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1497

},

1498

],

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-27 12:20:54 -0700

[diff] [blame^]

1524

"name": "A String", # The server-assigned name, which is only unique within the same service that

1525

# originally returns it. If you use the default HTTP mapping, the

1526

# `name` should be a resource name ending with `operations/{unique_id}`.

1527

"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.

1528

# different programming environments, including REST APIs and RPC APIs. It is

1529

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1530

# three pieces of data: error code, error message, and error details.

1531

#

1532

# You can find out more about this error model and how to work with it in the

1533

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1534

"message": "A String", # A developer-facing error message, which should be in English. Any

1535

# user-facing error message should be localized and sent in the

1536

# google.rpc.Status.details field, or localized by the client.

1537

"details": [ # A list of messages that carry the error details. There is a common set of

1538

# message types for APIs to use.

1539

{

1540

"a_key": "", # Properties of the object. Contains field @type with type URL.

1541

},

1542

],

1543

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1544

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1545

"metadata": { # Service-specific metadata associated with the operation. It typically

1546

# contains progress information and common metadata such as create time.

1547

# Some services might not provide such metadata. Any method that returns a

1548

# long-running operation should document the metadata type, if any.

1549

"a_key": "", # Properties of the object. Contains field @type with type URL.

1550

},

1551

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1552

# If `true`, the operation is completed, and either `error` or `response` is

1553

# available.

1554

"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]

1555

# method returns no data on success, such as `Delete`, the response is

1556

# `google.protobuf.Empty`. If the original method is standard

1557

# `Get`/`Create`/`Update`, the response should be the resource. For other

1558

# methods, the response should have the type `XxxResponse`, where `Xxx`

1559

# is the original method name. For example, if the original method name

1560

# is `TakeSnapshot()`, the inferred response type is

1561

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1562

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1563

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1568

<code class="details" id="create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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-27 12:20:54 -0700

[diff] [blame^]

1580

"displayName": "A String", # Required. The name of this intent.

1581

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

1582

# followup intents. It identifies the correct followup intents chain for

1583

# this intent.

1584

#

1585

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1586

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

1587

# Note: If `ml_disabled` setting is set to true, then this intent is not

1588

# taken into account during inference in `ML ONLY` match mode. Also,

1589

# auto-markup in the UI is turned off.

1590

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

1591

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

1592

# Note: If `ml_enabled` setting is set to false, then this intent is not

1593

# taken into account during inference in `ML ONLY` match mode. Also,

1594

# auto-markup in the UI is turned off.

1595

# DEPRECATED! Please use `ml_disabled` field instead.

1596

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

1597

# then the default value is determined as follows:

1598

# - Before April 15th, 2018 the default is:

1599

# ml_enabled = false / ml_disabled = true.

1600

# - After April 15th, 2018 the default is:

1601

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1602

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1603

# trained on.

1604

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1605

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1606

# The parts are concatenated in order to form the training phrase.

1607

#

1608

# Note: The API does not automatically annotate training phrases like the

1609

# Dialogflow Console does.

1610

#

1611

# Note: Do not forget to include whitespace at part boundaries,

1612

# so the training phrase is well formatted when the parts are concatenated.

1613

#

1614

# If the training phrase does not need to be annotated with parameters,

1615

# you just need a single part with only the Part.text field set.

1616

#

1617

# If you want to annotate the training phrase, you must create multiple

1618

# parts, where the fields of each part are populated in one of two ways:

1619

#

1620

# - `Part.text` is set to a part of the phrase that has no parameters.

1621

# - `Part.text` is set to a part of the phrase that you want to annotate,

1622

# and the `entity_type`, `alias`, and `user_defined` fields are all

1623

# set.

1624

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1625

"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]

1626

# annotated part of the example.

1627

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1628

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1629

# This field is set to true when the Dialogflow Console is used to

1630

# manually annotate the part. When creating an annotated part with the

1631

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1632

"text": "A String", # Required. The text for this part.

1633

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

1634

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1635

},

1636

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1637

"name": "A String", # Output only. The unique identifier of this training phrase.

1638

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1639

# the intent. Each time a developer adds an existing sample by editing an

1640

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1641

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1642

},

1643

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1644

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

1645

# session when this intent is matched.

1646

"parameters": [ # Optional. The collection of parameters associated with the intent.

1647

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1648

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1649

# describes values of the parameter. If the parameter is

1650

# required, this must be provided.

1651

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1652

# user in order to collect a value for the parameter.

1653

"A String",

1654

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1655

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

1656

# whether the intent cannot be completed without collecting the parameter

1657

# value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1658

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1659

# result.

1660

# Default values can be extracted from contexts by using the following

1661

# syntax: `#context_name.parameter_name`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1662

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1663

"name": "A String", # The unique identifier of this parameter.

1664

"value": "A String", # Optional. The definition of the parameter value. It can be:

1665

#

1666

# - a constant string,

1667

# - a parameter value defined as `$parameter_name`,

1668

# - an original parameter value defined as `$parameter_name.original`,

1669

# - a parameter value from some context defined as

1670

# `#context_name.parameter_name`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1671

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1672

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1673

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1674

"events": [ # Optional. The collection of event names that trigger the intent.

1675

# If the collection of input contexts is not empty, all of the contexts must

1676

# be present in the active user session for an event to trigger this intent.

1677

# Event names are limited to 150 characters.

1678

"A String",

1679

],

1680

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

1681

# chain of followup intents. You can set this field when creating an intent,

1682

# for example with CreateIntent or

1683

# BatchUpdateIntents, in order to make this

1684

# intent a followup intent.

1685

#

1686

# It identifies the parent followup intent.

1687

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1688

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1689

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1690

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1691

# - If the supplied value is unspecified or 0, the service

1692

# translates the value to 500,000, which corresponds to the

1693

# `Normal` priority in the console.

1694

# - If the supplied value is negative, the intent is ignored

1695

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1696

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

1697

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

1698

# to close interaction with an end user. Default is false.

1699

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1700

# is matched. Context messages in this collection should not set the

1701

# parameters field. Setting the `lifespan_count` to 0 will reset the context

1702

# when the intent is matched.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1703

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1704

{ # Represents a context.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1705

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1706

# context expires. The default is `0`. If set to `0`, the context expires

1707

# immediately. Contexts expire automatically after 20 minutes if there

1708

# are no matching queries.

1709

"name": "A String", # Required. The unique identifier of the context. Format:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1710

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1711

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1712

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1713

#

1714

# The `Context ID` is always converted to lowercase, may only contain

1715

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

1716

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1717

# If `Environment ID` is not specified, we assume default 'draft'

1718

# environment. If `User ID` is not specified, we assume default '-' user.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1719

#

1720

# The following context names are reserved for internal use by Dialogflow.

1721

# You should not use these contexts or create contexts with these names:

1722

#

1723

# * `__system_counters__`

1724

# * `*_id_dialog_context`

1725

# * `*_dialog_params_size`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1726

"parameters": { # Optional. The collection of parameters associated with this context.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1727

#

1728

# Depending on your protocol or client library language, this is a

1729

# map, associative array, symbol table, dictionary, or JSON object

1730

# composed of a collection of (MapKey, MapValue) pairs:

1731

#

1732

# - MapKey type: string

1733

# - MapKey value: parameter name

1734

# - MapValue type:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1735

# - If parameter's entity type is a composite entity: map

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1736

# - Else: string or number, depending on parameter value type

1737

# - MapValue value:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1738

# - If parameter's entity type is a composite entity:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1739

# map from composite entity property names to property values

1740

# - Else: parameter value

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1741

"a_key": "", # Properties of the object.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1742

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1743

},

1744

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1745

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

1746

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1747

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1748

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"messages": [ # Optional. The collection of rich messages corresponding to the

1750

# `Response` field in the Dialogflow console.

1751

{ # Corresponds to the `Response` field in the Dialogflow console.

1752

"text": { # The text response message. # Returns a text response.

1753

"text": [ # Optional. The collection of the agent's responses.

1754

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1755

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1756

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1757

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

1758

#

1759

# Rich cards allow you to respond to users with more vivid content, e.g.

1760

# with media and suggestions.

1761

#

1762

# For more details about RBM rich cards, please see:

1763

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

1764

# If you want to show a single card with more control over the layout,

1765

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1766

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

1767

# 2 cards and at most 10.

1768

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1769

"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]

1770

# be set. Media (image, GIF or a video) to include in the card.

1771

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1776

# * 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]

1788

"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]

1789

# provide a thumbnail URI, the RBM platform displays a blank

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1790

# placeholder thumbnail until the user's device downloads the file.

1791

# Depending on the user's setting, the file may not download

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1792

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1793

"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]

1794

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

1795

# For a standalone card with horizontal layout, height is not

1796

# customizable, and this field is ignored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1797

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

1798

# determines the MIME type of the file from the content-type field in

1799

# the HTTP headers when the platform fetches the file. The content-type

1800

# 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]

1801

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1802

"suggestions": [ # Optional. List of suggestions to include in the card.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1803

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1804

# easily select/click a predefined response or perform an action (like

1805

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1806

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1807

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1808

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1809

# when the user taps the suggested reply. This data will be also

1810

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1811

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1812

},

1813

"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]

1814

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1815

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1816

# but does not dial automatically (https://goo.gl/ergbB2).

1817

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1818

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1819

# format. An example of a correctly formatted phone number:

1820

# +15556767888.

1821

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1822

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1823

# when the user taps the suggested action. This data will be also

1824

# forwarded to webhook to allow performing custom business logic.

1825

"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]

1826

# to send back to the agent (https://goo.gl/GXotJW).

1827

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1828

"text": "A String", # Text to display alongside the action.

1829

"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]

1830

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1831

# registered as the default handler for the URL, then this app will be

1832

# 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]

1833

"uri": "A String", # Required. The uri to open on the user device

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1834

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1835

},

1836

},

1837

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1838

"title": "A String", # Optional. Title of the card (at most 200 bytes).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1839

#

1840

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1841

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

1842

#

1843

# At least one of the title, description or media must be set.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1844

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1845

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1846

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1847

},

1848

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

1849

"suggestions": [ # Required. The list of suggested replies.

1850

{ # The suggestion chip message that the user can tap to quickly post a reply

1851

# to the conversation.

1852

"title": "A String", # Required. The text shown the in the suggestion chip.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1853

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1854

],

1855

},

1856

"platform": "A String", # Optional. The platform that this message is intended for.

1857

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

1858

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

1859

# play, e.g., "gs://bucket/object". The object must contain a single

1860

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

1861

#

1862

# This object must be readable by the `service-<Project

1863

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

1864

# where <Project Number> is the number of the Telephony Gateway project

1865

# (usually the same as the Dialogflow agent project). If the Google Cloud

1866

# Storage bucket is in the Telephony Gateway project, this permission is

1867

# added by default when enabling the Dialogflow V2 API.

1868

#

1869

# For audio from other sources, consider using the

1870

# `TelephonySynthesizeSpeech` message with SSML.

1871

},

1872

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

1873

"title": "A String", # Optional. The overall title of the list.

1874

"subtitle": "A String", # Optional. Subtitle of the list.

1875

"items": [ # Required. List items.

1876

{ # An item in the list.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1877

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

1879

# dialog.

1880

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

1881

# item in dialog.

1882

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1883

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1884

"key": "A String", # Required. A unique key that will be sent back to the agent if this

1885

# response is given.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1886

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1887

"title": "A String", # Required. The title of the list item.

1888

"image": { # The image response message. # Optional. The image to display.

1889

"imageUri": "A String", # Optional. The public URI to an image file.

1890

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1891

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1892

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1893

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1894

],

1895

},

1896

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

1897

#

1898

# RBM allows businesses to send enriched and branded versions of SMS. See

1899

# https://jibe.google.com/business-messaging.

1900

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

1901

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1902

# easily select/click a predefined response or perform an action (like

1903

# opening a web uri).

1904

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1905

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1906

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1907

# when the user taps the suggested reply. This data will be also

1908

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1909

"text": "A String", # Suggested reply text.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1910

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1911

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1912

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1913

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1914

# but does not dial automatically (https://goo.gl/ergbB2).

1915

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1916

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1917

# format. An example of a correctly formatted phone number:

1918

# +15556767888.

1919

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1920

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1921

# when the user taps the suggested action. This data will be also

1922

# forwarded to webhook to allow performing custom business logic.

1923

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1924

# to send back to the agent (https://goo.gl/GXotJW).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1925

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1926

"text": "A String", # Text to display alongside the action.

1927

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1928

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1929

# registered as the default handler for the URL, then this app will be

1930

# opened instead, and its icon will be used in the suggested action UI.

1931

"uri": "A String", # Required. The uri to open on the user device

1932

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1933

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1934

},

1935

],

1936

"text": "A String", # Required. Text sent and displayed to the user.

1937

},

1938

"quickReplies": { # The quick replies response message. # Displays quick replies.

1939

"title": "A String", # Optional. The title of the collection of quick replies.

1940

"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.

1945

# Telephony Gateway.

1946

#

1947

# Telephony Gateway takes the synthesizer settings from

1948

# `DetectIntentResponse.output_audio_config` which can either be set

1949

# at request-level or can come from the agent-level synthesizer config.

1950

"text": "A String", # The raw text to be synthesized.

1951

"ssml": "A String", # The SSML to be synthesized. For more information, see

1952

# [SSML](https://developers.google.com/actions/reference/ssml).

1953

},

1954

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1955

"title": "A String", # Optional. The title of the card.

1956

"buttons": [ # Optional. The collection of card buttons.

1957

{ # Optional. Contains information about a button.

1958

"text": "A String", # Optional. The text to show on the button.

1959

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1964

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1965

},

1966

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

1967

"title": "A String", # Optional. The title of the card.

1968

"image": { # The image response message. # Optional. The image for the card.

1969

"imageUri": "A String", # Optional. The public URI to an image file.

1970

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1971

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1972

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1973

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1974

"buttons": [ # Optional. The collection of card buttons.

1975

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1976

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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

},

1981

],

1982

"subtitle": "A String", # Optional. The subtitle of the card.

1983

},

1984

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1985

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1986

"imageUri": "A String", # Optional. The public URI to an image file.

1987

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1988

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1989

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1990

"buttons": [ # Optional. List of buttons for the card.

1991

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1992

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1993

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1994

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1995

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1996

},

1997

],

1998

"title": "A String", # Required. Title of the card.

1999

"rows": [ # Optional. Rows in this table of data.

2000

{ # Row of TableCard.

2001

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2002

"cells": [ # Optional. List of cells that make up this row.

2003

{ # Cell of TableCardRow.

2004

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2009

"subtitle": "A String", # Optional. Subtitle to the title.

2010

"columnProperties": [ # Optional. Display properties for the columns in this table.

2011

{ # Column properties for TableCard.

2012

"header": "A String", # Required. Column heading.

2013

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2014

},

2015

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2016

},

2017

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2018

"items": [ # Required. Carousel items.

2019

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2020

"description": "A String", # Optional. The body text of the card.

2021

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2022

# dialog.

2023

"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

2028

# response is given.

2029

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2030

"title": "A String", # Required. Title of the carousel item.

2031

"image": { # The image response message. # Optional. The image to display.

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

2040

# or website associated with this agent.

2041

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2042

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2043

# suggestion chip.

2044

},

2045

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2046

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2047

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2048

# items.

2049

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2050

# items, maximum of ten.

2051

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2052

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2053

# text.

2054

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2055

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2056

# the URL. Defaults to opening via web browser.

2057

"url": "A String", # Required. URL

2058

},

2059

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2060

# Card. Maximum of one line of text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2061

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2062

"image": { # The image response message. # Optional. Hero image for the carousel item.

2063

"imageUri": "A String", # Optional. The public URI to an image file.

2064

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2065

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2066

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

2071

# This message in `QueryResult.fulfillment_messages` and

2072

# `WebhookResponse.fulfillment_messages` should contain only one

2073

# `SimpleResponse`.

2074

"simpleResponses": [ # Required. The list of simple responses.

2075

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2076

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2077

# response to the user in the SSML format. Mutually exclusive with

2078

# text_to_speech.

2079

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2080

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2081

# speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2086

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2087

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2088

#

2089

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2090

},

2091

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2092

"mediaObjects": [ # Required. List of media objects.

2093

{ # Response media object for media content card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2094

"name": "A String", # Required. Name of media card.

2095

"description": "A String", # Optional. Description of media card.

2096

"contentUrl": "A String", # Required. Url where the media is stored.

2097

"icon": { # The image response message. # Optional. Icon to display above media content.

2098

"imageUri": "A String", # Optional. The public URI to an image file.

2099

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2100

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2101

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2102

"largeImage": { # The image response message. # Optional. Image to display above media content.

2103

"imageUri": "A String", # Optional. The public URI to an image file.

2104

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2105

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2106

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2107

},

2108

],

2109

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2110

},

2111

"image": { # The image response message. # Displays an image.

2112

"imageUri": "A String", # Optional. The public URI to an image file.

2113

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2114

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2115

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2116

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2117

#

2118

# Rich cards allow you to respond to users with more vivid content, e.g.

2119

# with media and suggestions.

2120

#

2121

# For more details about RBM rich cards, please see:

2122

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2123

# You can group multiple rich cards into one using RbmCarouselCard but

2124

# carousel cards will give you less control over the card layout.

2125

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2126

# Image preview alignment for standalone cards with horizontal layout.

2127

"cardOrientation": "A String", # Required. Orientation of the card.

2128

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2129

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2130

# be set. Media (image, GIF or a video) to include in the card.

2131

# 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

2149

# provide a thumbnail URI, the RBM platform displays a blank

2150

# placeholder thumbnail until the user's device downloads the file.

2151

# Depending on the user's setting, the file may not download

2152

# automatically and may require the user to tap a download button.

2153

"height": "A String", # Required for cards with vertical orientation. The height of the media

2154

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2155

# For a standalone card with horizontal layout, height is not

2156

# customizable, and this field is ignored.

2157

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2158

# determines the MIME type of the file from the content-type field in

2159

# the HTTP headers when the platform fetches the file. The content-type

2160

# field must be present and accurate in the HTTP response from the URL.

2161

},

2162

"suggestions": [ # Optional. List of suggestions to include in the card.

2163

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2164

# easily select/click a predefined response or perform an action (like

2165

# opening a web uri).

2166

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2167

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2168

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2169

# when the user taps the suggested reply. This data will be also

2170

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2171

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2172

},

2173

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2174

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2175

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2176

# but does not dial automatically (https://goo.gl/ergbB2).

2177

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2178

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2179

# format. An example of a correctly formatted phone number:

2180

# +15556767888.

2181

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2182

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2183

# when the user taps the suggested action. This data will be also

2184

# forwarded to webhook to allow performing custom business logic.

2185

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2186

# to send back to the agent (https://goo.gl/GXotJW).

2187

},

2188

"text": "A String", # Text to display alongside the action.

2189

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2190

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2191

# registered as the default handler for the URL, then this app will be

2192

# opened instead, and its icon will be used in the suggested action UI.

2193

"uri": "A String", # Required. The uri to open on the user device

2194

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2195

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2196

},

2197

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2198

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2199

#

2200

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2201

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2202

#

2203

# At least one of the title, description or media must be set.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2204

},

2205

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2206

"payload": { # A custom platform-specific response.

2207

"a_key": "", # Properties of the object.

2208

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2209

},

2210

],

2211

"action": "A String", # Optional. The name of the action associated with the intent.

2212

# Note: The action name must not contain whitespaces.

2213

"name": "A String", # Optional. The unique identifier of this intent.

2214

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2215

# methods.

2216

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2217

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

2218

"inputContextNames": [ # Optional. The list of context names required for this intent to be

2219

# triggered.

2220

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2221

"A String",

2222

],

2223

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

2224

# a direct or indirect parent. We populate this field only in the output.

2225

{ # Represents a single followup intent in the chain.

2226

"followupIntentName": "A String", # The unique identifier of the followup intent.

2227

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2228

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2229

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2230

},

2231

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2232

}

2233

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2234

languageCode: string, Optional. The language used to access language-specific data.

2235

If not specified, the agent's default language is used.

2236

For more information, see

2237

[Multilingual intent and entity

2238

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2239

intentView: string, Optional. The resource view to apply to the returned intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2251

"displayName": "A String", # Required. The name of this intent.

2252

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

2253

# followup intents. It identifies the correct followup intents chain for

2254

# this intent.

2255

#

2256

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2257

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2258

# Note: If `ml_disabled` setting is set to true, then this intent is not

2259

# taken into account during inference in `ML ONLY` match mode. Also,

2260

# auto-markup in the UI is turned off.

2261

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2262

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

2263

# Note: If `ml_enabled` setting is set to false, then this intent is not

2264

# taken into account during inference in `ML ONLY` match mode. Also,

2265

# auto-markup in the UI is turned off.

2266

# DEPRECATED! Please use `ml_disabled` field instead.

2267

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

2268

# then the default value is determined as follows:

2269

# - Before April 15th, 2018 the default is:

2270

# ml_enabled = false / ml_disabled = true.

2271

# - After April 15th, 2018 the default is:

2272

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2273

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2274

# trained on.

2275

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2276

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2277

# The parts are concatenated in order to form the training phrase.

2278

#

2279

# Note: The API does not automatically annotate training phrases like the

2280

# Dialogflow Console does.

2281

#

2282

# Note: Do not forget to include whitespace at part boundaries,

2283

# so the training phrase is well formatted when the parts are concatenated.

2284

#

2285

# If the training phrase does not need to be annotated with parameters,

2286

# you just need a single part with only the Part.text field set.

2287

#

2288

# If you want to annotate the training phrase, you must create multiple

2289

# parts, where the fields of each part are populated in one of two ways:

2290

#

2291

# - `Part.text` is set to a part of the phrase that has no parameters.

2292

# - `Part.text` is set to a part of the phrase that you want to annotate,

2293

# and the `entity_type`, `alias`, and `user_defined` fields are all

2294

# set.

2295

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2296

"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]

2297

# annotated part of the example.

2298

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2299

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2300

# This field is set to true when the Dialogflow Console is used to

2301

# manually annotate the part. When creating an annotated part with the

2302

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2303

"text": "A String", # Required. The text for this part.

2304

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2305

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2306

},

2307

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2308

"name": "A String", # Output only. The unique identifier of this training phrase.

2309

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2310

# the intent. Each time a developer adds an existing sample by editing an

2311

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2312

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2313

},

2314

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2315

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

2316

# session when this intent is matched.

2317

"parameters": [ # Optional. The collection of parameters associated with the intent.

2318

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2319

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

2320

# describes values of the parameter. If the parameter is

2321

# required, this must be provided.

2322

"prompts": [ # Optional. The collection of prompts that the agent can present to the

2323

# user in order to collect a value for the parameter.

2324

"A String",

2325

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2326

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

2327

# whether the intent cannot be completed without collecting the parameter

2328

# value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2329

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

2330

# result.

2331

# Default values can be extracted from contexts by using the following

2332

# syntax: `#context_name.parameter_name`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2333

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2334

"name": "A String", # The unique identifier of this parameter.

2335

"value": "A String", # Optional. The definition of the parameter value. It can be:

2336

#

2337

# - a constant string,

2338

# - a parameter value defined as `$parameter_name`,

2339

# - an original parameter value defined as `$parameter_name.original`,

2340

# - a parameter value from some context defined as

2341

# `#context_name.parameter_name`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2342

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2343

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2344

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2345

"events": [ # Optional. The collection of event names that trigger the intent.

2346

# If the collection of input contexts is not empty, all of the contexts must

2347

# be present in the active user session for an event to trigger this intent.

2348

# Event names are limited to 150 characters.

2349

"A String",

2350

],

2351

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

2352

# chain of followup intents. You can set this field when creating an intent,

2353

# for example with CreateIntent or

2354

# BatchUpdateIntents, in order to make this

2355

# intent a followup intent.

2356

#

2357

# It identifies the parent followup intent.

2358

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2359

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2360

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2361

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2362

# - If the supplied value is unspecified or 0, the service

2363

# translates the value to 500,000, which corresponds to the

2364

# `Normal` priority in the console.

2365

# - If the supplied value is negative, the intent is ignored

2366

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2367

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

2368

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

2369

# to close interaction with an end user. Default is false.

2370

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

2371

# is matched. Context messages in this collection should not set the

2372

# parameters field. Setting the `lifespan_count` to 0 will reset the context

2373

# when the intent is matched.

2374

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2375

{ # Represents a context.

2376

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

2377

# context expires. The default is `0`. If set to `0`, the context expires

2378

# immediately. Contexts expire automatically after 20 minutes if there

2379

# are no matching queries.

2380

"name": "A String", # Required. The unique identifier of the context. Format:

2381

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

2382

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

2383

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

2384

#

2385

# The `Context ID` is always converted to lowercase, may only contain

2386

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2387

#

2388

# If `Environment ID` is not specified, we assume default 'draft'

2389

# environment. If `User ID` is not specified, we assume default '-' user.

2390

#

2391

# The following context names are reserved for internal use by Dialogflow.

2392

# You should not use these contexts or create contexts with these names:

2393

#

2394

# * `__system_counters__`

2395

# * `*_id_dialog_context`

2396

# * `*_dialog_params_size`

2397

"parameters": { # Optional. The collection of parameters associated with this context.

2398

#

2399

# Depending on your protocol or client library language, this is a

2400

# map, associative array, symbol table, dictionary, or JSON object

2401

# composed of a collection of (MapKey, MapValue) pairs:

2402

#

2403

# - MapKey type: string

2404

# - MapKey value: parameter name

2405

# - MapValue type:

2406

# - If parameter's entity type is a composite entity: map

2407

# - Else: string or number, depending on parameter value type

2408

# - MapValue value:

2409

# - If parameter's entity type is a composite entity:

2410

# map from composite entity property names to property values

2411

# - Else: parameter value

2412

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2417

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2418

"A String",

2419

],

2420

"messages": [ # Optional. The collection of rich messages corresponding to the

2421

# `Response` field in the Dialogflow console.

2422

{ # Corresponds to the `Response` field in the Dialogflow console.

2423

"text": { # The text response message. # Returns a text response.

2424

"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.

2429

#

2430

# Rich cards allow you to respond to users with more vivid content, e.g.

2431

# with media and suggestions.

2432

#

2433

# For more details about RBM rich cards, please see:

2434

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2435

# If you want to show a single card with more control over the layout,

2436

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2437

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

2438

# 2 cards and at most 10.

2439

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2440

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2441

# be set. Media (image, GIF or a video) to include in the card.

2442

# 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

2460

# provide a thumbnail URI, the RBM platform displays a blank

2461

# placeholder thumbnail until the user's device downloads the file.

2462

# Depending on the user's setting, the file may not download

2463

# automatically and may require the user to tap a download button.

2464

"height": "A String", # Required for cards with vertical orientation. The height of the media

2465

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2466

# For a standalone card with horizontal layout, height is not

2467

# customizable, and this field is ignored.

2468

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2469

# determines the MIME type of the file from the content-type field in

2470

# the HTTP headers when the platform fetches the file. The content-type

2471

# field must be present and accurate in the HTTP response from the URL.

2472

},

2473

"suggestions": [ # Optional. List of suggestions to include in the card.

2474

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2475

# easily select/click a predefined response or perform an action (like

2476

# opening a web uri).

2477

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2478

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2479

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2480

# when the user taps the suggested reply. This data will be also

2481

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2482

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2483

},

2484

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2485

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2486

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2487

# but does not dial automatically (https://goo.gl/ergbB2).

2488

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2489

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2490

# format. An example of a correctly formatted phone number:

2491

# +15556767888.

2492

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2493

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2494

# when the user taps the suggested action. This data will be also

2495

# forwarded to webhook to allow performing custom business logic.

2496

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2497

# to send back to the agent (https://goo.gl/GXotJW).

2498

},

2499

"text": "A String", # Text to display alongside the action.

2500

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2501

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2502

# registered as the default handler for the URL, then this app will be

2503

# opened instead, and its icon will be used in the suggested action UI.

2504

"uri": "A String", # Required. The uri to open on the user device

2505

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2510

#

2511

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2512

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2513

#

2514

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2515

},

2516

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2517

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2518

},

2519

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2520

"suggestions": [ # Required. The list of suggested replies.

2521

{ # The suggestion chip message that the user can tap to quickly post a reply

2522

# to the conversation.

2523

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2528

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2529

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

2530

# play, e.g., "gs://bucket/object". The object must contain a single

2531

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

2532

#

2533

# This object must be readable by the `service-<Project

2534

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

2535

# where <Project Number> is the number of the Telephony Gateway project

2536

# (usually the same as the Dialogflow agent project). If the Google Cloud

2537

# Storage bucket is in the Telephony Gateway project, this permission is

2538

# added by default when enabling the Dialogflow V2 API.

2539

#

2540

# For audio from other sources, consider using the

2541

# `TelephonySynthesizeSpeech` message with SSML.

2542

},

2543

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

2544

"title": "A String", # Optional. The overall title of the list.

2545

"subtitle": "A String", # Optional. Subtitle of the list.

2546

"items": [ # Required. List items.

2547

{ # An item in the list.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2548

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2549

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2550

# dialog.

2551

"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

2556

# response is given.

2557

},

2558

"title": "A String", # Required. The title of the list item.

2559

"image": { # The image response message. # Optional. The image to display.

2560

"imageUri": "A String", # Optional. The public URI to an image file.

2561

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2562

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2563

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

2568

#

2569

# RBM allows businesses to send enriched and branded versions of SMS. See

2570

# https://jibe.google.com/business-messaging.

2571

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2572

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2573

# easily select/click a predefined response or perform an action (like

2574

# opening a web uri).

2575

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2576

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2577

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2578

# when the user taps the suggested reply. This data will be also

2579

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2580

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2581

},

2582

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2583

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2584

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2585

# but does not dial automatically (https://goo.gl/ergbB2).

2586

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2587

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2588

# format. An example of a correctly formatted phone number:

2589

# +15556767888.

2590

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2591

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2592

# when the user taps the suggested action. This data will be also

2593

# forwarded to webhook to allow performing custom business logic.

2594

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2595

# to send back to the agent (https://goo.gl/GXotJW).

2596

},

2597

"text": "A String", # Text to display alongside the action.

2598

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2599

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2600

# registered as the default handler for the URL, then this app will be

2601

# opened instead, and its icon will be used in the suggested action UI.

2602

"uri": "A String", # Required. The uri to open on the user device

2603

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

2608

},

2609

"quickReplies": { # The quick replies response message. # Displays quick replies.

2610

"title": "A String", # Optional. The title of the collection of quick replies.

2611

"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.

2616

# Telephony Gateway.

2617

#

2618

# Telephony Gateway takes the synthesizer settings from

2619

# `DetectIntentResponse.output_audio_config` which can either be set

2620

# at request-level or can come from the agent-level synthesizer config.

2621

"text": "A String", # The raw text to be synthesized.

2622

"ssml": "A String", # The SSML to be synthesized. For more information, see

2623

# [SSML](https://developers.google.com/actions/reference/ssml).

2624

},

2625

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2626

"title": "A String", # Optional. The title of the card.

2627

"buttons": [ # Optional. The collection of card buttons.

2628

{ # Optional. Contains information about a button.

2629

"text": "A String", # Optional. The text to show on the button.

2630

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2635

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2636

},

2637

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

2638

"title": "A String", # Optional. The title of the card.

2639

"image": { # The image response message. # Optional. The image for the card.

2640

"imageUri": "A String", # Optional. The public URI to an image file.

2641

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2642

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2643

},

2644

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2645

"buttons": [ # Optional. The collection of card buttons.

2646

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2647

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2651

},

2652

],

2653

"subtitle": "A String", # Optional. The subtitle of the card.

2654

},

2655

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2656

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2657

"imageUri": "A String", # Optional. The public URI to an image file.

2658

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2659

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2660

},

2661

"buttons": [ # Optional. List of buttons for the card.

2662

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2663

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2664

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2665

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2666

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2667

},

2668

],

2669

"title": "A String", # Required. Title of the card.

2670

"rows": [ # Optional. Rows in this table of data.

2671

{ # Row of TableCard.

2672

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2673

"cells": [ # Optional. List of cells that make up this row.

2674

{ # Cell of TableCardRow.

2675

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2680

"subtitle": "A String", # Optional. Subtitle to the title.

2681

"columnProperties": [ # Optional. Display properties for the columns in this table.

2682

{ # Column properties for TableCard.

2683

"header": "A String", # Required. Column heading.

2684

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2685

},

2686

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2687

},

2688

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2689

"items": [ # Required. Carousel items.

2690

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2691

"description": "A String", # Optional. The body text of the card.

2692

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2693

# dialog.

2694

"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

2699

# response is given.

2700

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2701

"title": "A String", # Required. Title of the carousel item.

2702

"image": { # The image response message. # Optional. The image to display.

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

2711

# or website associated with this agent.

2712

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2713

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2714

# suggestion chip.

2715

},

2716

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2717

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2718

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2719

# items.

2720

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2721

# items, maximum of ten.

2722

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2723

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2724

# text.

2725

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2726

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2727

# the URL. Defaults to opening via web browser.

2728

"url": "A String", # Required. URL

2729

},

2730

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2731

# Card. Maximum of one line of text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2732

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2733

"image": { # The image response message. # Optional. Hero image for the carousel item.

2734

"imageUri": "A String", # Optional. The public URI to an image file.

2735

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2736

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2737

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

2742

# This message in `QueryResult.fulfillment_messages` and

2743

# `WebhookResponse.fulfillment_messages` should contain only one

2744

# `SimpleResponse`.

2745

"simpleResponses": [ # Required. The list of simple responses.

2746

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2747

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2748

# response to the user in the SSML format. Mutually exclusive with

2749

# text_to_speech.

2750

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2751

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2752

# speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2757

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2758

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2759

#

2760

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2761

},

2762

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2763

"mediaObjects": [ # Required. List of media objects.

2764

{ # Response media object for media content card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2765

"name": "A String", # Required. Name of media card.

2766

"description": "A String", # Optional. Description of media card.

2767

"contentUrl": "A String", # Required. Url where the media is stored.

2768

"icon": { # The image response message. # Optional. Icon to display above media content.

2769

"imageUri": "A String", # Optional. The public URI to an image file.

2770

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2771

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2772

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2773

"largeImage": { # The image response message. # Optional. Image to display above media content.

2774

"imageUri": "A String", # Optional. The public URI to an image file.

2775

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2776

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2777

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2778

},

2779

],

2780

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2781

},

2782

"image": { # The image response message. # Displays an image.

2783

"imageUri": "A String", # Optional. The public URI to an image file.

2784

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2785

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2786

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2787

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2788

#

2789

# Rich cards allow you to respond to users with more vivid content, e.g.

2790

# with media and suggestions.

2791

#

2792

# For more details about RBM rich cards, please see:

2793

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2794

# You can group multiple rich cards into one using RbmCarouselCard but

2795

# carousel cards will give you less control over the card layout.

2796

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2797

# Image preview alignment for standalone cards with horizontal layout.

2798

"cardOrientation": "A String", # Required. Orientation of the card.

2799

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2800

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2801

# be set. Media (image, GIF or a video) to include in the card.

2802

# 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

2820

# provide a thumbnail URI, the RBM platform displays a blank

2821

# placeholder thumbnail until the user's device downloads the file.

2822

# Depending on the user's setting, the file may not download

2823

# automatically and may require the user to tap a download button.

2824

"height": "A String", # Required for cards with vertical orientation. The height of the media

2825

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2826

# For a standalone card with horizontal layout, height is not

2827

# customizable, and this field is ignored.

2828

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2829

# determines the MIME type of the file from the content-type field in

2830

# the HTTP headers when the platform fetches the file. The content-type

2831

# field must be present and accurate in the HTTP response from the URL.

2832

},

2833

"suggestions": [ # Optional. List of suggestions to include in the card.

2834

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2835

# easily select/click a predefined response or perform an action (like

2836

# opening a web uri).

2837

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2838

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2839

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2840

# when the user taps the suggested reply. This data will be also

2841

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2842

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2843

},

2844

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2845

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2846

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2847

# but does not dial automatically (https://goo.gl/ergbB2).

2848

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2849

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2850

# format. An example of a correctly formatted phone number:

2851

# +15556767888.

2852

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2853

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2854

# when the user taps the suggested action. This data will be also

2855

# forwarded to webhook to allow performing custom business logic.

2856

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2857

# to send back to the agent (https://goo.gl/GXotJW).

2858

},

2859

"text": "A String", # Text to display alongside the action.

2860

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2861

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2862

# registered as the default handler for the URL, then this app will be

2863

# opened instead, and its icon will be used in the suggested action UI.

2864

"uri": "A String", # Required. The uri to open on the user device

2865

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2870

#

2871

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2872

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2873

#

2874

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2875

},

2876

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2877

"payload": { # A custom platform-specific response.

2878

"a_key": "", # Properties of the object.

2879

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2880

},

2881

],

2882

"action": "A String", # Optional. The name of the action associated with the intent.

2883

# Note: The action name must not contain whitespaces.

2884

"name": "A String", # Optional. The unique identifier of this intent.

2885

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2886

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2887

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2888

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

2889

"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]

2890

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2891

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2892

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2893

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2894

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

2895

# a direct or indirect parent. We populate this field only in the output.

2896

{ # Represents a single followup intent in the chain.

2897

"followupIntentName": "A String", # The unique identifier of the followup intent.

2898

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2899

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2900

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2901

},

2902

],

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-27 12:20:54 -0700

[diff] [blame^]

2959

"displayName": "A String", # Required. The name of this intent.

2960

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

2961

# followup intents. It identifies the correct followup intents chain for

2962

# this intent.

2963

#

2964

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2965

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2966

# Note: If `ml_disabled` setting is set to true, then this intent is not

2967

# taken into account during inference in `ML ONLY` match mode. Also,

2968

# auto-markup in the UI is turned off.

2969

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2970

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

2971

# Note: If `ml_enabled` setting is set to false, then this intent is not

2972

# taken into account during inference in `ML ONLY` match mode. Also,

2973

# auto-markup in the UI is turned off.

2974

# DEPRECATED! Please use `ml_disabled` field instead.

2975

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

2976

# then the default value is determined as follows:

2977

# - Before April 15th, 2018 the default is:

2978

# ml_enabled = false / ml_disabled = true.

2979

# - After April 15th, 2018 the default is:

2980

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2981

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2982

# trained on.

2983

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2984

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2985

# The parts are concatenated in order to form the training phrase.

2986

#

2987

# Note: The API does not automatically annotate training phrases like the

2988

# Dialogflow Console does.

2989

#

2990

# Note: Do not forget to include whitespace at part boundaries,

2991

# so the training phrase is well formatted when the parts are concatenated.

2992

#

2993

# If the training phrase does not need to be annotated with parameters,

2994

# you just need a single part with only the Part.text field set.

2995

#

2996

# If you want to annotate the training phrase, you must create multiple

2997

# parts, where the fields of each part are populated in one of two ways:

2998

#

2999

# - `Part.text` is set to a part of the phrase that has no parameters.

3000

# - `Part.text` is set to a part of the phrase that you want to annotate,

3001

# and the `entity_type`, `alias`, and `user_defined` fields are all

3002

# set.

3003

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3004

"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]

3005

# annotated part of the example.

3006

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3007

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3008

# This field is set to true when the Dialogflow Console is used to

3009

# manually annotate the part. When creating an annotated part with the

3010

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3011

"text": "A String", # Required. The text for this part.

3012

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3013

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3014

},

3015

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3016

"name": "A String", # Output only. The unique identifier of this training phrase.

3017

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3018

# the intent. Each time a developer adds an existing sample by editing an

3019

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3020

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3021

},

3022

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3023

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

3024

# session when this intent is matched.

3025

"parameters": [ # Optional. The collection of parameters associated with the intent.

3026

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3027

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3028

# describes values of the parameter. If the parameter is

3029

# required, this must be provided.

3030

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3031

# user in order to collect a value for the parameter.

3032

"A String",

3033

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3034

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3035

# whether the intent cannot be completed without collecting the parameter

3036

# value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3037

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3038

# result.

3039

# Default values can be extracted from contexts by using the following

3040

# syntax: `#context_name.parameter_name`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3041

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

3042

"name": "A String", # The unique identifier of this parameter.

3043

"value": "A String", # Optional. The definition of the parameter value. It can be:

3044

#

3045

# - a constant string,

3046

# - a parameter value defined as `$parameter_name`,

3047

# - an original parameter value defined as `$parameter_name.original`,

3048

# - a parameter value from some context defined as

3049

# `#context_name.parameter_name`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3050

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3051

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3052

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3053

"events": [ # Optional. The collection of event names that trigger the intent.

3054

# If the collection of input contexts is not empty, all of the contexts must

3055

# be present in the active user session for an event to trigger this intent.

3056

# Event names are limited to 150 characters.

3057

"A String",

3058

],

3059

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

3060

# chain of followup intents. You can set this field when creating an intent,

3061

# for example with CreateIntent or

3062

# BatchUpdateIntents, in order to make this

3063

# intent a followup intent.

3064

#

3065

# It identifies the parent followup intent.

3066

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3067

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3068

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3069

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3070

# - If the supplied value is unspecified or 0, the service

3071

# translates the value to 500,000, which corresponds to the

3072

# `Normal` priority in the console.

3073

# - If the supplied value is negative, the intent is ignored

3074

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3075

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

3076

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

3077

# to close interaction with an end user. Default is false.

3078

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3079

# is matched. Context messages in this collection should not set the

3080

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3081

# when the intent is matched.

3082

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3083

{ # Represents a context.

3084

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3085

# context expires. The default is `0`. If set to `0`, the context expires

3086

# immediately. Contexts expire automatically after 20 minutes if there

3087

# are no matching queries.

3088

"name": "A String", # Required. The unique identifier of the context. Format:

3089

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3090

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3091

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3092

#

3093

# The `Context ID` is always converted to lowercase, may only contain

3094

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3095

#

3096

# If `Environment ID` is not specified, we assume default 'draft'

3097

# environment. If `User ID` is not specified, we assume default '-' user.

3098

#

3099

# The following context names are reserved for internal use by Dialogflow.

3100

# You should not use these contexts or create contexts with these names:

3101

#

3102

# * `__system_counters__`

3103

# * `*_id_dialog_context`

3104

# * `*_dialog_params_size`

3105

"parameters": { # Optional. The collection of parameters associated with this context.

3106

#

3107

# Depending on your protocol or client library language, this is a

3108

# map, associative array, symbol table, dictionary, or JSON object

3109

# composed of a collection of (MapKey, MapValue) pairs:

3110

#

3111

# - MapKey type: string

3112

# - MapKey value: parameter name

3113

# - MapValue type:

3114

# - If parameter's entity type is a composite entity: map

3115

# - Else: string or number, depending on parameter value type

3116

# - MapValue value:

3117

# - If parameter's entity type is a composite entity:

3118

# map from composite entity property names to property values

3119

# - Else: parameter value

3120

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3125

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3126

"A String",

3127

],

3128

"messages": [ # Optional. The collection of rich messages corresponding to the

3129

# `Response` field in the Dialogflow console.

3130

{ # Corresponds to the `Response` field in the Dialogflow console.

3131

"text": { # The text response message. # Returns a text response.

3132

"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.

3137

#

3138

# Rich cards allow you to respond to users with more vivid content, e.g.

3139

# with media and suggestions.

3140

#

3141

# For more details about RBM rich cards, please see:

3142

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

3143

# If you want to show a single card with more control over the layout,

3144

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3145

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

3146

# 2 cards and at most 10.

3147

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3148

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3149

# be set. Media (image, GIF or a video) to include in the card.

3150

# 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

3168

# provide a thumbnail URI, the RBM platform displays a blank

3169

# placeholder thumbnail until the user's device downloads the file.

3170

# Depending on the user's setting, the file may not download

3171

# automatically and may require the user to tap a download button.

3172

"height": "A String", # Required for cards with vertical orientation. The height of the media

3173

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

3174

# For a standalone card with horizontal layout, height is not

3175

# customizable, and this field is ignored.

3176

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

3177

# determines the MIME type of the file from the content-type field in

3178

# the HTTP headers when the platform fetches the file. The content-type

3179

# field must be present and accurate in the HTTP response from the URL.

3180

},

3181

"suggestions": [ # Optional. List of suggestions to include in the card.

3182

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3183

# easily select/click a predefined response or perform an action (like

3184

# opening a web uri).

3185

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3186

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3187

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3188

# when the user taps the suggested reply. This data will be also

3189

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3190

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3191

},

3192

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3193

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3194

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3195

# but does not dial automatically (https://goo.gl/ergbB2).

3196

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3197

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3198

# format. An example of a correctly formatted phone number:

3199

# +15556767888.

3200

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3201

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3202

# when the user taps the suggested action. This data will be also

3203

# forwarded to webhook to allow performing custom business logic.

3204

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3205

# to send back to the agent (https://goo.gl/GXotJW).

3206

},

3207

"text": "A String", # Text to display alongside the action.

3208

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3209

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3210

# registered as the default handler for the URL, then this app will be

3211

# opened instead, and its icon will be used in the suggested action UI.

3212

"uri": "A String", # Required. The uri to open on the user device

3213

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

3218

#

3219

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3220

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

3221

#

3222

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3223

},

3224

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3225

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3226

},

3227

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

3228

"suggestions": [ # Required. The list of suggested replies.

3229

{ # The suggestion chip message that the user can tap to quickly post a reply

3230

# to the conversation.

3231

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

3236

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

3237

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

3238

# play, e.g., "gs://bucket/object". The object must contain a single

3239

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

3240

#

3241

# This object must be readable by the `service-<Project

3242

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

3243

# where <Project Number> is the number of the Telephony Gateway project

3244

# (usually the same as the Dialogflow agent project). If the Google Cloud

3245

# Storage bucket is in the Telephony Gateway project, this permission is

3246

# added by default when enabling the Dialogflow V2 API.

3247

#

3248

# For audio from other sources, consider using the

3249

# `TelephonySynthesizeSpeech` message with SSML.

3250

},

3251

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

3252

"title": "A String", # Optional. The overall title of the list.

3253

"subtitle": "A String", # Optional. Subtitle of the list.

3254

"items": [ # Required. List items.

3255

{ # An item in the list.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3256

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3257

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3258

# dialog.

3259

"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

3264

# response is given.

3265

},

3266

"title": "A String", # Required. The title of the list item.

3267

"image": { # The image response message. # Optional. The image to display.

3268

"imageUri": "A String", # Optional. The public URI to an image file.

3269

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3270

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3271

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

3276

#

3277

# RBM allows businesses to send enriched and branded versions of SMS. See

3278

# https://jibe.google.com/business-messaging.

3279

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

3280

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3281

# easily select/click a predefined response or perform an action (like

3282

# opening a web uri).

3283

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3284

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3285

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3286

# when the user taps the suggested reply. This data will be also

3287

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3288

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3289

},

3290

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3291

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3292

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3293

# but does not dial automatically (https://goo.gl/ergbB2).

3294

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3295

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3296

# format. An example of a correctly formatted phone number:

3297

# +15556767888.

3298

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3299

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3300

# when the user taps the suggested action. This data will be also

3301

# forwarded to webhook to allow performing custom business logic.

3302

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3303

# to send back to the agent (https://goo.gl/GXotJW).

3304

},

3305

"text": "A String", # Text to display alongside the action.

3306

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3307

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3308

# registered as the default handler for the URL, then this app will be

3309

# opened instead, and its icon will be used in the suggested action UI.

3310

"uri": "A String", # Required. The uri to open on the user device

3311

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

3316

},

3317

"quickReplies": { # The quick replies response message. # Displays quick replies.

3318

"title": "A String", # Optional. The title of the collection of quick replies.

3319

"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.

3324

# Telephony Gateway.

3325

#

3326

# Telephony Gateway takes the synthesizer settings from

3327

# `DetectIntentResponse.output_audio_config` which can either be set

3328

# at request-level or can come from the agent-level synthesizer config.

3329

"text": "A String", # The raw text to be synthesized.

3330

"ssml": "A String", # The SSML to be synthesized. For more information, see

3331

# [SSML](https://developers.google.com/actions/reference/ssml).

3332

},

3333

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3334

"title": "A String", # Optional. The title of the card.

3335

"buttons": [ # Optional. The collection of card buttons.

3336

{ # Optional. Contains information about a button.

3337

"text": "A String", # Optional. The text to show on the button.

3338

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3343

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3344

},

3345

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

3346

"title": "A String", # Optional. The title of the card.

3347

"image": { # The image response message. # Optional. The image for the card.

3348

"imageUri": "A String", # Optional. The public URI to an image file.

3349

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3350

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3351

},

3352

"formattedText": "A String", # Required, unless image is present. The body text of the card.

3353

"buttons": [ # Optional. The collection of card buttons.

3354

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3355

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3359

},

3360

],

3361

"subtitle": "A String", # Optional. The subtitle of the card.

3362

},

3363

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3364

"image": { # The image response message. # Optional. Image which should be displayed on the card.

3365

"imageUri": "A String", # Optional. The public URI to an image file.

3366

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3367

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3368

},

3369

"buttons": [ # Optional. List of buttons for the card.

3370

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3371

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3372

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3373

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

3374

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3375

},

3376

],

3377

"title": "A String", # Required. Title of the card.

3378

"rows": [ # Optional. Rows in this table of data.

3379

{ # Row of TableCard.

3380

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

3381

"cells": [ # Optional. List of cells that make up this row.

3382

{ # Cell of TableCardRow.

3383

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3388

"subtitle": "A String", # Optional. Subtitle to the title.

3389

"columnProperties": [ # Optional. Display properties for the columns in this table.

3390

{ # Column properties for TableCard.

3391

"header": "A String", # Required. Column heading.

3392

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

3393

},

3394

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3395

},

3396

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

3397

"items": [ # Required. Carousel items.

3398

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3399

"description": "A String", # Optional. The body text of the card.

3400

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

3401

# dialog.

3402

"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

3407

# response is given.

3408

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3409

"title": "A String", # Required. Title of the carousel item.

3410

"image": { # The image response message. # Optional. The image to display.

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

3419

# or website associated with this agent.

3420

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

3421

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

3422

# suggestion chip.

3423

},

3424

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

3425

# https://developers.google.com/actions/assistant/responses#browsing_carousel

3426

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

3427

# items.

3428

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

3429

# items, maximum of ten.

3430

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3431

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

3432

# text.

3433

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

3434

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

3435

# the URL. Defaults to opening via web browser.

3436

"url": "A String", # Required. URL

3437

},

3438

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

3439

# Card. Maximum of one line of text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3440

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

3441

"image": { # The image response message. # Optional. Hero image for the carousel item.

3442

"imageUri": "A String", # Optional. The public URI to an image file.

3443

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3444

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3445

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

3450

# This message in `QueryResult.fulfillment_messages` and

3451

# `WebhookResponse.fulfillment_messages` should contain only one

3452

# `SimpleResponse`.

3453

"simpleResponses": [ # Required. The list of simple responses.

3454

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3455

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

3456

# response to the user in the SSML format. Mutually exclusive with

3457

# text_to_speech.

3458

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3459

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

3460

# speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

3465

"phoneNumber": "A String", # Required. The phone number to transfer the call to

3466

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

3467

#

3468

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

3469

},

3470

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

3471

"mediaObjects": [ # Required. List of media objects.

3472

{ # Response media object for media content card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3473

"name": "A String", # Required. Name of media card.

3474

"description": "A String", # Optional. Description of media card.

3475

"contentUrl": "A String", # Required. Url where the media is stored.

3476

"icon": { # The image response message. # Optional. Icon to display above media content.

3477

"imageUri": "A String", # Optional. The public URI to an image file.

3478

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3479

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3480

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3481

"largeImage": { # The image response message. # Optional. Image to display above media content.

3482

"imageUri": "A String", # Optional. The public URI to an image file.

3483

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3484

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3485

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3486

},

3487

],

3488

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

3489

},

3490

"image": { # The image response message. # Displays an image.

3491

"imageUri": "A String", # Optional. The public URI to an image file.

3492

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3493

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3494

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3495

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

3496

#

3497

# Rich cards allow you to respond to users with more vivid content, e.g.

3498

# with media and suggestions.

3499

#

3500

# For more details about RBM rich cards, please see:

3501

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

3502

# You can group multiple rich cards into one using RbmCarouselCard but

3503

# carousel cards will give you less control over the card layout.

3504

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

3505

# Image preview alignment for standalone cards with horizontal layout.

3506

"cardOrientation": "A String", # Required. Orientation of the card.

3507

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3508

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3509

# be set. Media (image, GIF or a video) to include in the card.

3510

# 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

3528

# provide a thumbnail URI, the RBM platform displays a blank

3529

# placeholder thumbnail until the user's device downloads the file.

3530

# Depending on the user's setting, the file may not download

3531

# automatically and may require the user to tap a download button.

3532

"height": "A String", # Required for cards with vertical orientation. The height of the media

3533

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

3534

# For a standalone card with horizontal layout, height is not

3535

# customizable, and this field is ignored.

3536

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

3537

# determines the MIME type of the file from the content-type field in

3538

# the HTTP headers when the platform fetches the file. The content-type

3539

# field must be present and accurate in the HTTP response from the URL.

3540

},

3541

"suggestions": [ # Optional. List of suggestions to include in the card.

3542

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3543

# easily select/click a predefined response or perform an action (like

3544

# opening a web uri).

3545

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3546

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3547

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3548

# when the user taps the suggested reply. This data will be also

3549

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3550

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3551

},

3552

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3553

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3554

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3555

# but does not dial automatically (https://goo.gl/ergbB2).

3556

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3557

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3558

# format. An example of a correctly formatted phone number:

3559

# +15556767888.

3560

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3561

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3562

# when the user taps the suggested action. This data will be also

3563

# forwarded to webhook to allow performing custom business logic.

3564

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3565

# to send back to the agent (https://goo.gl/GXotJW).

3566

},

3567

"text": "A String", # Text to display alongside the action.

3568

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3569

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3570

# registered as the default handler for the URL, then this app will be

3571

# opened instead, and its icon will be used in the suggested action UI.

3572

"uri": "A String", # Required. The uri to open on the user device

3573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

3578

#

3579

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3580

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

3581

#

3582

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3583

},

3584

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3585

"payload": { # A custom platform-specific response.

3586

"a_key": "", # Properties of the object.

3587

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3588

},

3589

],

3590

"action": "A String", # Optional. The name of the action associated with the intent.

3591

# Note: The action name must not contain whitespaces.

3592

"name": "A String", # Optional. The unique identifier of this intent.

3593

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

3594

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3595

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3596

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

3597

"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]

3598

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3599

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3600

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3601

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3602

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

3603

# a direct or indirect parent. We populate this field only in the output.

3604

{ # Represents a single followup intent in the chain.

3605

"followupIntentName": "A String", # The unique identifier of the followup intent.

3606

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3607

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

3608

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3609

},

3610

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3615

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, intentView=None, languageCode=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3621

pageToken: string, Optional. The next_page_token value returned from a previous list request.

3622

pageSize: integer, Optional. The maximum number of items to return in a single page. By

3623

default 100 and at most 1000.

3624

intentView: string, Optional. The resource view to apply to the returned intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3625

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3626

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3627

For more information, see

3628

[Multilingual intent and entity

3629

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

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-27 12:20:54 -0700

[diff] [blame^]

3644

"displayName": "A String", # Required. The name of this intent.

3645

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

3646

# followup intents. It identifies the correct followup intents chain for

3647

# this intent.

3648

#

3649

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3650

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

3651

# Note: If `ml_disabled` setting is set to true, then this intent is not

3652

# taken into account during inference in `ML ONLY` match mode. Also,

3653

# auto-markup in the UI is turned off.

3654

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

3655

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

3656

# Note: If `ml_enabled` setting is set to false, then this intent is not

3657

# taken into account during inference in `ML ONLY` match mode. Also,

3658

# auto-markup in the UI is turned off.

3659

# DEPRECATED! Please use `ml_disabled` field instead.

3660

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

3661

# then the default value is determined as follows:

3662

# - Before April 15th, 2018 the default is:

3663

# ml_enabled = false / ml_disabled = true.

3664

# - After April 15th, 2018 the default is:

3665

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3666

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3667

# trained on.

3668

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3669

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3670

# The parts are concatenated in order to form the training phrase.

3671

#

3672

# Note: The API does not automatically annotate training phrases like the

3673

# Dialogflow Console does.

3674

#

3675

# Note: Do not forget to include whitespace at part boundaries,

3676

# so the training phrase is well formatted when the parts are concatenated.

3677

#

3678

# If the training phrase does not need to be annotated with parameters,

3679

# you just need a single part with only the Part.text field set.

3680

#

3681

# If you want to annotate the training phrase, you must create multiple

3682

# parts, where the fields of each part are populated in one of two ways:

3683

#

3684

# - `Part.text` is set to a part of the phrase that has no parameters.

3685

# - `Part.text` is set to a part of the phrase that you want to annotate,

3686

# and the `entity_type`, `alias`, and `user_defined` fields are all

3687

# set.

3688

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3689

"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]

3690

# annotated part of the example.

3691

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3692

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3693

# This field is set to true when the Dialogflow Console is used to

3694

# manually annotate the part. When creating an annotated part with the

3695

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3696

"text": "A String", # Required. The text for this part.

3697

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3698

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3699

},

3700

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3701

"name": "A String", # Output only. The unique identifier of this training phrase.

3702

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3703

# the intent. Each time a developer adds an existing sample by editing an

3704

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3705

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3706

},

3707

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3708

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

3709

# session when this intent is matched.

3710

"parameters": [ # Optional. The collection of parameters associated with the intent.

3711

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3712

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3713

# describes values of the parameter. If the parameter is

3714

# required, this must be provided.

3715

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3716

# user in order to collect a value for the parameter.

3717

"A String",

3718

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3719

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3720

# whether the intent cannot be completed without collecting the parameter

3721

# value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3722

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3723

# result.

3724

# Default values can be extracted from contexts by using the following

3725

# syntax: `#context_name.parameter_name`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3726

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

3727

"name": "A String", # The unique identifier of this parameter.

3728

"value": "A String", # Optional. The definition of the parameter value. It can be:

3729

#

3730

# - a constant string,

3731

# - a parameter value defined as `$parameter_name`,

3732

# - an original parameter value defined as `$parameter_name.original`,

3733

# - a parameter value from some context defined as

3734

# `#context_name.parameter_name`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3735

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3736

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3737

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3738

"events": [ # Optional. The collection of event names that trigger the intent.

3739

# If the collection of input contexts is not empty, all of the contexts must

3740

# be present in the active user session for an event to trigger this intent.

3741

# Event names are limited to 150 characters.

3742

"A String",

3743

],

3744

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

3745

# chain of followup intents. You can set this field when creating an intent,

3746

# for example with CreateIntent or

3747

# BatchUpdateIntents, in order to make this

3748

# intent a followup intent.

3749

#

3750

# It identifies the parent followup intent.

3751

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3752

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3753

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3754

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3755

# - If the supplied value is unspecified or 0, the service

3756

# translates the value to 500,000, which corresponds to the

3757

# `Normal` priority in the console.

3758

# - If the supplied value is negative, the intent is ignored

3759

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3760

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

3761

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

3762

# to close interaction with an end user. Default is false.

3763

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3764

# is matched. Context messages in this collection should not set the

3765

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3766

# when the intent is matched.

3767

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3768

{ # Represents a context.

3769

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3770

# context expires. The default is `0`. If set to `0`, the context expires

3771

# immediately. Contexts expire automatically after 20 minutes if there

3772

# are no matching queries.

3773

"name": "A String", # Required. The unique identifier of the context. Format:

3774

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3775

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3776

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3777

#

3778

# The `Context ID` is always converted to lowercase, may only contain

3779

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3780

#

3781

# If `Environment ID` is not specified, we assume default 'draft'

3782

# environment. If `User ID` is not specified, we assume default '-' user.

3783

#

3784

# The following context names are reserved for internal use by Dialogflow.

3785

# You should not use these contexts or create contexts with these names:

3786

#

3787

# * `__system_counters__`

3788

# * `*_id_dialog_context`

3789

# * `*_dialog_params_size`

3790

"parameters": { # Optional. The collection of parameters associated with this context.

3791

#

3792

# Depending on your protocol or client library language, this is a

3793

# map, associative array, symbol table, dictionary, or JSON object

3794

# composed of a collection of (MapKey, MapValue) pairs:

3795

#

3796

# - MapKey type: string

3797

# - MapKey value: parameter name

3798

# - MapValue type:

3799

# - If parameter's entity type is a composite entity: map

3800

# - Else: string or number, depending on parameter value type

3801

# - MapValue value:

3802

# - If parameter's entity type is a composite entity:

3803

# map from composite entity property names to property values

3804

# - Else: parameter value

3805

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3810

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3811

"A String",

3812

],

3813

"messages": [ # Optional. The collection of rich messages corresponding to the

3814

# `Response` field in the Dialogflow console.

3815

{ # Corresponds to the `Response` field in the Dialogflow console.

3816

"text": { # The text response message. # Returns a text response.

3817

"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.

3822

#

3823

# Rich cards allow you to respond to users with more vivid content, e.g.

3824

# with media and suggestions.

3825

#

3826

# For more details about RBM rich cards, please see:

3827

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

3828

# If you want to show a single card with more control over the layout,

3829

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3830

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

3831

# 2 cards and at most 10.

3832

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3833

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3834

# be set. Media (image, GIF or a video) to include in the card.

3835

# 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

3853

# provide a thumbnail URI, the RBM platform displays a blank

3854

# placeholder thumbnail until the user's device downloads the file.

3855

# Depending on the user's setting, the file may not download

3856

# automatically and may require the user to tap a download button.

3857

"height": "A String", # Required for cards with vertical orientation. The height of the media

3858

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

3859

# For a standalone card with horizontal layout, height is not

3860

# customizable, and this field is ignored.

3861

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

3862

# determines the MIME type of the file from the content-type field in

3863

# the HTTP headers when the platform fetches the file. The content-type

3864

# field must be present and accurate in the HTTP response from the URL.

3865

},

3866

"suggestions": [ # Optional. List of suggestions to include in the card.

3867

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3868

# easily select/click a predefined response or perform an action (like

3869

# opening a web uri).

3870

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3871

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3872

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3873

# when the user taps the suggested reply. This data will be also

3874

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3875

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3876

},

3877

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3878

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3879

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3880

# but does not dial automatically (https://goo.gl/ergbB2).

3881

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3882

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3883

# format. An example of a correctly formatted phone number:

3884

# +15556767888.

3885

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3886

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3887

# when the user taps the suggested action. This data will be also

3888

# forwarded to webhook to allow performing custom business logic.

3889

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3890

# to send back to the agent (https://goo.gl/GXotJW).

3891

},

3892

"text": "A String", # Text to display alongside the action.

3893

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3894

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3895

# registered as the default handler for the URL, then this app will be

3896

# opened instead, and its icon will be used in the suggested action UI.

3897

"uri": "A String", # Required. The uri to open on the user device

3898

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

3903

#

3904

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3905

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

3906

#

3907

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3908

},

3909

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3910

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3911

},

3912

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

3913

"suggestions": [ # Required. The list of suggested replies.

3914

{ # The suggestion chip message that the user can tap to quickly post a reply

3915

# to the conversation.

3916

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

3921

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

3922

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

3923

# play, e.g., "gs://bucket/object". The object must contain a single

3924

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

3925

#

3926

# This object must be readable by the `service-<Project

3927

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

3928

# where <Project Number> is the number of the Telephony Gateway project

3929

# (usually the same as the Dialogflow agent project). If the Google Cloud

3930

# Storage bucket is in the Telephony Gateway project, this permission is

3931

# added by default when enabling the Dialogflow V2 API.

3932

#

3933

# For audio from other sources, consider using the

3934

# `TelephonySynthesizeSpeech` message with SSML.

3935

},

3936

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

3937

"title": "A String", # Optional. The overall title of the list.

3938

"subtitle": "A String", # Optional. Subtitle of the list.

3939

"items": [ # Required. List items.

3940

{ # An item in the list.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3941

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3942

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3943

# dialog.

3944

"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

3949

# response is given.

3950

},

3951

"title": "A String", # Required. The title of the list item.

3952

"image": { # The image response message. # Optional. The image to display.

3953

"imageUri": "A String", # Optional. The public URI to an image file.

3954

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3955

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3956

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

3961

#

3962

# RBM allows businesses to send enriched and branded versions of SMS. See

3963

# https://jibe.google.com/business-messaging.

3964

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

3965

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3966

# easily select/click a predefined response or perform an action (like

3967

# opening a web uri).

3968

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3969

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3970

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3971

# when the user taps the suggested reply. This data will be also

3972

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3973

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3974

},

3975

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3976

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3977

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3978

# but does not dial automatically (https://goo.gl/ergbB2).

3979

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3980

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3981

# format. An example of a correctly formatted phone number:

3982

# +15556767888.

3983

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3984

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3985

# when the user taps the suggested action. This data will be also

3986

# forwarded to webhook to allow performing custom business logic.

3987

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3988

# to send back to the agent (https://goo.gl/GXotJW).

3989

},

3990

"text": "A String", # Text to display alongside the action.

3991

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3992

# (https://goo.gl/6GLJD2). If the user has an app installed that is

3993

# registered as the default handler for the URL, then this app will be

3994

# opened instead, and its icon will be used in the suggested action UI.

3995

"uri": "A String", # Required. The uri to open on the user device

3996

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

4001

},

4002

"quickReplies": { # The quick replies response message. # Displays quick replies.

4003

"title": "A String", # Optional. The title of the collection of quick replies.

4004

"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.

4009

# Telephony Gateway.

4010

#

4011

# Telephony Gateway takes the synthesizer settings from

4012

# `DetectIntentResponse.output_audio_config` which can either be set

4013

# at request-level or can come from the agent-level synthesizer config.

4014

"text": "A String", # The raw text to be synthesized.

4015

"ssml": "A String", # The SSML to be synthesized. For more information, see

4016

# [SSML](https://developers.google.com/actions/reference/ssml).

4017

},

4018

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4019

"title": "A String", # Optional. The title of the card.

4020

"buttons": [ # Optional. The collection of card buttons.

4021

{ # Optional. Contains information about a button.

4022

"text": "A String", # Optional. The text to show on the button.

4023

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4028

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4029

},

4030

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

4031

"title": "A String", # Optional. The title of the card.

4032

"image": { # The image response message. # Optional. The image for the card.

4033

"imageUri": "A String", # Optional. The public URI to an image file.

4034

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4035

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4036

},

4037

"formattedText": "A String", # Required, unless image is present. The body text of the card.

4038

"buttons": [ # Optional. The collection of card buttons.

4039

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4040

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4044

},

4045

],

4046

"subtitle": "A String", # Optional. The subtitle of the card.

4047

},

4048

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4049

"image": { # The image response message. # Optional. Image which should be displayed on the card.

4050

"imageUri": "A String", # Optional. The public URI to an image file.

4051

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4052

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4053

},

4054

"buttons": [ # Optional. List of buttons for the card.

4055

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4056

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4057

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4058

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4059

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4060

},

4061

],

4062

"title": "A String", # Required. Title of the card.

4063

"rows": [ # Optional. Rows in this table of data.

4064

{ # Row of TableCard.

4065

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

4066

"cells": [ # Optional. List of cells that make up this row.

4067

{ # Cell of TableCardRow.

4068

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4073

"subtitle": "A String", # Optional. Subtitle to the title.

4074

"columnProperties": [ # Optional. Display properties for the columns in this table.

4075

{ # Column properties for TableCard.

4076

"header": "A String", # Required. Column heading.

4077

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

4078

},

4079

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4080

},

4081

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

4082

"items": [ # Required. Carousel items.

4083

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4084

"description": "A String", # Optional. The body text of the card.

4085

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

4086

# dialog.

4087

"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

4092

# response is given.

4093

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4094

"title": "A String", # Required. Title of the carousel item.

4095

"image": { # The image response message. # Optional. The image to display.

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

4104

# or website associated with this agent.

4105

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

4106

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

4107

# suggestion chip.

4108

},

4109

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

4110

# https://developers.google.com/actions/assistant/responses#browsing_carousel

4111

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

4112

# items.

4113

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

4114

# items, maximum of ten.

4115

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4116

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

4117

# text.

4118

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

4119

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

4120

# the URL. Defaults to opening via web browser.

4121

"url": "A String", # Required. URL

4122

},

4123

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

4124

# Card. Maximum of one line of text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4125

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

4126

"image": { # The image response message. # Optional. Hero image for the carousel item.

4127

"imageUri": "A String", # Optional. The public URI to an image file.

4128

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4129

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4130

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

4135

# This message in `QueryResult.fulfillment_messages` and

4136

# `WebhookResponse.fulfillment_messages` should contain only one

4137

# `SimpleResponse`.

4138

"simpleResponses": [ # Required. The list of simple responses.

4139

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4140

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

4141

# response to the user in the SSML format. Mutually exclusive with

4142

# text_to_speech.

4143

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4144

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

4145

# speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

4150

"phoneNumber": "A String", # Required. The phone number to transfer the call to

4151

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

4152

#

4153

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

4154

},

4155

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

4156

"mediaObjects": [ # Required. List of media objects.

4157

{ # Response media object for media content card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4158

"name": "A String", # Required. Name of media card.

4159

"description": "A String", # Optional. Description of media card.

4160

"contentUrl": "A String", # Required. Url where the media is stored.

4161

"icon": { # The image response message. # Optional. Icon to display above media content.

4162

"imageUri": "A String", # Optional. The public URI to an image file.

4163

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4164

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4165

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4166

"largeImage": { # The image response message. # Optional. Image to display above media content.

4167

"imageUri": "A String", # Optional. The public URI to an image file.

4168

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4169

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4170

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4171

},

4172

],

4173

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

4174

},

4175

"image": { # The image response message. # Displays an image.

4176

"imageUri": "A String", # Optional. The public URI to an image file.

4177

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4178

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4179

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4180

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

4181

#

4182

# Rich cards allow you to respond to users with more vivid content, e.g.

4183

# with media and suggestions.

4184

#

4185

# For more details about RBM rich cards, please see:

4186

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

4187

# You can group multiple rich cards into one using RbmCarouselCard but

4188

# carousel cards will give you less control over the card layout.

4189

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

4190

# Image preview alignment for standalone cards with horizontal layout.

4191

"cardOrientation": "A String", # Required. Orientation of the card.

4192

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4193

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4194

# be set. Media (image, GIF or a video) to include in the card.

4195

# 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

4213

# provide a thumbnail URI, the RBM platform displays a blank

4214

# placeholder thumbnail until the user's device downloads the file.

4215

# Depending on the user's setting, the file may not download

4216

# automatically and may require the user to tap a download button.

4217

"height": "A String", # Required for cards with vertical orientation. The height of the media

4218

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

4219

# For a standalone card with horizontal layout, height is not

4220

# customizable, and this field is ignored.

4221

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4222

# determines the MIME type of the file from the content-type field in

4223

# the HTTP headers when the platform fetches the file. The content-type

4224

# field must be present and accurate in the HTTP response from the URL.

4225

},

4226

"suggestions": [ # Optional. List of suggestions to include in the card.

4227

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4228

# easily select/click a predefined response or perform an action (like

4229

# opening a web uri).

4230

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4231

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4232

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4233

# when the user taps the suggested reply. This data will be also

4234

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4235

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4236

},

4237

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4238

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4239

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4240

# but does not dial automatically (https://goo.gl/ergbB2).

4241

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4242

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4243

# format. An example of a correctly formatted phone number:

4244

# +15556767888.

4245

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4246

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4247

# when the user taps the suggested action. This data will be also

4248

# forwarded to webhook to allow performing custom business logic.

4249

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4250

# to send back to the agent (https://goo.gl/GXotJW).

4251

},

4252

"text": "A String", # Text to display alongside the action.

4253

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4254

# (https://goo.gl/6GLJD2). If the user has an app installed that is

4255

# registered as the default handler for the URL, then this app will be

4256

# opened instead, and its icon will be used in the suggested action UI.

4257

"uri": "A String", # Required. The uri to open on the user device

4258

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4263

#

4264

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4265

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4266

#

4267

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4268

},

4269

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4270

"payload": { # A custom platform-specific response.

4271

"a_key": "", # Properties of the object.

4272

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4273

},

4274

],

4275

"action": "A String", # Optional. The name of the action associated with the intent.

4276

# Note: The action name must not contain whitespaces.

4277

"name": "A String", # Optional. The unique identifier of this intent.

4278

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

4279

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4280

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4281

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

4282

"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]

4283

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4284

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4285

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4286

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4287

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

4288

# a direct or indirect parent. We populate this field only in the output.

4289

{ # Represents a single followup intent in the chain.

4290

"followupIntentName": "A String", # The unique identifier of the followup intent.

4291

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4292

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

4293

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4294

},

4295

],

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-27 12:20:54 -0700

[diff] [blame^]

4332

"displayName": "A String", # Required. The name of this intent.

4333

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

4334

# followup intents. It identifies the correct followup intents chain for

4335

# this intent.

4336

#

4337

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4338

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

4339

# Note: If `ml_disabled` setting is set to true, then this intent is not

4340

# taken into account during inference in `ML ONLY` match mode. Also,

4341

# auto-markup in the UI is turned off.

4342

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

4343

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

4344

# Note: If `ml_enabled` setting is set to false, then this intent is not

4345

# taken into account during inference in `ML ONLY` match mode. Also,

4346

# auto-markup in the UI is turned off.

4347

# DEPRECATED! Please use `ml_disabled` field instead.

4348

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

4349

# then the default value is determined as follows:

4350

# - Before April 15th, 2018 the default is:

4351

# ml_enabled = false / ml_disabled = true.

4352

# - After April 15th, 2018 the default is:

4353

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4354

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4355

# trained on.

4356

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4357

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4358

# The parts are concatenated in order to form the training phrase.

4359

#

4360

# Note: The API does not automatically annotate training phrases like the

4361

# Dialogflow Console does.

4362

#

4363

# Note: Do not forget to include whitespace at part boundaries,

4364

# so the training phrase is well formatted when the parts are concatenated.

4365

#

4366

# If the training phrase does not need to be annotated with parameters,

4367

# you just need a single part with only the Part.text field set.

4368

#

4369

# If you want to annotate the training phrase, you must create multiple

4370

# parts, where the fields of each part are populated in one of two ways:

4371

#

4372

# - `Part.text` is set to a part of the phrase that has no parameters.

4373

# - `Part.text` is set to a part of the phrase that you want to annotate,

4374

# and the `entity_type`, `alias`, and `user_defined` fields are all

4375

# set.

4376

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4377

"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]

4378

# annotated part of the example.

4379

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4380

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4381

# This field is set to true when the Dialogflow Console is used to

4382

# manually annotate the part. When creating an annotated part with the

4383

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4384

"text": "A String", # Required. The text for this part.

4385

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

4386

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4387

},

4388

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4389

"name": "A String", # Output only. The unique identifier of this training phrase.

4390

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4391

# the intent. Each time a developer adds an existing sample by editing an

4392

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4393

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4394

},

4395

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4396

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

4397

# session when this intent is matched.

4398

"parameters": [ # Optional. The collection of parameters associated with the intent.

4399

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4400

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

4401

# describes values of the parameter. If the parameter is

4402

# required, this must be provided.

4403

"prompts": [ # Optional. The collection of prompts that the agent can present to the

4404

# user in order to collect a value for the parameter.

4405

"A String",

4406

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4407

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

4408

# whether the intent cannot be completed without collecting the parameter

4409

# value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4410

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

4411

# result.

4412

# Default values can be extracted from contexts by using the following

4413

# syntax: `#context_name.parameter_name`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4414

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

4415

"name": "A String", # The unique identifier of this parameter.

4416

"value": "A String", # Optional. The definition of the parameter value. It can be:

4417

#

4418

# - a constant string,

4419

# - a parameter value defined as `$parameter_name`,

4420

# - an original parameter value defined as `$parameter_name.original`,

4421

# - a parameter value from some context defined as

4422

# `#context_name.parameter_name`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4423

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4424

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4425

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4426

"events": [ # Optional. The collection of event names that trigger the intent.

4427

# If the collection of input contexts is not empty, all of the contexts must

4428

# be present in the active user session for an event to trigger this intent.

4429

# Event names are limited to 150 characters.

4430

"A String",

4431

],

4432

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

4433

# chain of followup intents. You can set this field when creating an intent,

4434

# for example with CreateIntent or

4435

# BatchUpdateIntents, in order to make this

4436

# intent a followup intent.

4437

#

4438

# It identifies the parent followup intent.

4439

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4440

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4441

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4442

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4443

# - If the supplied value is unspecified or 0, the service

4444

# translates the value to 500,000, which corresponds to the

4445

# `Normal` priority in the console.

4446

# - If the supplied value is negative, the intent is ignored

4447

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4448

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

4449

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

4450

# to close interaction with an end user. Default is false.

4451

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

4452

# is matched. Context messages in this collection should not set the

4453

# parameters field. Setting the `lifespan_count` to 0 will reset the context

4454

# when the intent is matched.

4455

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

4456

{ # Represents a context.

4457

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

4458

# context expires. The default is `0`. If set to `0`, the context expires

4459

# immediately. Contexts expire automatically after 20 minutes if there

4460

# are no matching queries.

4461

"name": "A String", # Required. The unique identifier of the context. Format:

4462

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

4463

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

4464

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

4465

#

4466

# The `Context ID` is always converted to lowercase, may only contain

4467

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

4468

#

4469

# If `Environment ID` is not specified, we assume default 'draft'

4470

# environment. If `User ID` is not specified, we assume default '-' user.

4471

#

4472

# The following context names are reserved for internal use by Dialogflow.

4473

# You should not use these contexts or create contexts with these names:

4474

#

4475

# * `__system_counters__`

4476

# * `*_id_dialog_context`

4477

# * `*_dialog_params_size`

4478

"parameters": { # Optional. The collection of parameters associated with this context.

4479

#

4480

# Depending on your protocol or client library language, this is a

4481

# map, associative array, symbol table, dictionary, or JSON object

4482

# composed of a collection of (MapKey, MapValue) pairs:

4483

#

4484

# - MapKey type: string

4485

# - MapKey value: parameter name

4486

# - MapValue type:

4487

# - If parameter's entity type is a composite entity: map

4488

# - Else: string or number, depending on parameter value type

4489

# - MapValue value:

4490

# - If parameter's entity type is a composite entity:

4491

# map from composite entity property names to property values

4492

# - Else: parameter value

4493

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

4498

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

4499

"A String",

4500

],

4501

"messages": [ # Optional. The collection of rich messages corresponding to the

4502

# `Response` field in the Dialogflow console.

4503

{ # Corresponds to the `Response` field in the Dialogflow console.

4504

"text": { # The text response message. # Returns a text response.

4505

"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.

4510

#

4511

# Rich cards allow you to respond to users with more vivid content, e.g.

4512

# with media and suggestions.

4513

#

4514

# For more details about RBM rich cards, please see:

4515

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

4516

# If you want to show a single card with more control over the layout,

4517

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4518

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

4519

# 2 cards and at most 10.

4520

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4521

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4522

# be set. Media (image, GIF or a video) to include in the card.

4523

# 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

4541

# provide a thumbnail URI, the RBM platform displays a blank

4542

# placeholder thumbnail until the user's device downloads the file.

4543

# Depending on the user's setting, the file may not download

4544

# automatically and may require the user to tap a download button.

4545

"height": "A String", # Required for cards with vertical orientation. The height of the media

4546

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

4547

# For a standalone card with horizontal layout, height is not

4548

# customizable, and this field is ignored.

4549

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4550

# determines the MIME type of the file from the content-type field in

4551

# the HTTP headers when the platform fetches the file. The content-type

4552

# field must be present and accurate in the HTTP response from the URL.

4553

},

4554

"suggestions": [ # Optional. List of suggestions to include in the card.

4555

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4556

# easily select/click a predefined response or perform an action (like

4557

# opening a web uri).

4558

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4559

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4560

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4561

# when the user taps the suggested reply. This data will be also

4562

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4563

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4564

},

4565

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4566

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4567

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4568

# but does not dial automatically (https://goo.gl/ergbB2).

4569

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4570

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4571

# format. An example of a correctly formatted phone number:

4572

# +15556767888.

4573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4574

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4575

# when the user taps the suggested action. This data will be also

4576

# forwarded to webhook to allow performing custom business logic.

4577

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4578

# to send back to the agent (https://goo.gl/GXotJW).

4579

},

4580

"text": "A String", # Text to display alongside the action.

4581

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4582

# (https://goo.gl/6GLJD2). If the user has an app installed that is

4583

# registered as the default handler for the URL, then this app will be

4584

# opened instead, and its icon will be used in the suggested action UI.

4585

"uri": "A String", # Required. The uri to open on the user device

4586

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4591

#

4592

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4593

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4594

#

4595

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4596

},

4597

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4598

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4599

},

4600

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

4601

"suggestions": [ # Required. The list of suggested replies.

4602

{ # The suggestion chip message that the user can tap to quickly post a reply

4603

# to the conversation.

4604

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

4609

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

4610

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

4611

# play, e.g., "gs://bucket/object". The object must contain a single

4612

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

4613

#

4614

# This object must be readable by the `service-<Project

4615

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

4616

# where <Project Number> is the number of the Telephony Gateway project

4617

# (usually the same as the Dialogflow agent project). If the Google Cloud

4618

# Storage bucket is in the Telephony Gateway project, this permission is

4619

# added by default when enabling the Dialogflow V2 API.

4620

#

4621

# For audio from other sources, consider using the

4622

# `TelephonySynthesizeSpeech` message with SSML.

4623

},

4624

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

4625

"title": "A String", # Optional. The overall title of the list.

4626

"subtitle": "A String", # Optional. Subtitle of the list.

4627

"items": [ # Required. List items.

4628

{ # An item in the list.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4629

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4630

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

4631

# dialog.

4632

"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

4637

# response is given.

4638

},

4639

"title": "A String", # Required. The title of the list item.

4640

"image": { # The image response message. # Optional. The image to display.

4641

"imageUri": "A String", # Optional. The public URI to an image file.

4642

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4643

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4644

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

4649

#

4650

# RBM allows businesses to send enriched and branded versions of SMS. See

4651

# https://jibe.google.com/business-messaging.

4652

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

4653

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4654

# easily select/click a predefined response or perform an action (like

4655

# opening a web uri).

4656

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4657

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4658

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4659

# when the user taps the suggested reply. This data will be also

4660

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4661

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4662

},

4663

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4664

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4665

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4666

# but does not dial automatically (https://goo.gl/ergbB2).

4667

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4668

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4669

# format. An example of a correctly formatted phone number:

4670

# +15556767888.

4671

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4672

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4673

# when the user taps the suggested action. This data will be also

4674

# forwarded to webhook to allow performing custom business logic.

4675

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4676

# to send back to the agent (https://goo.gl/GXotJW).

4677

},

4678

"text": "A String", # Text to display alongside the action.

4679

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4680

# (https://goo.gl/6GLJD2). If the user has an app installed that is

4681

# registered as the default handler for the URL, then this app will be

4682

# opened instead, and its icon will be used in the suggested action UI.

4683

"uri": "A String", # Required. The uri to open on the user device

4684

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

4689

},

4690

"quickReplies": { # The quick replies response message. # Displays quick replies.

4691

"title": "A String", # Optional. The title of the collection of quick replies.

4692

"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.

4697

# Telephony Gateway.

4698

#

4699

# Telephony Gateway takes the synthesizer settings from

4700

# `DetectIntentResponse.output_audio_config` which can either be set

4701

# at request-level or can come from the agent-level synthesizer config.

4702

"text": "A String", # The raw text to be synthesized.

4703

"ssml": "A String", # The SSML to be synthesized. For more information, see

4704

# [SSML](https://developers.google.com/actions/reference/ssml).

4705

},

4706

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4707

"title": "A String", # Optional. The title of the card.

4708

"buttons": [ # Optional. The collection of card buttons.

4709

{ # Optional. Contains information about a button.

4710

"text": "A String", # Optional. The text to show on the button.

4711

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4716

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4717

},

4718

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

4719

"title": "A String", # Optional. The title of the card.

4720

"image": { # The image response message. # Optional. The image for the card.

4721

"imageUri": "A String", # Optional. The public URI to an image file.

4722

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4723

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4724

},

4725

"formattedText": "A String", # Required, unless image is present. The body text of the card.

4726

"buttons": [ # Optional. The collection of card buttons.

4727

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4728

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4732

},

4733

],

4734

"subtitle": "A String", # Optional. The subtitle of the card.

4735

},

4736

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4737

"image": { # The image response message. # Optional. Image which should be displayed on the card.

4738

"imageUri": "A String", # Optional. The public URI to an image file.

4739

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4740

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4741

},

4742

"buttons": [ # Optional. List of buttons for the card.

4743

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4744

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4745

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4746

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4747

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4748

},

4749

],

4750

"title": "A String", # Required. Title of the card.

4751

"rows": [ # Optional. Rows in this table of data.

4752

{ # Row of TableCard.

4753

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

4754

"cells": [ # Optional. List of cells that make up this row.

4755

{ # Cell of TableCardRow.

4756

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4761

"subtitle": "A String", # Optional. Subtitle to the title.

4762

"columnProperties": [ # Optional. Display properties for the columns in this table.

4763

{ # Column properties for TableCard.

4764

"header": "A String", # Required. Column heading.

4765

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

4766

},

4767

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4768

},

4769

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

4770

"items": [ # Required. Carousel items.

4771

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4772

"description": "A String", # Optional. The body text of the card.

4773

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

4774

# dialog.

4775

"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

4780

# response is given.

4781

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4782

"title": "A String", # Required. Title of the carousel item.

4783

"image": { # The image response message. # Optional. The image to display.

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

4792

# or website associated with this agent.

4793

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

4794

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

4795

# suggestion chip.

4796

},

4797

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

4798

# https://developers.google.com/actions/assistant/responses#browsing_carousel

4799

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

4800

# items.

4801

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

4802

# items, maximum of ten.

4803

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4804

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

4805

# text.

4806

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

4807

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

4808

# the URL. Defaults to opening via web browser.

4809

"url": "A String", # Required. URL

4810

},

4811

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

4812

# Card. Maximum of one line of text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4813

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

4814

"image": { # The image response message. # Optional. Hero image for the carousel item.

4815

"imageUri": "A String", # Optional. The public URI to an image file.

4816

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4817

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4818

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

4823

# This message in `QueryResult.fulfillment_messages` and

4824

# `WebhookResponse.fulfillment_messages` should contain only one

4825

# `SimpleResponse`.

4826

"simpleResponses": [ # Required. The list of simple responses.

4827

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4828

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

4829

# response to the user in the SSML format. Mutually exclusive with

4830

# text_to_speech.

4831

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4832

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

4833

# speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

4838

"phoneNumber": "A String", # Required. The phone number to transfer the call to

4839

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

4840

#

4841

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

4842

},

4843

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

4844

"mediaObjects": [ # Required. List of media objects.

4845

{ # Response media object for media content card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4846

"name": "A String", # Required. Name of media card.

4847

"description": "A String", # Optional. Description of media card.

4848

"contentUrl": "A String", # Required. Url where the media is stored.

4849

"icon": { # The image response message. # Optional. Icon to display above media content.

4850

"imageUri": "A String", # Optional. The public URI to an image file.

4851

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4852

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4853

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4854

"largeImage": { # The image response message. # Optional. Image to display above media content.

4855

"imageUri": "A String", # Optional. The public URI to an image file.

4856

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4857

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4858

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4859

},

4860

],

4861

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

4862

},

4863

"image": { # The image response message. # Displays an image.

4864

"imageUri": "A String", # Optional. The public URI to an image file.

4865

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4866

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4867

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4868

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

4869

#

4870

# Rich cards allow you to respond to users with more vivid content, e.g.

4871

# with media and suggestions.

4872

#

4873

# For more details about RBM rich cards, please see:

4874

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

4875

# You can group multiple rich cards into one using RbmCarouselCard but

4876

# carousel cards will give you less control over the card layout.

4877

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

4878

# Image preview alignment for standalone cards with horizontal layout.

4879

"cardOrientation": "A String", # Required. Orientation of the card.

4880

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4881

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4882

# be set. Media (image, GIF or a video) to include in the card.

4883

# 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

4901

# provide a thumbnail URI, the RBM platform displays a blank

4902

# placeholder thumbnail until the user's device downloads the file.

4903

# Depending on the user's setting, the file may not download

4904

# automatically and may require the user to tap a download button.

4905

"height": "A String", # Required for cards with vertical orientation. The height of the media

4906

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

4907

# For a standalone card with horizontal layout, height is not

4908

# customizable, and this field is ignored.

4909

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4910

# determines the MIME type of the file from the content-type field in

4911

# the HTTP headers when the platform fetches the file. The content-type

4912

# field must be present and accurate in the HTTP response from the URL.

4913

},

4914

"suggestions": [ # Optional. List of suggestions to include in the card.

4915

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4916

# easily select/click a predefined response or perform an action (like

4917

# opening a web uri).

4918

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4919

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4920

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4921

# when the user taps the suggested reply. This data will be also

4922

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4923

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4924

},

4925

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4926

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4927

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4928

# but does not dial automatically (https://goo.gl/ergbB2).

4929

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4930

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4931

# format. An example of a correctly formatted phone number:

4932

# +15556767888.

4933

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4934

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4935

# when the user taps the suggested action. This data will be also

4936

# forwarded to webhook to allow performing custom business logic.

4937

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4938

# to send back to the agent (https://goo.gl/GXotJW).

4939

},

4940

"text": "A String", # Text to display alongside the action.

4941

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4942

# (https://goo.gl/6GLJD2). If the user has an app installed that is

4943

# registered as the default handler for the URL, then this app will be

4944

# opened instead, and its icon will be used in the suggested action UI.

4945

"uri": "A String", # Required. The uri to open on the user device

4946

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4951

#

4952

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4953

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4954

#

4955

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4956

},

4957

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4958

"payload": { # A custom platform-specific response.

4959

"a_key": "", # Properties of the object.

4960

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4961

},

4962

],

4963

"action": "A String", # Optional. The name of the action associated with the intent.

4964

# Note: The action name must not contain whitespaces.

4965

"name": "A String", # Optional. The unique identifier of this intent.

4966

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

4967

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4968

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4969

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

4970

"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]

4971

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4972

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4973

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4974

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4975

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

4976

# a direct or indirect parent. We populate this field only in the output.

4977

{ # Represents a single followup intent in the chain.

4978

"followupIntentName": "A String", # The unique identifier of the followup intent.

4979

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4980

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

4981

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4982

},

4983

],

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-27 12:20:54 -0700

[diff] [blame^]

5004

"displayName": "A String", # Required. The name of this intent.

5005

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

5006

# followup intents. It identifies the correct followup intents chain for

5007

# this intent.

5008

#

5009

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5010

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

5011

# Note: If `ml_disabled` setting is set to true, then this intent is not

5012

# taken into account during inference in `ML ONLY` match mode. Also,

5013

# auto-markup in the UI is turned off.

5014

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

5015

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

5016

# Note: If `ml_enabled` setting is set to false, then this intent is not

5017

# taken into account during inference in `ML ONLY` match mode. Also,

5018

# auto-markup in the UI is turned off.

5019

# DEPRECATED! Please use `ml_disabled` field instead.

5020

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

5021

# then the default value is determined as follows:

5022

# - Before April 15th, 2018 the default is:

5023

# ml_enabled = false / ml_disabled = true.

5024

# - After April 15th, 2018 the default is:

5025

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5026

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5027

# trained on.

5028

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5029

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5030

# The parts are concatenated in order to form the training phrase.

5031

#

5032

# Note: The API does not automatically annotate training phrases like the

5033

# Dialogflow Console does.

5034

#

5035

# Note: Do not forget to include whitespace at part boundaries,

5036

# so the training phrase is well formatted when the parts are concatenated.

5037

#

5038

# If the training phrase does not need to be annotated with parameters,

5039

# you just need a single part with only the Part.text field set.

5040

#

5041

# If you want to annotate the training phrase, you must create multiple

5042

# parts, where the fields of each part are populated in one of two ways:

5043

#

5044

# - `Part.text` is set to a part of the phrase that has no parameters.

5045

# - `Part.text` is set to a part of the phrase that you want to annotate,

5046

# and the `entity_type`, `alias`, and `user_defined` fields are all

5047

# set.

5048

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5049

"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]

5050

# annotated part of the example.

5051

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5052

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5053

# This field is set to true when the Dialogflow Console is used to

5054

# manually annotate the part. When creating an annotated part with the

5055

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5056

"text": "A String", # Required. The text for this part.

5057

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

5058

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5059

},

5060

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5061

"name": "A String", # Output only. The unique identifier of this training phrase.

5062

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5063

# the intent. Each time a developer adds an existing sample by editing an

5064

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5065

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5066

},

5067

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5068

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

5069

# session when this intent is matched.

5070

"parameters": [ # Optional. The collection of parameters associated with the intent.

5071

{ # Represents intent parameters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5072

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

5073

# describes values of the parameter. If the parameter is

5074

# required, this must be provided.

5075

"prompts": [ # Optional. The collection of prompts that the agent can present to the

5076

# user in order to collect a value for the parameter.

5077

"A String",

5078

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5079

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

5080

# whether the intent cannot be completed without collecting the parameter

5081

# value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5082

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

5083

# result.

5084

# Default values can be extracted from contexts by using the following

5085

# syntax: `#context_name.parameter_name`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5086

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

5087

"name": "A String", # The unique identifier of this parameter.

5088

"value": "A String", # Optional. The definition of the parameter value. It can be:

5089

#

5090

# - a constant string,

5091

# - a parameter value defined as `$parameter_name`,

5092

# - an original parameter value defined as `$parameter_name.original`,

5093

# - a parameter value from some context defined as

5094

# `#context_name.parameter_name`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5095

"displayName": "A String", # Required. The name of the parameter.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5096

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5097

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5098

"events": [ # Optional. The collection of event names that trigger the intent.

5099

# If the collection of input contexts is not empty, all of the contexts must

5100

# be present in the active user session for an event to trigger this intent.

5101

# Event names are limited to 150 characters.

5102

"A String",

5103

],

5104

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

5105

# chain of followup intents. You can set this field when creating an intent,

5106

# for example with CreateIntent or

5107

# BatchUpdateIntents, in order to make this

5108

# intent a followup intent.

5109

#

5110

# It identifies the parent followup intent.

5111

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5112

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5113

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5114

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5115

# - If the supplied value is unspecified or 0, the service

5116

# translates the value to 500,000, which corresponds to the

5117

# `Normal` priority in the console.

5118

# - If the supplied value is negative, the intent is ignored

5119

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5120

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

5121

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

5122

# to close interaction with an end user. Default is false.

5123

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

5124

# is matched. Context messages in this collection should not set the

5125

# parameters field. Setting the `lifespan_count` to 0 will reset the context

5126

# when the intent is matched.

5127

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

5128

{ # Represents a context.

5129

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

5130

# context expires. The default is `0`. If set to `0`, the context expires

5131

# immediately. Contexts expire automatically after 20 minutes if there

5132

# are no matching queries.

5133

"name": "A String", # Required. The unique identifier of the context. Format:

5134

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

5135

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

5136

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

5137

#

5138

# The `Context ID` is always converted to lowercase, may only contain

5139

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

5140

#

5141

# If `Environment ID` is not specified, we assume default 'draft'

5142

# environment. If `User ID` is not specified, we assume default '-' user.

5143

#

5144

# The following context names are reserved for internal use by Dialogflow.

5145

# You should not use these contexts or create contexts with these names:

5146

#

5147

# * `__system_counters__`

5148

# * `*_id_dialog_context`

5149

# * `*_dialog_params_size`

5150

"parameters": { # Optional. The collection of parameters associated with this context.

5151

#

5152

# Depending on your protocol or client library language, this is a

5153

# map, associative array, symbol table, dictionary, or JSON object

5154

# composed of a collection of (MapKey, MapValue) pairs:

5155

#

5156

# - MapKey type: string

5157

# - MapKey value: parameter name

5158

# - MapValue type:

5159

# - If parameter's entity type is a composite entity: map

5160

# - Else: string or number, depending on parameter value type

5161

# - MapValue value:

5162

# - If parameter's entity type is a composite entity:

5163

# map from composite entity property names to property values

5164

# - Else: parameter value

5165

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

5170

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

5171

"A String",

5172

],

5173

"messages": [ # Optional. The collection of rich messages corresponding to the

5174

# `Response` field in the Dialogflow console.

5175

{ # Corresponds to the `Response` field in the Dialogflow console.

5176

"text": { # The text response message. # Returns a text response.

5177

"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.

5182

#

5183

# Rich cards allow you to respond to users with more vivid content, e.g.

5184

# with media and suggestions.

5185

#

5186

# For more details about RBM rich cards, please see:

5187

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

5188

# If you want to show a single card with more control over the layout,

5189

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5190

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

5191

# 2 cards and at most 10.

5192

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5193

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

5194

# be set. Media (image, GIF or a video) to include in the card.

5195

# 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

5213

# provide a thumbnail URI, the RBM platform displays a blank

5214

# placeholder thumbnail until the user's device downloads the file.

5215

# Depending on the user's setting, the file may not download

5216

# automatically and may require the user to tap a download button.

5217

"height": "A String", # Required for cards with vertical orientation. The height of the media

5218

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

5219

# For a standalone card with horizontal layout, height is not

5220

# customizable, and this field is ignored.

5221

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

5222

# determines the MIME type of the file from the content-type field in

5223

# the HTTP headers when the platform fetches the file. The content-type

5224

# field must be present and accurate in the HTTP response from the URL.

5225

},

5226

"suggestions": [ # Optional. List of suggestions to include in the card.

5227

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5228

# easily select/click a predefined response or perform an action (like

5229

# opening a web uri).

5230

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5231

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5232

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5233

# when the user taps the suggested reply. This data will be also

5234

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5235

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5236

},

5237

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5238

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5239

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

5240

# but does not dial automatically (https://goo.gl/ergbB2).

5241

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5242

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5243

# format. An example of a correctly formatted phone number:

5244

# +15556767888.

5245

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5246

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5247

# when the user taps the suggested action. This data will be also

5248

# forwarded to webhook to allow performing custom business logic.

5249

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5250

# to send back to the agent (https://goo.gl/GXotJW).

5251

},

5252

"text": "A String", # Text to display alongside the action.

5253

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5254

# (https://goo.gl/6GLJD2). If the user has an app installed that is

5255

# registered as the default handler for the URL, then this app will be

5256

# opened instead, and its icon will be used in the suggested action UI.

5257

"uri": "A String", # Required. The uri to open on the user device

5258

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

5263

#

5264

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5265

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

5266

#

5267

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5268

},

5269

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5270

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5271

},

5272

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

5273

"suggestions": [ # Required. The list of suggested replies.

5274

{ # The suggestion chip message that the user can tap to quickly post a reply

5275

# to the conversation.

5276

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

5281

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

5282

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

5283

# play, e.g., "gs://bucket/object". The object must contain a single

5284

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

5285

#

5286

# This object must be readable by the `service-<Project

5287

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

5288

# where <Project Number> is the number of the Telephony Gateway project

5289

# (usually the same as the Dialogflow agent project). If the Google Cloud

5290

# Storage bucket is in the Telephony Gateway project, this permission is

5291

# added by default when enabling the Dialogflow V2 API.

5292

#

5293

# For audio from other sources, consider using the

5294

# `TelephonySynthesizeSpeech` message with SSML.

5295

},

5296

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

5297

"title": "A String", # Optional. The overall title of the list.

5298

"subtitle": "A String", # Optional. Subtitle of the list.

5299

"items": [ # Required. List items.

5300

{ # An item in the list.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5301

"description": "A String", # Optional. The main text describing the item.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5302

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

5303

# dialog.

5304

"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

5309

# response is given.

5310

},

5311

"title": "A String", # Required. The title of the list item.

5312

"image": { # The image response message. # Optional. The image to display.

5313

"imageUri": "A String", # Optional. The public URI to an image file.

5314

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5315

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5316

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

5321

#

5322

# RBM allows businesses to send enriched and branded versions of SMS. See

5323

# https://jibe.google.com/business-messaging.

5324

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

5325

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5326

# easily select/click a predefined response or perform an action (like

5327

# opening a web uri).

5328

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5329

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5330

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5331

# when the user taps the suggested reply. This data will be also

5332

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5333

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5334

},

5335

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5336

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5337

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

5338

# but does not dial automatically (https://goo.gl/ergbB2).

5339

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5340

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5341

# format. An example of a correctly formatted phone number:

5342

# +15556767888.

5343

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5344

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5345

# when the user taps the suggested action. This data will be also

5346

# forwarded to webhook to allow performing custom business logic.

5347

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5348

# to send back to the agent (https://goo.gl/GXotJW).

5349

},

5350

"text": "A String", # Text to display alongside the action.

5351

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5352

# (https://goo.gl/6GLJD2). If the user has an app installed that is

5353

# registered as the default handler for the URL, then this app will be

5354

# opened instead, and its icon will be used in the suggested action UI.

5355

"uri": "A String", # Required. The uri to open on the user device

5356

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

5361

},

5362

"quickReplies": { # The quick replies response message. # Displays quick replies.

5363

"title": "A String", # Optional. The title of the collection of quick replies.

5364

"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.

5369

# Telephony Gateway.

5370

#

5371

# Telephony Gateway takes the synthesizer settings from

5372

# `DetectIntentResponse.output_audio_config` which can either be set

5373

# at request-level or can come from the agent-level synthesizer config.

5374

"text": "A String", # The raw text to be synthesized.

5375

"ssml": "A String", # The SSML to be synthesized. For more information, see

5376

# [SSML](https://developers.google.com/actions/reference/ssml).

5377

},

5378

"card": { # The card response message. # Displays a card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5379

"title": "A String", # Optional. The title of the card.

5380

"buttons": [ # Optional. The collection of card buttons.

5381

{ # Optional. Contains information about a button.

5382

"text": "A String", # Optional. The text to show on the button.

5383

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5388

"imageUri": "A String", # Optional. The public URI to an image file for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5389

},

5390

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

5391

"title": "A String", # Optional. The title of the card.

5392

"image": { # The image response message. # Optional. The image for the card.

5393

"imageUri": "A String", # Optional. The public URI to an image file.

5394

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5395

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5396

},

5397

"formattedText": "A String", # Required, unless image is present. The body text of the card.

5398

"buttons": [ # Optional. The collection of card buttons.

5399

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5400

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5404

},

5405

],

5406

"subtitle": "A String", # Optional. The subtitle of the card.

5407

},

5408

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5409

"image": { # The image response message. # Optional. Image which should be displayed on the card.

5410

"imageUri": "A String", # Optional. The public URI to an image file.

5411

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5412

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5413

},

5414

"buttons": [ # Optional. List of buttons for the card.

5415

{ # The button object that appears at the bottom of a card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5416

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5417

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

5418

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

5419

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5420

},

5421

],

5422

"title": "A String", # Required. Title of the card.

5423

"rows": [ # Optional. Rows in this table of data.

5424

{ # Row of TableCard.

5425

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

5426

"cells": [ # Optional. List of cells that make up this row.

5427

{ # Cell of TableCardRow.

5428

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5433

"subtitle": "A String", # Optional. Subtitle to the title.

5434

"columnProperties": [ # Optional. Display properties for the columns in this table.

5435

{ # Column properties for TableCard.

5436

"header": "A String", # Required. Column heading.

5437

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

5438

},

5439

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5440

},

5441

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

5442

"items": [ # Required. Carousel items.

5443

{ # An item in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5444

"description": "A String", # Optional. The body text of the card.

5445

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

5446

# dialog.

5447

"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

5452

# response is given.

5453

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5454

"title": "A String", # Required. Title of the carousel item.

5455

"image": { # The image response message. # Optional. The image to display.

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

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

5464

# or website associated with this agent.

5465

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

5466

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

5467

# suggestion chip.

5468

},

5469

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

5470

# https://developers.google.com/actions/assistant/responses#browsing_carousel

5471

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

5472

# items.

5473

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

5474

# items, maximum of ten.

5475

{ # Browsing carousel tile

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5476

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

5477

# text.

5478

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

5479

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

5480

# the URL. Defaults to opening via web browser.

5481

"url": "A String", # Required. URL

5482

},

5483

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

5484

# Card. Maximum of one line of text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5485

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

5486

"image": { # The image response message. # Optional. Hero image for the carousel item.

5487

"imageUri": "A String", # Optional. The public URI to an image file.

5488

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5489

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5490

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

5495

# This message in `QueryResult.fulfillment_messages` and

5496

# `WebhookResponse.fulfillment_messages` should contain only one

5497

# `SimpleResponse`.

5498

"simpleResponses": [ # Required. The list of simple responses.

5499

{ # The simple response message containing speech or text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5500

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

5501

# response to the user in the SSML format. Mutually exclusive with

5502

# text_to_speech.

5503

"displayText": "A String", # Optional. The text to display.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5504

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

5505

# speech output. Mutually exclusive with ssml.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

5510

"phoneNumber": "A String", # Required. The phone number to transfer the call to

5511

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

5512

#

5513

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

5514

},

5515

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

5516

"mediaObjects": [ # Required. List of media objects.

5517

{ # Response media object for media content card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5518

"name": "A String", # Required. Name of media card.

5519

"description": "A String", # Optional. Description of media card.

5520

"contentUrl": "A String", # Required. Url where the media is stored.

5521

"icon": { # The image response message. # Optional. Icon to display above media content.

5522

"imageUri": "A String", # Optional. The public URI to an image file.

5523

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5524

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5525

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5526

"largeImage": { # The image response message. # Optional. Image to display above media content.

5527

"imageUri": "A String", # Optional. The public URI to an image file.

5528

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5529

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5530

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5531

},

5532

],

5533

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

5534

},

5535

"image": { # The image response message. # Displays an image.

5536

"imageUri": "A String", # Optional. The public URI to an image file.

5537

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5538

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5539

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5540

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

5541

#

5542

# Rich cards allow you to respond to users with more vivid content, e.g.

5543

# with media and suggestions.

5544

#

5545

# For more details about RBM rich cards, please see:

5546

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

5547

# You can group multiple rich cards into one using RbmCarouselCard but

5548

# carousel cards will give you less control over the card layout.

5549

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

5550

# Image preview alignment for standalone cards with horizontal layout.

5551

"cardOrientation": "A String", # Required. Orientation of the card.

5552

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5553

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

5554

# be set. Media (image, GIF or a video) to include in the card.

5555

# 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

5573

# provide a thumbnail URI, the RBM platform displays a blank

5574

# placeholder thumbnail until the user's device downloads the file.

5575

# Depending on the user's setting, the file may not download

5576

# automatically and may require the user to tap a download button.

5577

"height": "A String", # Required for cards with vertical orientation. The height of the media

5578

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

5579

# For a standalone card with horizontal layout, height is not

5580

# customizable, and this field is ignored.

5581

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

5582

# determines the MIME type of the file from the content-type field in

5583

# the HTTP headers when the platform fetches the file. The content-type

5584

# field must be present and accurate in the HTTP response from the URL.

5585

},

5586

"suggestions": [ # Optional. List of suggestions to include in the card.

5587

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5588

# easily select/click a predefined response or perform an action (like

5589

# opening a web uri).

5590

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5591

# instead of typing in their own response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5592

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5593

# when the user taps the suggested reply. This data will be also

5594

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5595

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5596

},

5597

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5598

# can choose from the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5599

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

5600

# but does not dial automatically (https://goo.gl/ergbB2).

5601

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5602

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5603

# format. An example of a correctly formatted phone number:

5604

# +15556767888.

5605

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5606

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5607

# when the user taps the suggested action. This data will be also

5608

# forwarded to webhook to allow performing custom business logic.

5609

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5610

# to send back to the agent (https://goo.gl/GXotJW).

5611

},

5612

"text": "A String", # Text to display alongside the action.

5613

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5614

# (https://goo.gl/6GLJD2). If the user has an app installed that is

5615

# registered as the default handler for the URL, then this app will be

5616

# opened instead, and its icon will be used in the suggested action UI.

5617

"uri": "A String", # Required. The uri to open on the user device

5618

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

5623

#

5624

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5625

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

5626

#

5627

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5628

},

5629

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

5630

"payload": { # A custom platform-specific response.

5631

"a_key": "", # Properties of the object.

5632

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5633

},

5634

],

5635

"action": "A String", # Optional. The name of the action associated with the intent.

5636

# Note: The action name must not contain whitespaces.

5637

"name": "A String", # Optional. The unique identifier of this intent.

5638

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

5639

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5640

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5641

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

5642

"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]

5643

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5644

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5645

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5646

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5647

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

5648

# a direct or indirect parent. We populate this field only in the output.

5649

{ # Represents a single followup intent in the chain.

5650

"followupIntentName": "A String", # The unique identifier of the followup intent.

5651

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5652

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

5653

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5654

},

5655

],

Bu Sun Kim