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-07-22 17:02:09 -0700

[diff] [blame^]

90

<code><a href="#get">get(name, languageCode=None, intentView=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-07-22 17:02:09 -0700

[diff] [blame^]

93

<code><a href="#list">list(parent, pageToken=None, languageCode=None, intentView=None, pageSize=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-07-22 17:02:09 -0700

[diff] [blame^]

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

101

<h3>Method Details</h3>

102

Dan O'Meara

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

[diff] [blame]

103

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

Bu Sun Kim

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

[diff] [blame]

104

<pre>Deletes intents in the specified agent.

105

Dan O'Meara

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

[diff] [blame]

106

Operation <response: google.protobuf.Empty>

Bu Sun Kim

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

[diff] [blame]

107

108

Args:

109

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

Dan O'Meara

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

[diff] [blame]

110

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

111

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

112

The object takes the form of:

113

114

{ # The request message for Intents.BatchDeleteIntents.

Bu Sun Kim

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

[diff] [blame]

115

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

Bu Sun Kim

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

[diff] [blame]

116

# filled in.

Bu Sun Kim

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

[diff] [blame^]

117

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

118

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

119

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

120

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

121

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

122

# intent classification.

123

#

124

# For more information, see the [intent

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

127

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

128

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

Bu Sun Kim

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

[diff] [blame^]

129

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

130

# Note: The action name must not contain whitespaces.

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

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

135

# when the intent is matched.

136

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

Bu Sun Kim

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

[diff] [blame^]

137

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

138

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

139

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

140

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

141

# an intent.

142

#

143

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

144

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

145

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

146

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

147

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

148

# contexts that correspond to the currently active contexts.

149

#

150

# For more information about context, see the

151

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

152

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

153

#

154

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

155

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

156

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

157

#

158

# - MapKey type: string

159

# - MapKey value: parameter name

160

# - MapValue type:

161

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

162

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

163

# - MapValue value:

164

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

165

# map from composite entity property names to property values

166

# - Else: parameter value

167

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

168

},

Bu Sun Kim

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

[diff] [blame]

169

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

170

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

171

# immediately. Contexts expire automatically after 20 minutes if there

172

# are no matching queries.

173

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

174

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

175

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

176

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

177

#

178

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

179

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

180

#

181

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

182

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

183

#

184

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

185

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

186

#

187

# * `__system_counters__`

188

# * `*_id_dialog_context`

189

# * `*_dialog_params_size`

Bu Sun Kim

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

[diff] [blame]

190

},

191

],

Bu Sun Kim

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

[diff] [blame^]

192

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

193

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

194

# session when this intent is matched.

195

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

196

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

197

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

198

# auto-markup in the UI is turned off.

199

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

200

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

201

# this intent.

202

#

203

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

204

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

205

# trained on.

206

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

207

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

208

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

209

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

210

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

211

#

212

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

213

# Dialogflow Console does.

214

#

215

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

216

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

217

#

218

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

219

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

220

#

221

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

222

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

223

#

224

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

225

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

226

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

227

# set.

228

{ # Represents a part of a training phrase.

229

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

230

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

231

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

232

# API, you must set this to true.

233

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

234

# annotated part of the example.

235

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

236

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

237

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

238

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

239

},

240

],

241

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

242

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

243

# intent or training, this counter is increased.

244

},

Bu Sun Kim

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

[diff] [blame]

245

],

246

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

247

# `Response` field in the Dialogflow console.

248

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

Bu Sun Kim

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

[diff] [blame^]

249

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

250

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

251

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

252

# to the conversation.

253

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

},

],

},

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

258

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

259

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

260

{ # Response media object for media content card.

261

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

262

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

263

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

264

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

265

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

266

},

267

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

268

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

269

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

270

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

271

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

272

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

},

},

],

},

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

278

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

279

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

280

#

281

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

282

},

283

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

284

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

285

# Telephony Gateway.

286

#

287

# Telephony Gateway takes the synthesizer settings from

288

# `DetectIntentResponse.output_audio_config` which can either be set

289

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

290

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

291

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

292

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

293

},

294

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

295

# or website associated with this agent.

296

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

297

# suggestion chip.

298

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

299

},

300

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

301

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

Bu Sun Kim

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

[diff] [blame]

302

"A String",

303

],

Bu Sun Kim

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

[diff] [blame^]

304

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

305

},

306

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

307

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

308

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

309

{ # Optional. Contains information about a button.

310

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

311

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

# open.

},

],

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

316

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

317

},

318

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

319

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

320

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

321

"items": [ # Required. List items.

322

{ # An item in the list.

323

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

324

# dialog.

325

"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

330

# response is given.

331

},

332

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

333

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

334

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

335

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

336

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

337

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

},

},

],

},

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

343

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

344

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

345

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

346

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

347

},

348

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

349

},

350

],

351

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

352

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

353

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

354

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

355

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

356

},

357

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

358

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

359

},

360

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

361

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

362

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

363

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

Bu Sun Kim

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

[diff] [blame]

364

},

365

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

366

#

367

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

368

# with media and suggestions.

369

#

Bu Sun Kim

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

[diff] [blame]

370

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

371

# please use RbmStandaloneCard instead.

Bu Sun Kim

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

[diff] [blame^]

372

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

Bu Sun Kim

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

[diff] [blame]

373

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

374

# 2 cards and at most 10.

375

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

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

[diff] [blame]

376

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

377

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

378

# 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

Bu Sun Kim

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

[diff] [blame]

395

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

Bu Sun Kim

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

[diff] [blame^]

396

# within a rich card with a vertical layout.

Bu Sun Kim

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

[diff] [blame]

397

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

398

# customizable, and this field is ignored.

399

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

400

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

401

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

402

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

Bu Sun Kim

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

[diff] [blame^]

403

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

404

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

405

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

406

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

407

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

Bu Sun Kim

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

[diff] [blame]

408

},

Bu Sun Kim

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

[diff] [blame^]

409

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

410

#

411

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

412

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

413

#

414

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

Bu Sun Kim

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

[diff] [blame]

415

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

416

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

417

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

418

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

419

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

420

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

421

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

422

# If the user has an app installed that is

423

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

424

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

425

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

426

},

427

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

428

# to send back to the agent.

429

},

430

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

Bu Sun Kim

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

[diff] [blame]

431

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

Bu Sun Kim

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

[diff] [blame^]

432

# but does not dial automatically.

Bu Sun Kim

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

[diff] [blame]

433

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

434

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

435

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

436

# +15556767888.

437

},

Bu Sun Kim

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

[diff] [blame]

438

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

439

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

440

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame^]

441

},

442

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

443

# instead of typing in their own response.

444

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

445

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

446

# forwarded to webhook to allow performing custom business logic.

447

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

Bu Sun Kim

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

[diff] [blame]

448

},

449

},

450

],

Bu Sun Kim

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

[diff] [blame]

451

},

452

],

453

},

Bu Sun Kim

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

[diff] [blame^]

454

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

455

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

Bu Sun Kim

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

[diff] [blame]

456

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

457

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

458

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

459

},

Bu Sun Kim

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

[diff] [blame^]

460

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

Bu Sun Kim

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

[diff] [blame]

461

},

462

],

Bu Sun Kim

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

[diff] [blame^]

463

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

Bu Sun Kim

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

[diff] [blame]

464

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

465

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

466

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

467

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

468

},

Bu Sun Kim

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

[diff] [blame]

469

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

470

{ # Row of TableCard.

471

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

472

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

473

{ # Cell of TableCardRow.

474

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame^]

479

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

Bu Sun Kim

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

[diff] [blame]

480

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

481

{ # Column properties for TableCard.

482

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

483

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

484

},

485

],

Bu Sun Kim

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

[diff] [blame]

486

},

Bu Sun Kim

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

[diff] [blame^]

487

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

488

#

489

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

490

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

491

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

492

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

493

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

494

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

495

# opening a web uri).

496

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

497

# can choose from the card.

498

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

499

# If the user has an app installed that is

500

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

501

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

502

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

503

},

504

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

505

# to send back to the agent.

506

},

507

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

508

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

509

# but does not dial automatically.

510

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

511

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

512

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

513

# +15556767888.

514

},

515

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

516

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

517

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame]

518

},

Bu Sun Kim

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

[diff] [blame^]

519

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

520

# instead of typing in their own response.

521

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

522

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

523

# forwarded to webhook to allow performing custom business logic.

524

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

Bu Sun Kim

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

[diff] [blame]

525

},

Bu Sun Kim

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

[diff] [blame]

526

},

527

],

528

},

Bu Sun Kim

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

[diff] [blame^]

529

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

530

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

Bu Sun Kim

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

[diff] [blame]

531

},

Bu Sun Kim

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

[diff] [blame^]

532

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

533

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

534

"A String",

Bu Sun Kim

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

[diff] [blame]

535

],

536

},

Bu Sun Kim

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

[diff] [blame]

537

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

538

#

539

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

540

# with media and suggestions.

541

#

Bu Sun Kim

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

[diff] [blame]

542

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

543

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

Bu Sun Kim

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

[diff] [blame]

544

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

Bu Sun Kim

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

[diff] [blame]

545

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

546

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

547

# 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

Bu Sun Kim

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

[diff] [blame]

564

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

Bu Sun Kim

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

[diff] [blame^]

565

# within a rich card with a vertical layout.

Bu Sun Kim

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

[diff] [blame]

566

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

567

# customizable, and this field is ignored.

568

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

569

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

570

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

571

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

Bu Sun Kim

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

[diff] [blame^]

572

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

573

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

574

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

575

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

576

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

Bu Sun Kim

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

[diff] [blame]

577

},

Bu Sun Kim

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

[diff] [blame^]

578

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

579

#

580

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

581

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

582

#

583

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

Bu Sun Kim

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

[diff] [blame]

584

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

585

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

586

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

587

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

588

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

589

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

590

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

591

# If the user has an app installed that is

592

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

593

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

594

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

595

},

596

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

597

# to send back to the agent.

598

},

599

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

Bu Sun Kim

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

[diff] [blame]

600

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

Bu Sun Kim

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

[diff] [blame^]

601

# but does not dial automatically.

Bu Sun Kim

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

[diff] [blame]

602

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

603

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

604

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

605

# +15556767888.

606

},

Bu Sun Kim

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

[diff] [blame]

607

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

608

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

609

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame^]

610

},

611

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

612

# instead of typing in their own response.

613

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

614

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

615

# forwarded to webhook to allow performing custom business logic.

616

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

Bu Sun Kim

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

[diff] [blame]

617

},

618

},

619

],

Bu Sun Kim

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

[diff] [blame]

620

},

Bu Sun Kim

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

[diff] [blame^]

621

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

622

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

623

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

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

[diff] [blame]

624

},

Bu Sun Kim

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

[diff] [blame^]

625

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

626

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

627

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

628

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

629

#

630

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

631

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

632

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

633

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

634

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

635

# added by default when enabling the Dialogflow V2 API.

636

#

637

# For audio from other sources, consider using the

638

# `TelephonySynthesizeSpeech` message with SSML.

639

},

640

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

641

"items": [ # Required. Carousel items.

642

{ # An item in the carousel.

643

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

644

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

645

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

646

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

647

},

648

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

649

# dialog.

650

"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

655

# response is given.

656

},

657

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

658

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

},

],

},

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

663

# This message in `QueryResult.fulfillment_messages` and

664

# `WebhookResponse.fulfillment_messages` should contain only one

665

# `SimpleResponse`.

666

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

667

{ # The simple response message containing speech or text.

668

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

669

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

670

# text_to_speech.

671

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

672

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

673

# speech output. Mutually exclusive with ssml.

},

],

},

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

678

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

679

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

680

# items.

681

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

682

# items, maximum of ten.

683

{ # Browsing carousel tile

684

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

685

# Card. Maximum of one line of text.

686

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

687

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

688

# text.

689

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

690

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

691

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

692

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

693

},

694

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

695

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

696

# the URL. Defaults to opening via web browser.

697

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

698

},

699

},

700

],

Bu Sun Kim

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

[diff] [blame]

701

},

Bu Sun Kim

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

[diff] [blame]

702

},

703

],

Bu Sun Kim

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

[diff] [blame^]

704

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

705

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

706

# for example with CreateIntent or

707

# BatchUpdateIntents, in order to make this

708

# intent a followup intent.

709

#

710

# It identifies the parent followup intent.

711

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

712

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

713

{ # Represents intent parameters.

714

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

715

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

716

# whether the intent cannot be completed without collecting the parameter

717

# value.

718

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

719

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

720

"A String",

721

],

722

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

723

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

724

# describes values of the parameter. If the parameter is

725

# required, this must be provided.

726

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

727

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

728

#

729

# - a constant string,

730

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

731

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

732

# - a parameter value from some context defined as

733

# `#context_name.parameter_name`.

734

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

735

# result.

736

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

737

# syntax: `#context_name.parameter_name`.

738

},

739

],

740

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

741

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

742

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

743

# Event names are limited to 150 characters.

744

"A String",

745

],

746

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

Bu Sun Kim

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

[diff] [blame]

747

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

748

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

749

# methods.

Dan O'Meara

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

[diff] [blame]

750

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

Bu Sun Kim

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

[diff] [blame^]

751

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

752

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

753

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

754

# auto-markup in the UI is turned off.

755

# DEPRECATED! Please use `ml_disabled` field instead.

756

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

757

# then the default value is determined as follows:

758

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

759

# ml_enabled = false / ml_disabled = true.

760

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

761

# ml_enabled = true / ml_disabled = false.

762

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

763

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

764

{ # Represents a single followup intent in the chain.

765

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

766

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

767

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

768

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

769

},

770

],

771

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

772

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

773

"A String",

774

],

Bu Sun Kim

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

[diff] [blame]

775

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

776

# triggered.

Dan O'Meara

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

[diff] [blame]

777

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

Bu Sun Kim

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

[diff] [blame]

778

"A String",

Bu Sun Kim

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

[diff] [blame]

779

],

Bu Sun Kim

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

[diff] [blame^]

780

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

781

# priorities.

782

#

783

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

784

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

785

# `Normal` priority in the console.

786

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

787

# in runtime detect intent requests.

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:

799

800

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

801

# network API call.

Bu Sun Kim

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

[diff] [blame]

802

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

803

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

804

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

Bu Sun Kim

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

[diff] [blame]

805

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

806

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

807

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

808

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

809

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

810

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

811

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

812

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

813

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

Dan O'Meara

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

[diff] [blame]

814

},

Bu Sun Kim

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

[diff] [blame^]

815

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

816

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

817

# available.

818

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

819

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

820

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

821

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

822

#

823

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

824

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

825

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

826

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

827

# message types for APIs to use.

828

{

829

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

830

},

831

],

832

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

833

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

834

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

835

},

836

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

837

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

838

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

839

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

840

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

841

},

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]

846

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

847

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

848

Dan O'Meara

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

[diff] [blame]

849

Operation <response: BatchUpdateIntentsResponse>

Bu Sun Kim

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

[diff] [blame]

850

851

Args:

852

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]

853

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

854

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

855

The object takes the form of:

856

857

{ # The request message for Intents.BatchUpdateIntents.

Bu Sun Kim

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

[diff] [blame^]

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

# For more information, see

866

# [Multilingual intent and entity

867

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

Bu Sun Kim

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

[diff] [blame]

868

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

869

"intents": [ # A collection of intents.

Bu Sun Kim

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

[diff] [blame^]

870

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

871

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

872

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

873

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

874

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

875

# intent classification.

876

#

877

# For more information, see the [intent

878

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

Bu Sun Kim

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

[diff] [blame]

879

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

880

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

881

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

Bu Sun Kim

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

[diff] [blame^]

882

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

883

# Note: The action name must not contain whitespaces.

884

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

Bu Sun Kim

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

[diff] [blame]

885

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

886

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

887

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

888

# when the intent is matched.

889

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

Bu Sun Kim

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

[diff] [blame^]

890

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

891

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

892

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

893

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

894

# an intent.

895

#

896

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

897

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

898

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

899

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

900

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

901

# contexts that correspond to the currently active contexts.

902

#

903

# For more information about context, see the

904

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

905

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

906

#

907

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

908

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

909

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

910

#

911

# - MapKey type: string

912

# - MapKey value: parameter name

913

# - MapValue type:

914

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

915

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

916

# - MapValue value:

917

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

918

# map from composite entity property names to property values

919

# - Else: parameter value

920

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

921

},

Bu Sun Kim

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

[diff] [blame]

922

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

923

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

924

# immediately. Contexts expire automatically after 20 minutes if there

925

# are no matching queries.

926

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

927

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

928

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

929

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

930

#

931

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

932

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

933

#

934

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

935

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

936

#

937

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

938

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

939

#

940

# * `__system_counters__`

941

# * `*_id_dialog_context`

942

# * `*_dialog_params_size`

Bu Sun Kim

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

[diff] [blame]

943

},

944

],

Bu Sun Kim

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

[diff] [blame^]

945

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

946

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

947

# session when this intent is matched.

948

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

949

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

950

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

951

# auto-markup in the UI is turned off.

952

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

953

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

954

# this intent.

955

#

956

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

957

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

958

# trained on.

959

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

960

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

961

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

962

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

963

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

964

#

965

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

966

# Dialogflow Console does.

967

#

968

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

969

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

970

#

971

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

972

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

973

#

974

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

975

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

976

#

977

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

978

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

979

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

980

# set.

981

{ # Represents a part of a training phrase.

982

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

983

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

984

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

985

# API, you must set this to true.

986

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

987

# annotated part of the example.

988

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

989

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

990

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

991

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

992

},

993

],

994

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

995

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

996

# intent or training, this counter is increased.

997

},

Bu Sun Kim

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

[diff] [blame]

998

],

999

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

1000

# `Response` field in the Dialogflow console.

1001

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

Bu Sun Kim

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

[diff] [blame^]

1002

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

1003

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

1004

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

1005

# to the conversation.

1006

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

},

],

},

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

1011

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

1012

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

1013

{ # Response media object for media content card.

1014

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

1015

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

1016

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

1017

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

1018

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

1019

},

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

},

},

],

},

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

1031

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

1032

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

1033

#

1034

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

1035

},

1036

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

1037

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

1038

# Telephony Gateway.

1039

#

1040

# Telephony Gateway takes the synthesizer settings from

1041

# `DetectIntentResponse.output_audio_config` which can either be set

1042

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

1043

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

1044

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

1045

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

1046

},

1047

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

1048

# or website associated with this agent.

1049

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

1050

# suggestion chip.

1051

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

1052

},

1053

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

1054

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

Bu Sun Kim

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

[diff] [blame]

1055

"A String",

1056

],

Bu Sun Kim

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

[diff] [blame^]

1057

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

1058

},

1059

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

1060

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

1061

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

1062

{ # Optional. Contains information about a button.

1063

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

1064

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

# open.

},

],

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

1069

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

1070

},

1071

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

1072

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

1073

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

1074

"items": [ # Required. List items.

1075

{ # An item in the list.

1076

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

1077

# dialog.

1078

"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

1083

# response is given.

1084

},

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

},

},

],

},

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

1096

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

1097

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

1098

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

1099

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

1100

},

1101

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

1102

},

1103

],

1104

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

1105

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

1106

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

1107

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

1108

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

1109

},

1110

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

1111

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

1112

},

1113

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

1114

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

1115

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

1116

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

Bu Sun Kim

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

[diff] [blame]

1117

},

1118

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

1119

#

1120

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

1121

# with media and suggestions.

1122

#

Bu Sun Kim

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

[diff] [blame]

1123

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

1124

# please use RbmStandaloneCard instead.

Bu Sun Kim

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

[diff] [blame^]

1125

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

Bu Sun Kim

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

[diff] [blame]

1126

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

1127

# 2 cards and at most 10.

1128

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

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

[diff] [blame]

1129

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

1130

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

1131

# 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

Bu Sun Kim

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

[diff] [blame]

1148

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

Bu Sun Kim

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

[diff] [blame^]

1149

# within a rich card with a vertical layout.

Bu Sun Kim

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

[diff] [blame]

1150

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

1151

# customizable, and this field is ignored.

1152

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

1153

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

1154

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

1155

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

Bu Sun Kim

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

[diff] [blame^]

1156

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

1157

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

1158

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

1159

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

1160

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

Bu Sun Kim

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

[diff] [blame]

1161

},

Bu Sun Kim

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

[diff] [blame^]

1162

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

1163

#

1164

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

1165

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

1166

#

1167

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

Bu Sun Kim

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

[diff] [blame]

1168

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

1169

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

1170

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

1171

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

1172

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

1173

# can choose from the card.

Bu Sun Kim

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

[diff] [blame^]

1174

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

1175

# If the user has an app installed that is

1176

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

1177

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

1178

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

1179

},

1180

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

1181

# to send back to the agent.

1182

},

1183

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

Bu Sun Kim

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

[diff] [blame]

1184

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

Bu Sun Kim

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

[diff] [blame^]

1185

# but does not dial automatically.

Bu Sun Kim

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

[diff] [blame]

1186

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

1187

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

1188

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

1189

# +15556767888.

1190

},

Bu Sun Kim

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

[diff] [blame]

1191

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

1192

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

1193

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame^]

1194

},

1195

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

1196

# instead of typing in their own response.

1197

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

1198

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

1199

# forwarded to webhook to allow performing custom business logic.

1200

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

Bu Sun Kim

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

[diff] [blame]

1201

},

1202

},

1203

],

Bu Sun Kim

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

[diff] [blame]

1204

},

1205

],

1206

},

Bu Sun Kim

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

[diff] [blame^]

1207

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

1208

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

Bu Sun Kim

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

[diff] [blame]

1209

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

1210

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

1211

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

1212

},

Bu Sun Kim

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

[diff] [blame^]

1213

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

Bu Sun Kim

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

[diff] [blame]

1214

},

1215

],

Bu Sun Kim

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

[diff] [blame^]

1216

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

Bu Sun Kim

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

[diff] [blame]

1217

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

1218

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

1219

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

1220

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

1221

},

Bu Sun Kim

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

[diff] [blame]

1222

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

1223

{ # Row of TableCard.

1224

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

1225

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

1226

{ # Cell of TableCardRow.

1227

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame^]

1232

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

Bu Sun Kim

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

[diff] [blame]

1233

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

1234

{ # Column properties for TableCard.

1235

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

1236

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

1237

},

1238

],

Bu Sun Kim

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

[diff] [blame]

1239

},

Bu Sun Kim

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

[diff] [blame^]

1240

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

1241

#

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

# opening a web uri).

1249

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

1250

# can choose from the card.

1251

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

1252

# If the user has an app installed that is

1253

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

1254

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

1255

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

1256

},

1257

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

1258

# to send back to the agent.

1259

},

1260

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

1261

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

1262

# but does not dial automatically.

1263

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

1264

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

1265

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

1266

# +15556767888.

1267

},

1268

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

1269

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

1270

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame]

1271

},

Bu Sun Kim

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

[diff] [blame^]

1272

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

1273

# instead of typing in their own response.

1274

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

1275

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

1276

# forwarded to webhook to allow performing custom business logic.

1277

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

Bu Sun Kim

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

[diff] [blame]

1278

},

Bu Sun Kim

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

[diff] [blame]

1279

},

1280

],

1281

},

Bu Sun Kim

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

[diff] [blame^]

1282

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

1283

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1284

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1285

"text": { # The text response message. # Returns a text response.

1286

"text": [ # Optional. The collection of the agent's responses.

1287

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1288

],

1289

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1290

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

1291

#

1292

# Rich cards allow you to respond to users with more vivid content, e.g.

1293

# with media and suggestions.

1294

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1295

# You can group multiple rich cards into one using RbmCarouselCard but

1296

# carousel cards will give you less control over the card layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1297

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1298

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

1299

# be set. Media (image, GIF or a video) to include in the card.

1300

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1317

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1318

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1319

# For a standalone card with horizontal layout, height is not

1320

# customizable, and this field is ignored.

1321

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

1322

# determines the MIME type of the file from the content-type field in

1323

# the HTTP headers when the platform fetches the file. The content-type

1324

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1325

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

1326

# provide a thumbnail URI, the RBM platform displays a blank

1327

# placeholder thumbnail until the user's device downloads the file.

1328

# Depending on the user's setting, the file may not download

1329

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1330

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1331

"title": "A String", # Optional. Title of the card (at most 200 bytes).

1332

#

1333

# At least one of the title, description or media must be set.

1334

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

1335

#

1336

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1337

"suggestions": [ # Optional. List of suggestions to include in the card.

1338

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1339

# easily select/click a predefined response or perform an action (like

1340

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1341

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1342

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1343

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1344

# If the user has an app installed that is

1345

# registered as the default handler for the URL, then this app will be

1346

# opened instead, and its icon will be used in the suggested action UI.

1347

"uri": "A String", # Required. The uri to open on the user device

1348

},

1349

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1350

# to send back to the agent.

1351

},

1352

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1353

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1354

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1355

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1356

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1357

# format. An example of a correctly formatted phone number:

1358

# +15556767888.

1359

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1360

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1361

# when the user taps the suggested action. This data will be also

1362

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1363

},

1364

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1365

# instead of typing in their own response.

1366

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1367

# when the user taps the suggested reply. This data will be also

1368

# forwarded to webhook to allow performing custom business logic.

1369

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1370

},

1371

},

1372

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1373

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1374

"cardOrientation": "A String", # Required. Orientation of the card.

1375

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

1376

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1377

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1378

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

1379

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

1380

# play, e.g., "gs://bucket/object". The object must contain a single

1381

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

1382

#

1383

# This object must be readable by the `service-<Project

1384

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

1385

# where <Project Number> is the number of the Telephony Gateway project

1386

# (usually the same as the Dialogflow agent project). If the Google Cloud

1387

# Storage bucket is in the Telephony Gateway project, this permission is

1388

# added by default when enabling the Dialogflow V2 API.

1389

#

1390

# For audio from other sources, consider using the

1391

# `TelephonySynthesizeSpeech` message with SSML.

1392

},

1393

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

1394

"items": [ # Required. Carousel items.

1395

{ # An item in the carousel.

1396

"image": { # The image response message. # Optional. The image to display.

1397

"imageUri": "A String", # Optional. The public URI to an image file.

1398

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1399

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1400

},

1401

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

1402

# dialog.

1403

"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

1408

# response is given.

1409

},

1410

"title": "A String", # Required. Title of the carousel item.

1411

"description": "A String", # Optional. The body text of the card.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

1416

# This message in `QueryResult.fulfillment_messages` and

1417

# `WebhookResponse.fulfillment_messages` should contain only one

1418

# `SimpleResponse`.

1419

"simpleResponses": [ # Required. The list of simple responses.

1420

{ # The simple response message containing speech or text.

1421

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

1422

# response to the user in the SSML format. Mutually exclusive with

1423

# text_to_speech.

1424

"displayText": "A String", # Optional. The text to display.

1425

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

1426

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

1431

# https://developers.google.com/actions/assistant/responses#browsing_carousel

1432

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

1433

# items.

1434

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

1435

# items, maximum of ten.

1436

{ # Browsing carousel tile

1437

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

1438

# Card. Maximum of one line of text.

1439

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

1440

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

1441

# text.

1442

"image": { # The image response message. # Optional. Hero image for the carousel item.

1443

"imageUri": "A String", # Optional. The public URI to an image file.

1444

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1445

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1446

},

1447

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1448

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

1449

# the URL. Defaults to opening via web browser.

1450

"url": "A String", # Required. URL

1451

},

1452

},

1453

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1454

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1455

},

1456

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1457

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

1458

# chain of followup intents. You can set this field when creating an intent,

1459

# for example with CreateIntent or

1460

# BatchUpdateIntents, in order to make this

1461

# intent a followup intent.

1462

#

1463

# It identifies the parent followup intent.

1464

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1465

"parameters": [ # Optional. The collection of parameters associated with the intent.

1466

{ # Represents intent parameters.

1467

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1468

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

1469

# whether the intent cannot be completed without collecting the parameter

1470

# value.

1471

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1472

# user in order to collect a value for the parameter.

1473

"A String",

1474

],

1475

"name": "A String", # The unique identifier of this parameter.

1476

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1477

# describes values of the parameter. If the parameter is

1478

# required, this must be provided.

1479

"displayName": "A String", # Required. The name of the parameter.

1480

"value": "A String", # Optional. The definition of the parameter value. It can be:

1481

#

1482

# - a constant string,

1483

# - a parameter value defined as `$parameter_name`,

1484

# - an original parameter value defined as `$parameter_name.original`,

1485

# - a parameter value from some context defined as

1486

# `#context_name.parameter_name`.

1487

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1488

# result.

1489

# Default values can be extracted from contexts by using the following

1490

# syntax: `#context_name.parameter_name`.

1491

},

1492

],

1493

"events": [ # Optional. The collection of event names that trigger the intent.

1494

# If the collection of input contexts is not empty, all of the contexts must

1495

# be present in the active user session for an event to trigger this intent.

1496

# Event names are limited to 150 characters.

1497

"A String",

1498

],

1499

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1500

"name": "A String", # Optional. The unique identifier of this intent.

1501

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1502

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1503

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1504

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

1505

# Note: If `ml_enabled` setting is set to false, then this intent is not

1506

# taken into account during inference in `ML ONLY` match mode. Also,

1507

# auto-markup in the UI is turned off.

1508

# DEPRECATED! Please use `ml_disabled` field instead.

1509

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

1510

# then the default value is determined as follows:

1511

# - Before April 15th, 2018 the default is:

1512

# ml_enabled = false / ml_disabled = true.

1513

# - After April 15th, 2018 the default is:

1514

# ml_enabled = true / ml_disabled = false.

1515

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

1516

# a direct or indirect parent. We populate this field only in the output.

1517

{ # Represents a single followup intent in the chain.

1518

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

1519

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1520

"followupIntentName": "A String", # The unique identifier of the followup intent.

1521

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1522

},

1523

],

1524

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

1525

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1526

"A String",

1527

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1528

"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]

1529

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1530

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1531

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1532

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1533

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

1534

# priorities.

1535

#

1536

# - If the supplied value is unspecified or 0, the service

1537

# translates the value to 500,000, which corresponds to the

1538

# `Normal` priority in the console.

1539

# - If the supplied value is negative, the intent is ignored

1540

# in runtime detect intent requests.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1541

},

1542

],

1543

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1544

}

1545

1546

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1553

1554

{ # This resource represents a long-running operation that is the result of a

1555

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1556

"name": "A String", # The server-assigned name, which is only unique within the same service that

1557

# originally returns it. If you use the default HTTP mapping, the

1558

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1559

"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]

1560

# method returns no data on success, such as `Delete`, the response is

1561

# `google.protobuf.Empty`. If the original method is standard

1562

# `Get`/`Create`/`Update`, the response should be the resource. For other

1563

# methods, the response should have the type `XxxResponse`, where `Xxx`

1564

# is the original method name. For example, if the original method name

1565

# is `TakeSnapshot()`, the inferred response type is

1566

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1567

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1568

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1569

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1570

# If `true`, the operation is completed, and either `error` or `response` is

1571

# available.

1572

"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.

1573

# different programming environments, including REST APIs and RPC APIs. It is

1574

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1575

# three pieces of data: error code, error message, and error details.

1576

#

1577

# You can find out more about this error model and how to work with it in the

1578

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1579

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1580

"details": [ # A list of messages that carry the error details. There is a common set of

1581

# message types for APIs to use.

1582

{

1583

"a_key": "", # Properties of the object. Contains field @type with type URL.

1584

},

1585

],

1586

"message": "A String", # A developer-facing error message, which should be in English. Any

1587

# user-facing error message should be localized and sent in the

1588

# google.rpc.Status.details field, or localized by the client.

1589

},

1590

"metadata": { # Service-specific metadata associated with the operation. It typically

1591

# contains progress information and common metadata such as create time.

1592

# Some services might not provide such metadata. Any method that returns a

1593

# long-running operation should document the metadata type, if any.

1594

"a_key": "", # Properties of the object. Contains field @type with type URL.

1595

},

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]

1600

<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]

1601

<pre>Creates an intent in the specified agent.

1602

1603

Args:

1604

parent: string, Required. The agent to create a intent for.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1605

Format: `projects/<Project ID>/agent`. (required)

1606

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1607

The object takes the form of:

1608

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1609

{ # An intent categorizes an end-user's intention for one conversation turn. For

1610

# each agent, you define many intents, where your combined intents can handle a

1611

# complete conversation. When an end-user writes or says something, referred to

1612

# as an end-user expression or end-user input, Dialogflow matches the end-user

1613

# input to the best intent in your agent. Matching an intent is also known as

1614

# intent classification.

1615

#

1616

# For more information, see the [intent

1617

# guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1618

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

1619

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

1620

# to close interaction with an end user. Default is false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1621

"action": "A String", # Optional. The name of the action associated with the intent.

1622

# Note: The action name must not contain whitespaces.

1623

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1624

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1625

# is matched. Context messages in this collection should not set the

1626

# parameters field. Setting the `lifespan_count` to 0 will reset the context

1627

# when the intent is matched.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1628

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1629

{ # Dialogflow contexts are similar to natural language context. If a person says

1630

# to you "they are orange", you need context in order to understand what "they"

1631

# is referring to. Similarly, for Dialogflow to handle an end-user expression

1632

# like that, it needs to be provided with context in order to correctly match

1633

# an intent.

1634

#

1635

# Using contexts, you can control the flow of a conversation. You can configure

1636

# contexts for an intent by setting input and output contexts, which are

1637

# identified by string names. When an intent is matched, any configured output

1638

# contexts for that intent become active. While any contexts are active,

1639

# Dialogflow is more likely to match intents that are configured with input

1640

# contexts that correspond to the currently active contexts.

1641

#

1642

# For more information about context, see the

1643

# [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

1644

"parameters": { # Optional. The collection of parameters associated with this context.

1645

#

1646

# Depending on your protocol or client library language, this is a

1647

# map, associative array, symbol table, dictionary, or JSON object

1648

# composed of a collection of (MapKey, MapValue) pairs:

1649

#

1650

# - MapKey type: string

1651

# - MapKey value: parameter name

1652

# - MapValue type:

1653

# - If parameter's entity type is a composite entity: map

1654

# - Else: string or number, depending on parameter value type

1655

# - MapValue value:

1656

# - If parameter's entity type is a composite entity:

1657

# map from composite entity property names to property values

1658

# - Else: parameter value

1659

"a_key": "", # Properties of the object.

1660

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1661

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1662

# context expires. The default is `0`. If set to `0`, the context expires

1663

# immediately. Contexts expire automatically after 20 minutes if there

1664

# are no matching queries.

1665

"name": "A String", # Required. The unique identifier of the context. Format:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1666

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1667

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1668

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1669

#

1670

# The `Context ID` is always converted to lowercase, may only contain

1671

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

1672

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1673

# If `Environment ID` is not specified, we assume default 'draft'

1674

# environment. If `User ID` is not specified, we assume default '-' user.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1675

#

1676

# The following context names are reserved for internal use by Dialogflow.

1677

# You should not use these contexts or create contexts with these names:

1678

#

1679

# * `__system_counters__`

1680

# * `*_id_dialog_context`

1681

# * `*_dialog_params_size`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1682

},

1683

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1684

"displayName": "A String", # Required. The name of this intent.

1685

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

1686

# session when this intent is matched.

1687

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

1688

# Note: If `ml_disabled` setting is set to true, then this intent is not

1689

# taken into account during inference in `ML ONLY` match mode. Also,

1690

# auto-markup in the UI is turned off.

1691

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

1692

# followup intents. It identifies the correct followup intents chain for

1693

# this intent.

1694

#

1695

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1696

"trainingPhrases": [ # Optional. The collection of examples that the agent is

1697

# trained on.

1698

{ # Represents an example that the agent is trained on.

1699

"type": "A String", # Required. The type of the training phrase.

1700

"name": "A String", # Output only. The unique identifier of this training phrase.

1701

"parts": [ # Required. The ordered list of training phrase parts.

1702

# The parts are concatenated in order to form the training phrase.

1703

#

1704

# Note: The API does not automatically annotate training phrases like the

1705

# Dialogflow Console does.

1706

#

1707

# Note: Do not forget to include whitespace at part boundaries,

1708

# so the training phrase is well formatted when the parts are concatenated.

1709

#

1710

# If the training phrase does not need to be annotated with parameters,

1711

# you just need a single part with only the Part.text field set.

1712

#

1713

# If you want to annotate the training phrase, you must create multiple

1714

# parts, where the fields of each part are populated in one of two ways:

1715

#

1716

# - `Part.text` is set to a part of the phrase that has no parameters.

1717

# - `Part.text` is set to a part of the phrase that you want to annotate,

1718

# and the `entity_type`, `alias`, and `user_defined` fields are all

1719

# set.

1720

{ # Represents a part of a training phrase.

1721

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

1722

# This field is set to true when the Dialogflow Console is used to

1723

# manually annotate the part. When creating an annotated part with the

1724

# API, you must set this to true.

1725

"alias": "A String", # Optional. The parameter name for the value extracted from the

1726

# annotated part of the example.

1727

# This field is required for annotated parts of the training phrase.

1728

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

1729

# This field is required for annotated parts of the training phrase.

1730

"text": "A String", # Required. The text for this part.

1731

},

1732

],

1733

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

1734

# the intent. Each time a developer adds an existing sample by editing an

1735

# intent or training, this counter is increased.

1736

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1737

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1738

"messages": [ # Optional. The collection of rich messages corresponding to the

1739

# `Response` field in the Dialogflow console.

1740

{ # Corresponds to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1741

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

1742

"suggestions": [ # Required. The list of suggested replies.

1743

{ # The suggestion chip message that the user can tap to quickly post a reply

1744

# to the conversation.

1745

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1750

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1751

"mediaObjects": [ # Required. List of media objects.

1752

{ # Response media object for media content card.

1753

"description": "A String", # Optional. Description of media card.

1754

"icon": { # The image response message. # Optional. Icon to display above media content.

1755

"imageUri": "A String", # Optional. The public URI to an image file.

1756

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1757

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1758

},

1759

"contentUrl": "A String", # Required. Url where the media is stored.

1760

"name": "A String", # Required. Name of media card.

1761

"largeImage": { # The image response message. # Optional. Image to display above media content.

1762

"imageUri": "A String", # Optional. The public URI to an image file.

1763

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1764

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

1770

"phoneNumber": "A String", # Required. The phone number to transfer the call to

1771

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

1772

#

1773

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

1774

},

1775

"platform": "A String", # Optional. The platform that this message is intended for.

1776

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

1777

# Telephony Gateway.

1778

#

1779

# Telephony Gateway takes the synthesizer settings from

1780

# `DetectIntentResponse.output_audio_config` which can either be set

1781

# at request-level or can come from the agent-level synthesizer config.

1782

"text": "A String", # The raw text to be synthesized.

1783

"ssml": "A String", # The SSML to be synthesized. For more information, see

1784

# [SSML](https://developers.google.com/actions/reference/ssml).

1785

},

1786

"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.

1787

# or website associated with this agent.

1788

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

1789

# suggestion chip.

1790

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1791

},

1792

"quickReplies": { # The quick replies response message. # Displays quick replies.

1793

"quickReplies": [ # Optional. The collection of quick replies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1794

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1795

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1796

"title": "A String", # Optional. The title of the collection of quick replies.

1797

},

1798

"card": { # The card response message. # Displays a card.

1799

"subtitle": "A String", # Optional. The subtitle of the card.

1800

"buttons": [ # Optional. The collection of card buttons.

1801

{ # Optional. Contains information about a button.

1802

"text": "A String", # Optional. The text to show on the button.

1803

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

1808

"title": "A String", # Optional. The title of the card.

1809

},

1810

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

1811

"subtitle": "A String", # Optional. Subtitle of the list.

1812

"title": "A String", # Optional. The overall title of the list.

1813

"items": [ # Required. List items.

1814

{ # An item in the list.

1815

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

1816

# dialog.

1817

"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

1822

# response is given.

1823

},

1824

"description": "A String", # Optional. The main text describing the item.

1825

"title": "A String", # Required. The title of the list item.

1826

"image": { # The image response message. # Optional. The image to display.

1827

"imageUri": "A String", # Optional. The public URI to an image file.

1828

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1829

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

1835

"buttons": [ # Optional. The collection of card buttons.

1836

{ # The button object that appears at the bottom of a card.

1837

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1838

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1839

},

1840

"title": "A String", # Required. The title of the button.

1841

},

1842

],

1843

"title": "A String", # Optional. The title of the card.

1844

"image": { # The image response message. # Optional. The image for the card.

1845

"imageUri": "A String", # Optional. The public URI to an image file.

1846

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1847

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1848

},

1849

"subtitle": "A String", # Optional. The subtitle of the card.

1850

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1851

},

1852

"image": { # The image response message. # Displays an image.

1853

"imageUri": "A String", # Optional. The public URI to an image file.

1854

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1855

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1856

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1857

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

1858

#

1859

# Rich cards allow you to respond to users with more vivid content, e.g.

1860

# with media and suggestions.

1861

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1862

# If you want to show a single card with more control over the layout,

1863

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1864

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1865

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

1866

# 2 cards and at most 10.

1867

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1868

"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]

1869

# be set. Media (image, GIF or a video) to include in the card.

1870

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1875

# * 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]

1887

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1888

# within a rich card with a vertical layout.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1889

# For a standalone card with horizontal layout, height is not

1890

# customizable, and this field is ignored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1891

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

1892

# determines the MIME type of the file from the content-type field in

1893

# the HTTP headers when the platform fetches the file. The content-type

1894

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1895

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

1896

# provide a thumbnail URI, the RBM platform displays a blank

1897

# placeholder thumbnail until the user's device downloads the file.

1898

# Depending on the user's setting, the file may not download

1899

# automatically and may require the user to tap a download button.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1900

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1901

"title": "A String", # Optional. Title of the card (at most 200 bytes).

1902

#

1903

# At least one of the title, description or media must be set.

1904

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

1905

#

1906

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1907

"suggestions": [ # Optional. List of suggestions to include in the card.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1908

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1909

# easily select/click a predefined response or perform an action (like

1910

# opening a web uri).

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1912

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1913

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1914

# If the user has an app installed that is

1915

# registered as the default handler for the URL, then this app will be

1916

# opened instead, and its icon will be used in the suggested action UI.

1917

"uri": "A String", # Required. The uri to open on the user device

1918

},

1919

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1920

# to send back to the agent.

1921

},

1922

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1923

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1924

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1925

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1926

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1927

# format. An example of a correctly formatted phone number:

1928

# +15556767888.

1929

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1930

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1931

# when the user taps the suggested action. This data will be also

1932

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1933

},

1934

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1935

# instead of typing in their own response.

1936

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1937

# when the user taps the suggested reply. This data will be also

1938

# forwarded to webhook to allow performing custom business logic.

1939

"text": "A String", # Suggested reply text.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1940

},

1941

},

1942

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1943

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1944

],

1945

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1946

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

1947

"buttons": [ # Optional. List of buttons for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1948

{ # The button object that appears at the bottom of a card.

1949

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1950

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1951

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1952

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1953

},

1954

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1955

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1956

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1957

"imageUri": "A String", # Optional. The public URI to an image file.

1958

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1959

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1960

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1961

"rows": [ # Optional. Rows in this table of data.

1962

{ # Row of TableCard.

1963

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

1964

"cells": [ # Optional. List of cells that make up this row.

1965

{ # Cell of TableCardRow.

1966

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1971

"title": "A String", # Required. Title of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1972

"columnProperties": [ # Optional. Display properties for the columns in this table.

1973

{ # Column properties for TableCard.

1974

"header": "A String", # Required. Column heading.

1975

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

1976

},

1977

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1978

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1979

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

1980

#

1981

# RBM allows businesses to send enriched and branded versions of SMS. See

1982

# https://jibe.google.com/business-messaging.

1983

"text": "A String", # Required. Text sent and displayed to the user.

1984

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

1985

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1986

# easily select/click a predefined response or perform an action (like

1987

# opening a web uri).

1988

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1989

# can choose from the card.

1990

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1991

# If the user has an app installed that is

1992

# registered as the default handler for the URL, then this app will be

1993

# opened instead, and its icon will be used in the suggested action UI.

1994

"uri": "A String", # Required. The uri to open on the user device

1995

},

1996

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1997

# to send back to the agent.

1998

},

1999

"text": "A String", # Text to display alongside the action.

2000

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2001

# but does not dial automatically.

2002

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2003

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2004

# format. An example of a correctly formatted phone number:

2005

# +15556767888.

2006

},

2007

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2008

# when the user taps the suggested action. This data will be also

2009

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2010

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2011

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2012

# instead of typing in their own response.

2013

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2014

# when the user taps the suggested reply. This data will be also

2015

# forwarded to webhook to allow performing custom business logic.

2016

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2017

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2018

},

2019

],

2020

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2021

"payload": { # A custom platform-specific response.

2022

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2023

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2024

"text": { # The text response message. # Returns a text response.

2025

"text": [ # Optional. The collection of the agent's responses.

2026

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2027

],

2028

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2029

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2030

#

2031

# Rich cards allow you to respond to users with more vivid content, e.g.

2032

# with media and suggestions.

2033

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2034

# You can group multiple rich cards into one using RbmCarouselCard but

2035

# carousel cards will give you less control over the card layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2036

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2037

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2038

# be set. Media (image, GIF or a video) to include in the card.

2039

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2056

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2057

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2058

# For a standalone card with horizontal layout, height is not

2059

# customizable, and this field is ignored.

2060

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2061

# determines the MIME type of the file from the content-type field in

2062

# the HTTP headers when the platform fetches the file. The content-type

2063

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2064

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2065

# provide a thumbnail URI, the RBM platform displays a blank

2066

# placeholder thumbnail until the user's device downloads the file.

2067

# Depending on the user's setting, the file may not download

2068

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2069

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2070

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2071

#

2072

# At least one of the title, description or media must be set.

2073

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2074

#

2075

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2076

"suggestions": [ # Optional. List of suggestions to include in the card.

2077

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2078

# easily select/click a predefined response or perform an action (like

2079

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2080

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2081

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2082

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2083

# If the user has an app installed that is

2084

# registered as the default handler for the URL, then this app will be

2085

# opened instead, and its icon will be used in the suggested action UI.

2086

"uri": "A String", # Required. The uri to open on the user device

2087

},

2088

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2089

# to send back to the agent.

2090

},

2091

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2092

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2093

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2094

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2095

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2096

# format. An example of a correctly formatted phone number:

2097

# +15556767888.

2098

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2099

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2100

# when the user taps the suggested action. This data will be also

2101

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2102

},

2103

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2104

# instead of typing in their own response.

2105

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2106

# when the user taps the suggested reply. This data will be also

2107

# forwarded to webhook to allow performing custom business logic.

2108

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2109

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2110

},

2111

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2112

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2113

"cardOrientation": "A String", # Required. Orientation of the card.

2114

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2115

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2116

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2117

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2118

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

2119

# play, e.g., "gs://bucket/object". The object must contain a single

2120

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

2121

#

2122

# This object must be readable by the `service-<Project

2123

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

2124

# where <Project Number> is the number of the Telephony Gateway project

2125

# (usually the same as the Dialogflow agent project). If the Google Cloud

2126

# Storage bucket is in the Telephony Gateway project, this permission is

2127

# added by default when enabling the Dialogflow V2 API.

2128

#

2129

# For audio from other sources, consider using the

2130

# `TelephonySynthesizeSpeech` message with SSML.

2131

},

2132

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2133

"items": [ # Required. Carousel items.

2134

{ # An item in the carousel.

2135

"image": { # The image response message. # Optional. The image to display.

2136

"imageUri": "A String", # Optional. The public URI to an image file.

2137

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2138

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2139

},

2140

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2141

# dialog.

2142

"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

2147

# response is given.

2148

},

2149

"title": "A String", # Required. Title of the carousel item.

2150

"description": "A String", # Optional. The body text of the card.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

2155

# This message in `QueryResult.fulfillment_messages` and

2156

# `WebhookResponse.fulfillment_messages` should contain only one

2157

# `SimpleResponse`.

2158

"simpleResponses": [ # Required. The list of simple responses.

2159

{ # The simple response message containing speech or text.

2160

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2161

# response to the user in the SSML format. Mutually exclusive with

2162

# text_to_speech.

2163

"displayText": "A String", # Optional. The text to display.

2164

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2165

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2170

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2171

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2172

# items.

2173

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2174

# items, maximum of ten.

2175

{ # Browsing carousel tile

2176

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2177

# Card. Maximum of one line of text.

2178

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2179

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2180

# text.

2181

"image": { # The image response message. # Optional. Hero image for the carousel item.

2182

"imageUri": "A String", # Optional. The public URI to an image file.

2183

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2184

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2185

},

2186

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2187

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2188

# the URL. Defaults to opening via web browser.

2189

"url": "A String", # Required. URL

2190

},

2191

},

2192

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2193

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2194

},

2195

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2196

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

2197

# chain of followup intents. You can set this field when creating an intent,

2198

# for example with CreateIntent or

2199

# BatchUpdateIntents, in order to make this

2200

# intent a followup intent.

2201

#

2202

# It identifies the parent followup intent.

2203

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2204

"parameters": [ # Optional. The collection of parameters associated with the intent.

2205

{ # Represents intent parameters.

2206

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2207

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

2208

# whether the intent cannot be completed without collecting the parameter

2209

# value.

2210

"prompts": [ # Optional. The collection of prompts that the agent can present to the

2211

# user in order to collect a value for the parameter.

2212

"A String",

2213

],

2214

"name": "A String", # The unique identifier of this parameter.

2215

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

2216

# describes values of the parameter. If the parameter is

2217

# required, this must be provided.

2218

"displayName": "A String", # Required. The name of the parameter.

2219

"value": "A String", # Optional. The definition of the parameter value. It can be:

2220

#

2221

# - a constant string,

2222

# - a parameter value defined as `$parameter_name`,

2223

# - an original parameter value defined as `$parameter_name.original`,

2224

# - a parameter value from some context defined as

2225

# `#context_name.parameter_name`.

2226

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

2227

# result.

2228

# Default values can be extracted from contexts by using the following

2229

# syntax: `#context_name.parameter_name`.

2230

},

2231

],

2232

"events": [ # Optional. The collection of event names that trigger the intent.

2233

# If the collection of input contexts is not empty, all of the contexts must

2234

# be present in the active user session for an event to trigger this intent.

2235

# Event names are limited to 150 characters.

2236

"A String",

2237

],

2238

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2239

"name": "A String", # Optional. The unique identifier of this intent.

2240

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2241

# methods.

2242

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2243

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

2244

# Note: If `ml_enabled` setting is set to false, then this intent is not

2245

# taken into account during inference in `ML ONLY` match mode. Also,

2246

# auto-markup in the UI is turned off.

2247

# DEPRECATED! Please use `ml_disabled` field instead.

2248

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

2249

# then the default value is determined as follows:

2250

# - Before April 15th, 2018 the default is:

2251

# ml_enabled = false / ml_disabled = true.

2252

# - After April 15th, 2018 the default is:

2253

# ml_enabled = true / ml_disabled = false.

2254

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

2255

# a direct or indirect parent. We populate this field only in the output.

2256

{ # Represents a single followup intent in the chain.

2257

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2258

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2259

"followupIntentName": "A String", # The unique identifier of the followup intent.

2260

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2261

},

2262

],

2263

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2264

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2265

"A String",

2266

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2267

"inputContextNames": [ # Optional. The list of context names required for this intent to be

2268

# triggered.

2269

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2270

"A String",

2271

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2272

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

2273

# priorities.

2274

#

2275

# - If the supplied value is unspecified or 0, the service

2276

# translates the value to 500,000, which corresponds to the

2277

# `Normal` priority in the console.

2278

# - If the supplied value is negative, the intent is ignored

2279

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2280

}

2281

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2282

languageCode: string, Optional. The language used to access language-specific data.

2283

If not specified, the agent's default language is used.

2284

For more information, see

2285

[Multilingual intent and entity

2286

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2287

intentView: string, Optional. The resource view to apply to the returned intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2288

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2295

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2296

{ # An intent categorizes an end-user's intention for one conversation turn. For

2297

# each agent, you define many intents, where your combined intents can handle a

2298

# complete conversation. When an end-user writes or says something, referred to

2299

# as an end-user expression or end-user input, Dialogflow matches the end-user

2300

# input to the best intent in your agent. Matching an intent is also known as

2301

# intent classification.

2302

#

2303

# For more information, see the [intent

2304

# guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2305

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

2306

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

2307

# to close interaction with an end user. Default is false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2308

"action": "A String", # Optional. The name of the action associated with the intent.

2309

# Note: The action name must not contain whitespaces.

2310

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2311

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

2312

# is matched. Context messages in this collection should not set the

2313

# parameters field. Setting the `lifespan_count` to 0 will reset the context

2314

# when the intent is matched.

2315

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2316

{ # Dialogflow contexts are similar to natural language context. If a person says

2317

# to you "they are orange", you need context in order to understand what "they"

2318

# is referring to. Similarly, for Dialogflow to handle an end-user expression

2319

# like that, it needs to be provided with context in order to correctly match

2320

# an intent.

2321

#

2322

# Using contexts, you can control the flow of a conversation. You can configure

2323

# contexts for an intent by setting input and output contexts, which are

2324

# identified by string names. When an intent is matched, any configured output

2325

# contexts for that intent become active. While any contexts are active,

2326

# Dialogflow is more likely to match intents that are configured with input

2327

# contexts that correspond to the currently active contexts.

2328

#

2329

# For more information about context, see the

2330

# [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

2331

"parameters": { # Optional. The collection of parameters associated with this context.

2332

#

2333

# Depending on your protocol or client library language, this is a

2334

# map, associative array, symbol table, dictionary, or JSON object

2335

# composed of a collection of (MapKey, MapValue) pairs:

2336

#

2337

# - MapKey type: string

2338

# - MapKey value: parameter name

2339

# - MapValue type:

2340

# - If parameter's entity type is a composite entity: map

2341

# - Else: string or number, depending on parameter value type

2342

# - MapValue value:

2343

# - If parameter's entity type is a composite entity:

2344

# map from composite entity property names to property values

2345

# - Else: parameter value

2346

"a_key": "", # Properties of the object.

2347

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2348

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

2349

# context expires. The default is `0`. If set to `0`, the context expires

2350

# immediately. Contexts expire automatically after 20 minutes if there

2351

# are no matching queries.

2352

"name": "A String", # Required. The unique identifier of the context. Format:

2353

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

2354

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

2355

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

2356

#

2357

# The `Context ID` is always converted to lowercase, may only contain

2358

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2359

#

2360

# If `Environment ID` is not specified, we assume default 'draft'

2361

# environment. If `User ID` is not specified, we assume default '-' user.

2362

#

2363

# The following context names are reserved for internal use by Dialogflow.

2364

# You should not use these contexts or create contexts with these names:

2365

#

2366

# * `__system_counters__`

2367

# * `*_id_dialog_context`

2368

# * `*_dialog_params_size`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2369

},

2370

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2371

"displayName": "A String", # Required. The name of this intent.

2372

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

2373

# session when this intent is matched.

2374

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2375

# Note: If `ml_disabled` setting is set to true, then this intent is not

2376

# taken into account during inference in `ML ONLY` match mode. Also,

2377

# auto-markup in the UI is turned off.

2378

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

2379

# followup intents. It identifies the correct followup intents chain for

2380

# this intent.

2381

#

2382

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2383

"trainingPhrases": [ # Optional. The collection of examples that the agent is

2384

# trained on.

2385

{ # Represents an example that the agent is trained on.

2386

"type": "A String", # Required. The type of the training phrase.

2387

"name": "A String", # Output only. The unique identifier of this training phrase.

2388

"parts": [ # Required. The ordered list of training phrase parts.

2389

# The parts are concatenated in order to form the training phrase.

2390

#

2391

# Note: The API does not automatically annotate training phrases like the

2392

# Dialogflow Console does.

2393

#

2394

# Note: Do not forget to include whitespace at part boundaries,

2395

# so the training phrase is well formatted when the parts are concatenated.

2396

#

2397

# If the training phrase does not need to be annotated with parameters,

2398

# you just need a single part with only the Part.text field set.

2399

#

2400

# If you want to annotate the training phrase, you must create multiple

2401

# parts, where the fields of each part are populated in one of two ways:

2402

#

2403

# - `Part.text` is set to a part of the phrase that has no parameters.

2404

# - `Part.text` is set to a part of the phrase that you want to annotate,

2405

# and the `entity_type`, `alias`, and `user_defined` fields are all

2406

# set.

2407

{ # Represents a part of a training phrase.

2408

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

2409

# This field is set to true when the Dialogflow Console is used to

2410

# manually annotate the part. When creating an annotated part with the

2411

# API, you must set this to true.

2412

"alias": "A String", # Optional. The parameter name for the value extracted from the

2413

# annotated part of the example.

2414

# This field is required for annotated parts of the training phrase.

2415

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2416

# This field is required for annotated parts of the training phrase.

2417

"text": "A String", # Required. The text for this part.

2418

},

2419

],

2420

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

2421

# the intent. Each time a developer adds an existing sample by editing an

2422

# intent or training, this counter is increased.

2423

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2424

],

2425

"messages": [ # Optional. The collection of rich messages corresponding to the

2426

# `Response` field in the Dialogflow console.

2427

{ # Corresponds to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2428

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2429

"suggestions": [ # Required. The list of suggested replies.

2430

{ # The suggestion chip message that the user can tap to quickly post a reply

2431

# to the conversation.

2432

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2437

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2438

"mediaObjects": [ # Required. List of media objects.

2439

{ # Response media object for media content card.

2440

"description": "A String", # Optional. Description of media card.

2441

"icon": { # The image response message. # Optional. Icon to display above media content.

2442

"imageUri": "A String", # Optional. The public URI to an image file.

2443

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2444

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2445

},

2446

"contentUrl": "A String", # Required. Url where the media is stored.

2447

"name": "A String", # Required. Name of media card.

2448

"largeImage": { # The image response message. # Optional. Image to display above media content.

2449

"imageUri": "A String", # Optional. The public URI to an image file.

2450

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2451

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2457

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2458

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2459

#

2460

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2461

},

2462

"platform": "A String", # Optional. The platform that this message is intended for.

2463

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

2464

# Telephony Gateway.

2465

#

2466

# Telephony Gateway takes the synthesizer settings from

2467

# `DetectIntentResponse.output_audio_config` which can either be set

2468

# at request-level or can come from the agent-level synthesizer config.

2469

"text": "A String", # The raw text to be synthesized.

2470

"ssml": "A String", # The SSML to be synthesized. For more information, see

2471

# [SSML](https://developers.google.com/actions/reference/ssml).

2472

},

2473

"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.

2474

# or website associated with this agent.

2475

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2476

# suggestion chip.

2477

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2478

},

2479

"quickReplies": { # The quick replies response message. # Displays quick replies.

2480

"quickReplies": [ # Optional. The collection of quick replies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2481

"A String",

2482

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2483

"title": "A String", # Optional. The title of the collection of quick replies.

2484

},

2485

"card": { # The card response message. # Displays a card.

2486

"subtitle": "A String", # Optional. The subtitle of the card.

2487

"buttons": [ # Optional. The collection of card buttons.

2488

{ # Optional. Contains information about a button.

2489

"text": "A String", # Optional. The text to show on the button.

2490

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2495

"title": "A String", # Optional. The title of the card.

2496

},

2497

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

2498

"subtitle": "A String", # Optional. Subtitle of the list.

2499

"title": "A String", # Optional. The overall title of the list.

2500

"items": [ # Required. List items.

2501

{ # An item in the list.

2502

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2503

# dialog.

2504

"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

2509

# response is given.

2510

},

2511

"description": "A String", # Optional. The main text describing the item.

2512

"title": "A String", # Required. The title of the list item.

2513

"image": { # The image response message. # Optional. The image to display.

2514

"imageUri": "A String", # Optional. The public URI to an image file.

2515

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2516

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

2522

"buttons": [ # Optional. The collection of card buttons.

2523

{ # The button object that appears at the bottom of a card.

2524

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2525

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2526

},

2527

"title": "A String", # Required. The title of the button.

2528

},

2529

],

2530

"title": "A String", # Optional. The title of the card.

2531

"image": { # The image response message. # Optional. The image for the card.

2532

"imageUri": "A String", # Optional. The public URI to an image file.

2533

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2534

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2535

},

2536

"subtitle": "A String", # Optional. The subtitle of the card.

2537

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2538

},

2539

"image": { # The image response message. # Displays an image.

2540

"imageUri": "A String", # Optional. The public URI to an image file.

2541

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2542

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2543

},

2544

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

2545

#

2546

# Rich cards allow you to respond to users with more vivid content, e.g.

2547

# with media and suggestions.

2548

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2549

# If you want to show a single card with more control over the layout,

2550

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2551

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2552

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

2553

# 2 cards and at most 10.

2554

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2555

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2556

# be set. Media (image, GIF or a video) to include in the card.

2557

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2574

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2575

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2576

# For a standalone card with horizontal layout, height is not

2577

# customizable, and this field is ignored.

2578

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2579

# determines the MIME type of the file from the content-type field in

2580

# the HTTP headers when the platform fetches the file. The content-type

2581

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2582

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2583

# provide a thumbnail URI, the RBM platform displays a blank

2584

# placeholder thumbnail until the user's device downloads the file.

2585

# Depending on the user's setting, the file may not download

2586

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2587

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2588

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2589

#

2590

# At least one of the title, description or media must be set.

2591

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2592

#

2593

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2594

"suggestions": [ # Optional. List of suggestions to include in the card.

2595

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2596

# easily select/click a predefined response or perform an action (like

2597

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2598

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2599

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2600

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2601

# If the user has an app installed that is

2602

# registered as the default handler for the URL, then this app will be

2603

# opened instead, and its icon will be used in the suggested action UI.

2604

"uri": "A String", # Required. The uri to open on the user device

2605

},

2606

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2607

# to send back to the agent.

2608

},

2609

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2610

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2611

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2612

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2613

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2614

# format. An example of a correctly formatted phone number:

2615

# +15556767888.

2616

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2617

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2618

# when the user taps the suggested action. This data will be also

2619

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2620

},

2621

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2622

# instead of typing in their own response.

2623

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2624

# when the user taps the suggested reply. This data will be also

2625

# forwarded to webhook to allow performing custom business logic.

2626

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2627

},

2628

},

2629

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2630

},

2631

],

2632

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2633

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2634

"buttons": [ # Optional. List of buttons for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2635

{ # The button object that appears at the bottom of a card.

2636

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2637

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2638

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2639

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2640

},

2641

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2642

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2643

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2644

"imageUri": "A String", # Optional. The public URI to an image file.

2645

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2646

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2647

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2648

"rows": [ # Optional. Rows in this table of data.

2649

{ # Row of TableCard.

2650

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2651

"cells": [ # Optional. List of cells that make up this row.

2652

{ # Cell of TableCardRow.

2653

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2658

"title": "A String", # Required. Title of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2659

"columnProperties": [ # Optional. Display properties for the columns in this table.

2660

{ # Column properties for TableCard.

2661

"header": "A String", # Required. Column heading.

2662

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2663

},

2664

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2665

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2666

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

2667

#

2668

# RBM allows businesses to send enriched and branded versions of SMS. See

2669

# https://jibe.google.com/business-messaging.

2670

"text": "A String", # Required. Text sent and displayed to the user.

2671

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2672

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2673

# easily select/click a predefined response or perform an action (like

2674

# opening a web uri).

2675

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2676

# can choose from the card.

2677

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2678

# If the user has an app installed that is

2679

# registered as the default handler for the URL, then this app will be

2680

# opened instead, and its icon will be used in the suggested action UI.

2681

"uri": "A String", # Required. The uri to open on the user device

2682

},

2683

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2684

# to send back to the agent.

2685

},

2686

"text": "A String", # Text to display alongside the action.

2687

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2688

# but does not dial automatically.

2689

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2690

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2691

# format. An example of a correctly formatted phone number:

2692

# +15556767888.

2693

},

2694

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2695

# when the user taps the suggested action. This data will be also

2696

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2697

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2698

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2699

# instead of typing in their own response.

2700

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2701

# when the user taps the suggested reply. This data will be also

2702

# forwarded to webhook to allow performing custom business logic.

2703

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2704

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2705

},

2706

],

2707

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2708

"payload": { # A custom platform-specific response.

2709

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2710

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2711

"text": { # The text response message. # Returns a text response.

2712

"text": [ # Optional. The collection of the agent's responses.

2713

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2714

],

2715

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2716

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2717

#

2718

# Rich cards allow you to respond to users with more vivid content, e.g.

2719

# with media and suggestions.

2720

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2721

# You can group multiple rich cards into one using RbmCarouselCard but

2722

# carousel cards will give you less control over the card layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2723

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2724

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2725

# be set. Media (image, GIF or a video) to include in the card.

2726

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2743

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2744

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2745

# For a standalone card with horizontal layout, height is not

2746

# customizable, and this field is ignored.

2747

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2748

# determines the MIME type of the file from the content-type field in

2749

# the HTTP headers when the platform fetches the file. The content-type

2750

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2751

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2752

# provide a thumbnail URI, the RBM platform displays a blank

2753

# placeholder thumbnail until the user's device downloads the file.

2754

# Depending on the user's setting, the file may not download

2755

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2756

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2757

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2758

#

2759

# At least one of the title, description or media must be set.

2760

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2761

#

2762

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2763

"suggestions": [ # Optional. List of suggestions to include in the card.

2764

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2765

# easily select/click a predefined response or perform an action (like

2766

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2767

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2768

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2769

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2770

# If the user has an app installed that is

2771

# registered as the default handler for the URL, then this app will be

2772

# opened instead, and its icon will be used in the suggested action UI.

2773

"uri": "A String", # Required. The uri to open on the user device

2774

},

2775

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2776

# to send back to the agent.

2777

},

2778

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2779

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2780

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2781

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2782

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2783

# format. An example of a correctly formatted phone number:

2784

# +15556767888.

2785

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2786

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2787

# when the user taps the suggested action. This data will be also

2788

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2789

},

2790

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2791

# instead of typing in their own response.

2792

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2793

# when the user taps the suggested reply. This data will be also

2794

# forwarded to webhook to allow performing custom business logic.

2795

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2796

},

2797

},

2798

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2799

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2800

"cardOrientation": "A String", # Required. Orientation of the card.

2801

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2802

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2803

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2804

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2805

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

2806

# play, e.g., "gs://bucket/object". The object must contain a single

2807

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

2808

#

2809

# This object must be readable by the `service-<Project

2810

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

2811

# where <Project Number> is the number of the Telephony Gateway project

2812

# (usually the same as the Dialogflow agent project). If the Google Cloud

2813

# Storage bucket is in the Telephony Gateway project, this permission is

2814

# added by default when enabling the Dialogflow V2 API.

2815

#

2816

# For audio from other sources, consider using the

2817

# `TelephonySynthesizeSpeech` message with SSML.

2818

},

2819

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2820

"items": [ # Required. Carousel items.

2821

{ # An item in the carousel.

2822

"image": { # The image response message. # Optional. The image to display.

2823

"imageUri": "A String", # Optional. The public URI to an image file.

2824

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2825

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2826

},

2827

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2828

# dialog.

2829

"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

2834

# response is given.

2835

},

2836

"title": "A String", # Required. Title of the carousel item.

2837

"description": "A String", # Optional. The body text of the card.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

2842

# This message in `QueryResult.fulfillment_messages` and

2843

# `WebhookResponse.fulfillment_messages` should contain only one

2844

# `SimpleResponse`.

2845

"simpleResponses": [ # Required. The list of simple responses.

2846

{ # The simple response message containing speech or text.

2847

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2848

# response to the user in the SSML format. Mutually exclusive with

2849

# text_to_speech.

2850

"displayText": "A String", # Optional. The text to display.

2851

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2852

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2857

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2858

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2859

# items.

2860

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2861

# items, maximum of ten.

2862

{ # Browsing carousel tile

2863

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2864

# Card. Maximum of one line of text.

2865

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2866

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2867

# text.

2868

"image": { # The image response message. # Optional. Hero image for the carousel item.

2869

"imageUri": "A String", # Optional. The public URI to an image file.

2870

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2871

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2872

},

2873

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2874

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2875

# the URL. Defaults to opening via web browser.

2876

"url": "A String", # Required. URL

2877

},

2878

},

2879

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2880

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2881

},

2882

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2883

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

2884

# chain of followup intents. You can set this field when creating an intent,

2885

# for example with CreateIntent or

2886

# BatchUpdateIntents, in order to make this

2887

# intent a followup intent.

2888

#

2889

# It identifies the parent followup intent.

2890

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2891

"parameters": [ # Optional. The collection of parameters associated with the intent.

2892

{ # Represents intent parameters.

2893

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

2894

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

2895

# whether the intent cannot be completed without collecting the parameter

2896

# value.

2897

"prompts": [ # Optional. The collection of prompts that the agent can present to the

2898

# user in order to collect a value for the parameter.

2899

"A String",

2900

],

2901

"name": "A String", # The unique identifier of this parameter.

2902

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

2903

# describes values of the parameter. If the parameter is

2904

# required, this must be provided.

2905

"displayName": "A String", # Required. The name of the parameter.

2906

"value": "A String", # Optional. The definition of the parameter value. It can be:

2907

#

2908

# - a constant string,

2909

# - a parameter value defined as `$parameter_name`,

2910

# - an original parameter value defined as `$parameter_name.original`,

2911

# - a parameter value from some context defined as

2912

# `#context_name.parameter_name`.

2913

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

2914

# result.

2915

# Default values can be extracted from contexts by using the following

2916

# syntax: `#context_name.parameter_name`.

2917

},

2918

],

2919

"events": [ # Optional. The collection of event names that trigger the intent.

2920

# If the collection of input contexts is not empty, all of the contexts must

2921

# be present in the active user session for an event to trigger this intent.

2922

# Event names are limited to 150 characters.

2923

"A String",

2924

],

2925

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2926

"name": "A String", # Optional. The unique identifier of this intent.

2927

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2928

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2929

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2930

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

2931

# Note: If `ml_enabled` setting is set to false, then this intent is not

2932

# taken into account during inference in `ML ONLY` match mode. Also,

2933

# auto-markup in the UI is turned off.

2934

# DEPRECATED! Please use `ml_disabled` field instead.

2935

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

2936

# then the default value is determined as follows:

2937

# - Before April 15th, 2018 the default is:

2938

# ml_enabled = false / ml_disabled = true.

2939

# - After April 15th, 2018 the default is:

2940

# ml_enabled = true / ml_disabled = false.

2941

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

2942

# a direct or indirect parent. We populate this field only in the output.

2943

{ # Represents a single followup intent in the chain.

2944

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2945

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2946

"followupIntentName": "A String", # The unique identifier of the followup intent.

2947

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2948

},

2949

],

2950

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2951

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2952

"A String",

2953

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2954

"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]

2955

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2956

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2957

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2958

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2959

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

2960

# priorities.

2961

#

2962

# - If the supplied value is unspecified or 0, the service

2963

# translates the value to 500,000, which corresponds to the

2964

# `Normal` priority in the console.

2965

# - If the supplied value is negative, the intent is ignored

2966

# in runtime detect intent requests.

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>

2972

<pre>Deletes the specified intent and its direct or indirect followup intents.

2973

2974

Args:

2975

name: string, Required. The name of the intent to delete. If this intent has direct or

2976

indirect followup intents, we also delete them.

2977

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2978

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2979

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2986

2987

{ # A generic empty message that you can re-use to avoid defining duplicated

2988

# empty messages in your APIs. A typical example is to use it as the request

2989

# or the response type of an API method. For instance:

2990

#

2991

# service Foo {

2992

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

2993

# }

2994

#

2995

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3000

<code class="details" id="get">get(name, languageCode=None, intentView=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3001

<pre>Retrieves the specified intent.

3002

3003

Args:

3004

name: string, Required. The name of the intent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3005

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

3006

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3007

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3008

For more information, see

3009

[Multilingual intent and entity

3010

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3011

intentView: string, Optional. The resource view to apply to the returned intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3012

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3019

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3020

{ # An intent categorizes an end-user's intention for one conversation turn. For

3021

# each agent, you define many intents, where your combined intents can handle a

3022

# complete conversation. When an end-user writes or says something, referred to

3023

# as an end-user expression or end-user input, Dialogflow matches the end-user

3024

# input to the best intent in your agent. Matching an intent is also known as

3025

# intent classification.

3026

#

3027

# For more information, see the [intent

3028

# guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

3030

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

3031

# to close interaction with an end user. Default is false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3032

"action": "A String", # Optional. The name of the action associated with the intent.

3033

# Note: The action name must not contain whitespaces.

3034

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3035

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3036

# is matched. Context messages in this collection should not set the

3037

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3038

# when the intent is matched.

3039

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3040

{ # Dialogflow contexts are similar to natural language context. If a person says

3041

# to you "they are orange", you need context in order to understand what "they"

3042

# is referring to. Similarly, for Dialogflow to handle an end-user expression

3043

# like that, it needs to be provided with context in order to correctly match

3044

# an intent.

3045

#

3046

# Using contexts, you can control the flow of a conversation. You can configure

3047

# contexts for an intent by setting input and output contexts, which are

3048

# identified by string names. When an intent is matched, any configured output

3049

# contexts for that intent become active. While any contexts are active,

3050

# Dialogflow is more likely to match intents that are configured with input

3051

# contexts that correspond to the currently active contexts.

3052

#

3053

# For more information about context, see the

3054

# [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

3055

"parameters": { # Optional. The collection of parameters associated with this context.

3056

#

3057

# Depending on your protocol or client library language, this is a

3058

# map, associative array, symbol table, dictionary, or JSON object

3059

# composed of a collection of (MapKey, MapValue) pairs:

3060

#

3061

# - MapKey type: string

3062

# - MapKey value: parameter name

3063

# - MapValue type:

3064

# - If parameter's entity type is a composite entity: map

3065

# - Else: string or number, depending on parameter value type

3066

# - MapValue value:

3067

# - If parameter's entity type is a composite entity:

3068

# map from composite entity property names to property values

3069

# - Else: parameter value

3070

"a_key": "", # Properties of the object.

3071

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3072

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3073

# context expires. The default is `0`. If set to `0`, the context expires

3074

# immediately. Contexts expire automatically after 20 minutes if there

3075

# are no matching queries.

3076

"name": "A String", # Required. The unique identifier of the context. Format:

3077

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3078

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3079

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3080

#

3081

# The `Context ID` is always converted to lowercase, may only contain

3082

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3083

#

3084

# If `Environment ID` is not specified, we assume default 'draft'

3085

# environment. If `User ID` is not specified, we assume default '-' user.

3086

#

3087

# The following context names are reserved for internal use by Dialogflow.

3088

# You should not use these contexts or create contexts with these names:

3089

#

3090

# * `__system_counters__`

3091

# * `*_id_dialog_context`

3092

# * `*_dialog_params_size`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3093

},

3094

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3095

"displayName": "A String", # Required. The name of this intent.

3096

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

3097

# session when this intent is matched.

3098

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

3099

# Note: If `ml_disabled` setting is set to true, then this intent is not

3100

# taken into account during inference in `ML ONLY` match mode. Also,

3101

# auto-markup in the UI is turned off.

3102

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

3103

# followup intents. It identifies the correct followup intents chain for

3104

# this intent.

3105

#

3106

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3107

"trainingPhrases": [ # Optional. The collection of examples that the agent is

3108

# trained on.

3109

{ # Represents an example that the agent is trained on.

3110

"type": "A String", # Required. The type of the training phrase.

3111

"name": "A String", # Output only. The unique identifier of this training phrase.

3112

"parts": [ # Required. The ordered list of training phrase parts.

3113

# The parts are concatenated in order to form the training phrase.

3114

#

3115

# Note: The API does not automatically annotate training phrases like the

3116

# Dialogflow Console does.

3117

#

3118

# Note: Do not forget to include whitespace at part boundaries,

3119

# so the training phrase is well formatted when the parts are concatenated.

3120

#

3121

# If the training phrase does not need to be annotated with parameters,

3122

# you just need a single part with only the Part.text field set.

3123

#

3124

# If you want to annotate the training phrase, you must create multiple

3125

# parts, where the fields of each part are populated in one of two ways:

3126

#

3127

# - `Part.text` is set to a part of the phrase that has no parameters.

3128

# - `Part.text` is set to a part of the phrase that you want to annotate,

3129

# and the `entity_type`, `alias`, and `user_defined` fields are all

3130

# set.

3131

{ # Represents a part of a training phrase.

3132

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

3133

# This field is set to true when the Dialogflow Console is used to

3134

# manually annotate the part. When creating an annotated part with the

3135

# API, you must set this to true.

3136

"alias": "A String", # Optional. The parameter name for the value extracted from the

3137

# annotated part of the example.

3138

# This field is required for annotated parts of the training phrase.

3139

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3140

# This field is required for annotated parts of the training phrase.

3141

"text": "A String", # Required. The text for this part.

3142

},

3143

],

3144

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

3145

# the intent. Each time a developer adds an existing sample by editing an

3146

# intent or training, this counter is increased.

3147

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3148

],

3149

"messages": [ # Optional. The collection of rich messages corresponding to the

3150

# `Response` field in the Dialogflow console.

3151

{ # Corresponds to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3152

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

3153

"suggestions": [ # Required. The list of suggested replies.

3154

{ # The suggestion chip message that the user can tap to quickly post a reply

3155

# to the conversation.

3156

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

3161

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

3162

"mediaObjects": [ # Required. List of media objects.

3163

{ # Response media object for media content card.

3164

"description": "A String", # Optional. Description of media card.

3165

"icon": { # The image response message. # Optional. Icon to display above media content.

3166

"imageUri": "A String", # Optional. The public URI to an image file.

3167

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3168

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3169

},

3170

"contentUrl": "A String", # Required. Url where the media is stored.

3171

"name": "A String", # Required. Name of media card.

3172

"largeImage": { # The image response message. # Optional. Image to display above media content.

3173

"imageUri": "A String", # Optional. The public URI to an image file.

3174

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3175

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

3181

"phoneNumber": "A String", # Required. The phone number to transfer the call to

3182

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

3183

#

3184

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

3185

},

3186

"platform": "A String", # Optional. The platform that this message is intended for.

3187

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

3188

# Telephony Gateway.

3189

#

3190

# Telephony Gateway takes the synthesizer settings from

3191

# `DetectIntentResponse.output_audio_config` which can either be set

3192

# at request-level or can come from the agent-level synthesizer config.

3193

"text": "A String", # The raw text to be synthesized.

3194

"ssml": "A String", # The SSML to be synthesized. For more information, see

3195

# [SSML](https://developers.google.com/actions/reference/ssml).

3196

},

3197

"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.

3198

# or website associated with this agent.

3199

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

3200

# suggestion chip.

3201

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

3202

},

3203

"quickReplies": { # The quick replies response message. # Displays quick replies.

3204

"quickReplies": [ # Optional. The collection of quick replies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3205

"A String",

3206

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3207

"title": "A String", # Optional. The title of the collection of quick replies.

3208

},

3209

"card": { # The card response message. # Displays a card.

3210

"subtitle": "A String", # Optional. The subtitle of the card.

3211

"buttons": [ # Optional. The collection of card buttons.

3212

{ # Optional. Contains information about a button.

3213

"text": "A String", # Optional. The text to show on the button.

3214

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

3219

"title": "A String", # Optional. The title of the card.

3220

},

3221

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

3222

"subtitle": "A String", # Optional. Subtitle of the list.

3223

"title": "A String", # Optional. The overall title of the list.

3224

"items": [ # Required. List items.

3225

{ # An item in the list.

3226

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3227

# dialog.

3228

"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

3233

# response is given.

3234

},

3235

"description": "A String", # Optional. The main text describing the item.

3236

"title": "A String", # Required. The title of the list item.

3237

"image": { # The image response message. # Optional. The image to display.

3238

"imageUri": "A String", # Optional. The public URI to an image file.

3239

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3240

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

3246

"buttons": [ # Optional. The collection of card buttons.

3247

{ # The button object that appears at the bottom of a card.

3248

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3249

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

3250

},

3251

"title": "A String", # Required. The title of the button.

3252

},

3253

],

3254

"title": "A String", # Optional. The title of the card.

3255

"image": { # The image response message. # Optional. The image for the card.

3256

"imageUri": "A String", # Optional. The public URI to an image file.

3257

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3258

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3259

},

3260

"subtitle": "A String", # Optional. The subtitle of the card.

3261

"formattedText": "A String", # Required, unless image is present. The body text of the card.

3262

},

3263

"image": { # The image response message. # Displays an image.

3264

"imageUri": "A String", # Optional. The public URI to an image file.

3265

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3266

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3267

},

3268

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

3269

#

3270

# Rich cards allow you to respond to users with more vivid content, e.g.

3271

# with media and suggestions.

3272

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3273

# If you want to show a single card with more control over the layout,

3274

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3275

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3276

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

3277

# 2 cards and at most 10.

3278

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3279

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3280

# be set. Media (image, GIF or a video) to include in the card.

3281

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3298

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3299

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3300

# For a standalone card with horizontal layout, height is not

3301

# customizable, and this field is ignored.

3302

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

3303

# determines the MIME type of the file from the content-type field in

3304

# the HTTP headers when the platform fetches the file. The content-type

3305

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3306

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

3307

# provide a thumbnail URI, the RBM platform displays a blank

3308

# placeholder thumbnail until the user's device downloads the file.

3309

# Depending on the user's setting, the file may not download

3310

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3311

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3312

"title": "A String", # Optional. Title of the card (at most 200 bytes).

3313

#

3314

# At least one of the title, description or media must be set.

3315

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

3316

#

3317

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3318

"suggestions": [ # Optional. List of suggestions to include in the card.

3319

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3320

# easily select/click a predefined response or perform an action (like

3321

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3322

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3323

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3324

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3325

# If the user has an app installed that is

3326

# registered as the default handler for the URL, then this app will be

3327

# opened instead, and its icon will be used in the suggested action UI.

3328

"uri": "A String", # Required. The uri to open on the user device

3329

},

3330

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3331

# to send back to the agent.

3332

},

3333

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3334

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3335

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3336

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3337

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3338

# format. An example of a correctly formatted phone number:

3339

# +15556767888.

3340

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3341

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3342

# when the user taps the suggested action. This data will be also

3343

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3344

},

3345

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3346

# instead of typing in their own response.

3347

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3348

# when the user taps the suggested reply. This data will be also

3349

# forwarded to webhook to allow performing custom business logic.

3350

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3351

},

3352

},

3353

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3354

},

3355

],

3356

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3357

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

3358

"buttons": [ # Optional. List of buttons for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3359

{ # The button object that appears at the bottom of a card.

3360

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3361

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

3362

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3363

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3364

},

3365

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3366

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3367

"image": { # The image response message. # Optional. Image which should be displayed on the card.

3368

"imageUri": "A String", # Optional. The public URI to an image file.

3369

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3370

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3371

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3372

"rows": [ # Optional. Rows in this table of data.

3373

{ # Row of TableCard.

3374

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

3375

"cells": [ # Optional. List of cells that make up this row.

3376

{ # Cell of TableCardRow.

3377

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3382

"title": "A String", # Required. Title of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3383

"columnProperties": [ # Optional. Display properties for the columns in this table.

3384

{ # Column properties for TableCard.

3385

"header": "A String", # Required. Column heading.

3386

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

3387

},

3388

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3389

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3390

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

3391

#

3392

# RBM allows businesses to send enriched and branded versions of SMS. See

3393

# https://jibe.google.com/business-messaging.

3394

"text": "A String", # Required. Text sent and displayed to the user.

3395

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

3396

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3397

# easily select/click a predefined response or perform an action (like

3398

# opening a web uri).

3399

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3400

# can choose from the card.

3401

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3402

# If the user has an app installed that is

3403

# registered as the default handler for the URL, then this app will be

3404

# opened instead, and its icon will be used in the suggested action UI.

3405

"uri": "A String", # Required. The uri to open on the user device

3406

},

3407

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3408

# to send back to the agent.

3409

},

3410

"text": "A String", # Text to display alongside the action.

3411

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

3412

# but does not dial automatically.

3413

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3414

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3415

# format. An example of a correctly formatted phone number:

3416

# +15556767888.

3417

},

3418

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3419

# when the user taps the suggested action. This data will be also

3420

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3421

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3422

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3423

# instead of typing in their own response.

3424

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3425

# when the user taps the suggested reply. This data will be also

3426

# forwarded to webhook to allow performing custom business logic.

3427

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3428

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3429

},

3430

],

3431

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3432

"payload": { # A custom platform-specific response.

3433

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3434

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3435

"text": { # The text response message. # Returns a text response.

3436

"text": [ # Optional. The collection of the agent's responses.

3437

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3438

],

3439

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3440

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

3441

#

3442

# Rich cards allow you to respond to users with more vivid content, e.g.

3443

# with media and suggestions.

3444

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3445

# You can group multiple rich cards into one using RbmCarouselCard but

3446

# carousel cards will give you less control over the card layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3447

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3448

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3449

# be set. Media (image, GIF or a video) to include in the card.

3450

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3467

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3468

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3469

# For a standalone card with horizontal layout, height is not

3470

# customizable, and this field is ignored.

3471

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

3472

# determines the MIME type of the file from the content-type field in

3473

# the HTTP headers when the platform fetches the file. The content-type

3474

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3475

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

3476

# provide a thumbnail URI, the RBM platform displays a blank

3477

# placeholder thumbnail until the user's device downloads the file.

3478

# Depending on the user's setting, the file may not download

3479

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3480

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3481

"title": "A String", # Optional. Title of the card (at most 200 bytes).

3482

#

3483

# At least one of the title, description or media must be set.

3484

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

3485

#

3486

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3487

"suggestions": [ # Optional. List of suggestions to include in the card.

3488

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

3489

# easily select/click a predefined response or perform an action (like

3490

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3491

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

3492

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3493

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

3494

# If the user has an app installed that is

3495

# registered as the default handler for the URL, then this app will be

3496

# opened instead, and its icon will be used in the suggested action UI.

3497

"uri": "A String", # Required. The uri to open on the user device

3498

},

3499

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

3500

# to send back to the agent.

3501

},

3502

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3503

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3504

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3505

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

3506

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

3507

# format. An example of a correctly formatted phone number:

3508

# +15556767888.

3509

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3510

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3511

# when the user taps the suggested action. This data will be also

3512

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3513

},

3514

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3515

# instead of typing in their own response.

3516

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3517

# when the user taps the suggested reply. This data will be also

3518

# forwarded to webhook to allow performing custom business logic.

3519

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3520

},

3521

},

3522

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3523

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3524

"cardOrientation": "A String", # Required. Orientation of the card.

3525

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

3526

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3527

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3528

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

3529

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

3530

# play, e.g., "gs://bucket/object". The object must contain a single

3531

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

3532

#

3533

# This object must be readable by the `service-<Project

3534

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

3535

# where <Project Number> is the number of the Telephony Gateway project

3536

# (usually the same as the Dialogflow agent project). If the Google Cloud

3537

# Storage bucket is in the Telephony Gateway project, this permission is

3538

# added by default when enabling the Dialogflow V2 API.

3539

#

3540

# For audio from other sources, consider using the

3541

# `TelephonySynthesizeSpeech` message with SSML.

3542

},

3543

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

3544

"items": [ # Required. Carousel items.

3545

{ # An item in the carousel.

3546

"image": { # The image response message. # Optional. The image to display.

3547

"imageUri": "A String", # Optional. The public URI to an image file.

3548

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3549

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3550

},

3551

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

3552

# dialog.

3553

"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

3558

# response is given.

3559

},

3560

"title": "A String", # Required. Title of the carousel item.

3561

"description": "A String", # Optional. The body text of the card.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

3566

# This message in `QueryResult.fulfillment_messages` and

3567

# `WebhookResponse.fulfillment_messages` should contain only one

3568

# `SimpleResponse`.

3569

"simpleResponses": [ # Required. The list of simple responses.

3570

{ # The simple response message containing speech or text.

3571

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

3572

# response to the user in the SSML format. Mutually exclusive with

3573

# text_to_speech.

3574

"displayText": "A String", # Optional. The text to display.

3575

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

3576

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

3581

# https://developers.google.com/actions/assistant/responses#browsing_carousel

3582

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

3583

# items.

3584

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

3585

# items, maximum of ten.

3586

{ # Browsing carousel tile

3587

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

3588

# Card. Maximum of one line of text.

3589

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

3590

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

3591

# text.

3592

"image": { # The image response message. # Optional. Hero image for the carousel item.

3593

"imageUri": "A String", # Optional. The public URI to an image file.

3594

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3595

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3596

},

3597

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

3598

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

3599

# the URL. Defaults to opening via web browser.

3600

"url": "A String", # Required. URL

3601

},

3602

},

3603

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3604

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3605

},

3606

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3607

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

3608

# chain of followup intents. You can set this field when creating an intent,

3609

# for example with CreateIntent or

3610

# BatchUpdateIntents, in order to make this

3611

# intent a followup intent.

3612

#

3613

# It identifies the parent followup intent.

3614

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3615

"parameters": [ # Optional. The collection of parameters associated with the intent.

3616

{ # Represents intent parameters.

3617

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

3618

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3619

# whether the intent cannot be completed without collecting the parameter

3620

# value.

3621

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3622

# user in order to collect a value for the parameter.

3623

"A String",

3624

],

3625

"name": "A String", # The unique identifier of this parameter.

3626

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3627

# describes values of the parameter. If the parameter is

3628

# required, this must be provided.

3629

"displayName": "A String", # Required. The name of the parameter.

3630

"value": "A String", # Optional. The definition of the parameter value. It can be:

3631

#

3632

# - a constant string,

3633

# - a parameter value defined as `$parameter_name`,

3634

# - an original parameter value defined as `$parameter_name.original`,

3635

# - a parameter value from some context defined as

3636

# `#context_name.parameter_name`.

3637

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3638

# result.

3639

# Default values can be extracted from contexts by using the following

3640

# syntax: `#context_name.parameter_name`.

3641

},

3642

],

3643

"events": [ # Optional. The collection of event names that trigger the intent.

3644

# If the collection of input contexts is not empty, all of the contexts must

3645

# be present in the active user session for an event to trigger this intent.

3646

# Event names are limited to 150 characters.

3647

"A String",

3648

],

3649

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3650

"name": "A String", # Optional. The unique identifier of this intent.

3651

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

3652

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3653

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3654

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

3655

# Note: If `ml_enabled` setting is set to false, then this intent is not

3656

# taken into account during inference in `ML ONLY` match mode. Also,

3657

# auto-markup in the UI is turned off.

3658

# DEPRECATED! Please use `ml_disabled` field instead.

3659

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

3660

# then the default value is determined as follows:

3661

# - Before April 15th, 2018 the default is:

3662

# ml_enabled = false / ml_disabled = true.

3663

# - After April 15th, 2018 the default is:

3664

# ml_enabled = true / ml_disabled = false.

3665

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

3666

# a direct or indirect parent. We populate this field only in the output.

3667

{ # Represents a single followup intent in the chain.

3668

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

3669

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3670

"followupIntentName": "A String", # The unique identifier of the followup intent.

3671

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3672

},

3673

],

3674

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3675

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3676

"A String",

3677

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3678

"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]

3679

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3680

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3681

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3682

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3683

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

3684

# priorities.

3685

#

3686

# - If the supplied value is unspecified or 0, the service

3687

# translates the value to 500,000, which corresponds to the

3688

# `Normal` priority in the console.

3689

# - If the supplied value is negative, the intent is ignored

3690

# in runtime detect intent requests.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3695

<code class="details" id="list">list(parent, pageToken=None, languageCode=None, intentView=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3696

<pre>Returns the list of all intents in the specified agent.

3697

3698

Args:

3699

parent: string, Required. The agent to list all intents from.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3700

Format: `projects/<Project ID>/agent`. (required)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3701

pageToken: string, Optional. The next_page_token value returned from a previous list request.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3702

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3703

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3704

For more information, see

3705

[Multilingual intent and entity

3706

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3707

intentView: string, Optional. The resource view to apply to the returned intent.

3708

pageSize: integer, Optional. The maximum number of items to return in a single page. By

3709

default 100 and at most 1000.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3710

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3717

3718

{ # The response message for Intents.ListIntents.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3719

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

3720

# more results in the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3721

"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]

3722

# returned based on the page_size field in the request.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3723

{ # An intent categorizes an end-user's intention for one conversation turn. For

3724

# each agent, you define many intents, where your combined intents can handle a

3725

# complete conversation. When an end-user writes or says something, referred to

3726

# as an end-user expression or end-user input, Dialogflow matches the end-user

3727

# input to the best intent in your agent. Matching an intent is also known as

3728

# intent classification.

3729

#

3730

# For more information, see the [intent

3731

# guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3732

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

3733

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

3734

# to close interaction with an end user. Default is false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3735

"action": "A String", # Optional. The name of the action associated with the intent.

3736

# Note: The action name must not contain whitespaces.

3737

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3738

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

3739

# is matched. Context messages in this collection should not set the

3740

# parameters field. Setting the `lifespan_count` to 0 will reset the context

3741

# when the intent is matched.

3742

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3743

{ # Dialogflow contexts are similar to natural language context. If a person says

3744

# to you "they are orange", you need context in order to understand what "they"

3745

# is referring to. Similarly, for Dialogflow to handle an end-user expression

3746

# like that, it needs to be provided with context in order to correctly match

3747

# an intent.

3748

#

3749

# Using contexts, you can control the flow of a conversation. You can configure

3750

# contexts for an intent by setting input and output contexts, which are

3751

# identified by string names. When an intent is matched, any configured output

3752

# contexts for that intent become active. While any contexts are active,

3753

# Dialogflow is more likely to match intents that are configured with input

3754

# contexts that correspond to the currently active contexts.

3755

#

3756

# For more information about context, see the

3757

# [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

3758

"parameters": { # Optional. The collection of parameters associated with this context.

3759

#

3760

# Depending on your protocol or client library language, this is a

3761

# map, associative array, symbol table, dictionary, or JSON object

3762

# composed of a collection of (MapKey, MapValue) pairs:

3763

#

3764

# - MapKey type: string

3765

# - MapKey value: parameter name

3766

# - MapValue type:

3767

# - If parameter's entity type is a composite entity: map

3768

# - Else: string or number, depending on parameter value type

3769

# - MapValue value:

3770

# - If parameter's entity type is a composite entity:

3771

# map from composite entity property names to property values

3772

# - Else: parameter value

3773

"a_key": "", # Properties of the object.

3774

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3775

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

3776

# context expires. The default is `0`. If set to `0`, the context expires

3777

# immediately. Contexts expire automatically after 20 minutes if there

3778

# are no matching queries.

3779

"name": "A String", # Required. The unique identifier of the context. Format:

3780

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

3781

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

3782

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

3783

#

3784

# The `Context ID` is always converted to lowercase, may only contain

3785

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

3786

#

3787

# If `Environment ID` is not specified, we assume default 'draft'

3788

# environment. If `User ID` is not specified, we assume default '-' user.

3789

#

3790

# The following context names are reserved for internal use by Dialogflow.

3791

# You should not use these contexts or create contexts with these names:

3792

#

3793

# * `__system_counters__`

3794

# * `*_id_dialog_context`

3795

# * `*_dialog_params_size`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3796

},

3797

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3798

"displayName": "A String", # Required. The name of this intent.

3799

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

3800

# session when this intent is matched.

3801

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

3802

# Note: If `ml_disabled` setting is set to true, then this intent is not

3803

# taken into account during inference in `ML ONLY` match mode. Also,

3804

# auto-markup in the UI is turned off.

3805

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

3806

# followup intents. It identifies the correct followup intents chain for

3807

# this intent.

3808

#

3809

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3810

"trainingPhrases": [ # Optional. The collection of examples that the agent is

3811

# trained on.

3812

{ # Represents an example that the agent is trained on.

3813

"type": "A String", # Required. The type of the training phrase.

3814

"name": "A String", # Output only. The unique identifier of this training phrase.

3815

"parts": [ # Required. The ordered list of training phrase parts.

3816

# The parts are concatenated in order to form the training phrase.

3817

#

3818

# Note: The API does not automatically annotate training phrases like the

3819

# Dialogflow Console does.

3820

#

3821

# Note: Do not forget to include whitespace at part boundaries,

3822

# so the training phrase is well formatted when the parts are concatenated.

3823

#

3824

# If the training phrase does not need to be annotated with parameters,

3825

# you just need a single part with only the Part.text field set.

3826

#

3827

# If you want to annotate the training phrase, you must create multiple

3828

# parts, where the fields of each part are populated in one of two ways:

3829

#

3830

# - `Part.text` is set to a part of the phrase that has no parameters.

3831

# - `Part.text` is set to a part of the phrase that you want to annotate,

3832

# and the `entity_type`, `alias`, and `user_defined` fields are all

3833

# set.

3834

{ # Represents a part of a training phrase.

3835

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

3836

# This field is set to true when the Dialogflow Console is used to

3837

# manually annotate the part. When creating an annotated part with the

3838

# API, you must set this to true.

3839

"alias": "A String", # Optional. The parameter name for the value extracted from the

3840

# annotated part of the example.

3841

# This field is required for annotated parts of the training phrase.

3842

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

3843

# This field is required for annotated parts of the training phrase.

3844

"text": "A String", # Required. The text for this part.

3845

},

3846

],

3847

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

3848

# the intent. Each time a developer adds an existing sample by editing an

3849

# intent or training, this counter is increased.

3850

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3851

],

3852

"messages": [ # Optional. The collection of rich messages corresponding to the

3853

# `Response` field in the Dialogflow console.

3854

{ # Corresponds to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3855

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

3856

"suggestions": [ # Required. The list of suggested replies.

3857

{ # The suggestion chip message that the user can tap to quickly post a reply

3858

# to the conversation.

3859

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

3864

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

3865

"mediaObjects": [ # Required. List of media objects.

3866

{ # Response media object for media content card.

3867

"description": "A String", # Optional. Description of media card.

3868

"icon": { # The image response message. # Optional. Icon to display above media content.

3869

"imageUri": "A String", # Optional. The public URI to an image file.

3870

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3871

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3872

},

3873

"contentUrl": "A String", # Required. Url where the media is stored.

3874

"name": "A String", # Required. Name of media card.

3875

"largeImage": { # The image response message. # Optional. Image to display above media content.

3876

"imageUri": "A String", # Optional. The public URI to an image file.

3877

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3878

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

3884

"phoneNumber": "A String", # Required. The phone number to transfer the call to

3885

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

3886

#

3887

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

3888

},

3889

"platform": "A String", # Optional. The platform that this message is intended for.

3890

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

3891

# Telephony Gateway.

3892

#

3893

# Telephony Gateway takes the synthesizer settings from

3894

# `DetectIntentResponse.output_audio_config` which can either be set

3895

# at request-level or can come from the agent-level synthesizer config.

3896

"text": "A String", # The raw text to be synthesized.

3897

"ssml": "A String", # The SSML to be synthesized. For more information, see

3898

# [SSML](https://developers.google.com/actions/reference/ssml).

3899

},

3900

"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.

3901

# or website associated with this agent.

3902

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

3903

# suggestion chip.

3904

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

3905

},

3906

"quickReplies": { # The quick replies response message. # Displays quick replies.

3907

"quickReplies": [ # Optional. The collection of quick replies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3908

"A String",

3909

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3910

"title": "A String", # Optional. The title of the collection of quick replies.

3911

},

3912

"card": { # The card response message. # Displays a card.

3913

"subtitle": "A String", # Optional. The subtitle of the card.

3914

"buttons": [ # Optional. The collection of card buttons.

3915

{ # Optional. Contains information about a button.

3916

"text": "A String", # Optional. The text to show on the button.

3917

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

3922

"title": "A String", # Optional. The title of the card.

3923

},

3924

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

3925

"subtitle": "A String", # Optional. Subtitle of the list.

3926

"title": "A String", # Optional. The overall title of the list.

3927

"items": [ # Required. List items.

3928

{ # An item in the list.

3929

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

3930

# dialog.

3931

"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

3936

# response is given.

3937

},

3938

"description": "A String", # Optional. The main text describing the item.

3939

"title": "A String", # Required. The title of the list item.

3940

"image": { # The image response message. # Optional. The image to display.

3941

"imageUri": "A String", # Optional. The public URI to an image file.

3942

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3943

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

3949

"buttons": [ # Optional. The collection of card buttons.

3950

{ # The button object that appears at the bottom of a card.

3951

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

3952

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

3953

},

3954

"title": "A String", # Required. The title of the button.

3955

},

3956

],

3957

"title": "A String", # Optional. The title of the card.

3958

"image": { # The image response message. # Optional. The image for the card.

3959

"imageUri": "A String", # Optional. The public URI to an image file.

3960

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3961

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3962

},

3963

"subtitle": "A String", # Optional. The subtitle of the card.

3964

"formattedText": "A String", # Required, unless image is present. The body text of the card.

3965

},

3966

"image": { # The image response message. # Displays an image.

3967

"imageUri": "A String", # Optional. The public URI to an image file.

3968

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3969

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3970

},

3971

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

3972

#

3973

# Rich cards allow you to respond to users with more vivid content, e.g.

3974

# with media and suggestions.

3975

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3976

# If you want to show a single card with more control over the layout,

3977

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3978

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3979

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

3980

# 2 cards and at most 10.

3981

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3982

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

3983

# be set. Media (image, GIF or a video) to include in the card.

3984

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4001

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4002

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4003

# For a standalone card with horizontal layout, height is not

4004

# customizable, and this field is ignored.

4005

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4006

# determines the MIME type of the file from the content-type field in

4007

# the HTTP headers when the platform fetches the file. The content-type

4008

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4009

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

4010

# provide a thumbnail URI, the RBM platform displays a blank

4011

# placeholder thumbnail until the user's device downloads the file.

4012

# Depending on the user's setting, the file may not download

4013

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4014

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4015

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4016

#

4017

# At least one of the title, description or media must be set.

4018

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4019

#

4020

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4021

"suggestions": [ # Optional. List of suggestions to include in the card.

4022

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4023

# easily select/click a predefined response or perform an action (like

4024

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4025

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4026

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4027

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4028

# If the user has an app installed that is

4029

# registered as the default handler for the URL, then this app will be

4030

# opened instead, and its icon will be used in the suggested action UI.

4031

"uri": "A String", # Required. The uri to open on the user device

4032

},

4033

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4034

# to send back to the agent.

4035

},

4036

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4037

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4038

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4039

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4040

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4041

# format. An example of a correctly formatted phone number:

4042

# +15556767888.

4043

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4044

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4045

# when the user taps the suggested action. This data will be also

4046

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4047

},

4048

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4049

# instead of typing in their own response.

4050

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4051

# when the user taps the suggested reply. This data will be also

4052

# forwarded to webhook to allow performing custom business logic.

4053

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4054

},

4055

},

4056

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4057

},

4058

],

4059

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4060

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

4061

"buttons": [ # Optional. List of buttons for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4062

{ # The button object that appears at the bottom of a card.

4063

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4064

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4065

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4066

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4067

},

4068

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4069

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4070

"image": { # The image response message. # Optional. Image which should be displayed on the card.

4071

"imageUri": "A String", # Optional. The public URI to an image file.

4072

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4073

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4074

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4075

"rows": [ # Optional. Rows in this table of data.

4076

{ # Row of TableCard.

4077

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

4078

"cells": [ # Optional. List of cells that make up this row.

4079

{ # Cell of TableCardRow.

4080

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4085

"title": "A String", # Required. Title of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4086

"columnProperties": [ # Optional. Display properties for the columns in this table.

4087

{ # Column properties for TableCard.

4088

"header": "A String", # Required. Column heading.

4089

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

4090

},

4091

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4092

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4093

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

4094

#

4095

# RBM allows businesses to send enriched and branded versions of SMS. See

4096

# https://jibe.google.com/business-messaging.

4097

"text": "A String", # Required. Text sent and displayed to the user.

4098

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

4099

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4100

# easily select/click a predefined response or perform an action (like

4101

# opening a web uri).

4102

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4103

# can choose from the card.

4104

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4105

# If the user has an app installed that is

4106

# registered as the default handler for the URL, then this app will be

4107

# opened instead, and its icon will be used in the suggested action UI.

4108

"uri": "A String", # Required. The uri to open on the user device

4109

},

4110

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4111

# to send back to the agent.

4112

},

4113

"text": "A String", # Text to display alongside the action.

4114

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4115

# but does not dial automatically.

4116

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4117

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4118

# format. An example of a correctly formatted phone number:

4119

# +15556767888.

4120

},

4121

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4122

# when the user taps the suggested action. This data will be also

4123

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4124

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4125

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4126

# instead of typing in their own response.

4127

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4128

# when the user taps the suggested reply. This data will be also

4129

# forwarded to webhook to allow performing custom business logic.

4130

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4131

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4132

},

4133

],

4134

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4135

"payload": { # A custom platform-specific response.

4136

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4137

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4138

"text": { # The text response message. # Returns a text response.

4139

"text": [ # Optional. The collection of the agent's responses.

4140

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4141

],

4142

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4143

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

4144

#

4145

# Rich cards allow you to respond to users with more vivid content, e.g.

4146

# with media and suggestions.

4147

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4148

# You can group multiple rich cards into one using RbmCarouselCard but

4149

# carousel cards will give you less control over the card layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4150

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4151

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4152

# be set. Media (image, GIF or a video) to include in the card.

4153

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4170

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4171

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4172

# For a standalone card with horizontal layout, height is not

4173

# customizable, and this field is ignored.

4174

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4175

# determines the MIME type of the file from the content-type field in

4176

# the HTTP headers when the platform fetches the file. The content-type

4177

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4178

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

4179

# provide a thumbnail URI, the RBM platform displays a blank

4180

# placeholder thumbnail until the user's device downloads the file.

4181

# Depending on the user's setting, the file may not download

4182

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4183

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4184

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4185

#

4186

# At least one of the title, description or media must be set.

4187

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4188

#

4189

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4190

"suggestions": [ # Optional. List of suggestions to include in the card.

4191

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4192

# easily select/click a predefined response or perform an action (like

4193

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4194

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4195

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4196

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4197

# If the user has an app installed that is

4198

# registered as the default handler for the URL, then this app will be

4199

# opened instead, and its icon will be used in the suggested action UI.

4200

"uri": "A String", # Required. The uri to open on the user device

4201

},

4202

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4203

# to send back to the agent.

4204

},

4205

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4206

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4207

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4208

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4209

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4210

# format. An example of a correctly formatted phone number:

4211

# +15556767888.

4212

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4213

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4214

# when the user taps the suggested action. This data will be also

4215

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4216

},

4217

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4218

# instead of typing in their own response.

4219

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4220

# when the user taps the suggested reply. This data will be also

4221

# forwarded to webhook to allow performing custom business logic.

4222

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4223

},

4224

},

4225

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4226

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4227

"cardOrientation": "A String", # Required. Orientation of the card.

4228

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

4229

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4230

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4231

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

4232

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

4233

# play, e.g., "gs://bucket/object". The object must contain a single

4234

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

4235

#

4236

# This object must be readable by the `service-<Project

4237

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

4238

# where <Project Number> is the number of the Telephony Gateway project

4239

# (usually the same as the Dialogflow agent project). If the Google Cloud

4240

# Storage bucket is in the Telephony Gateway project, this permission is

4241

# added by default when enabling the Dialogflow V2 API.

4242

#

4243

# For audio from other sources, consider using the

4244

# `TelephonySynthesizeSpeech` message with SSML.

4245

},

4246

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

4247

"items": [ # Required. Carousel items.

4248

{ # An item in the carousel.

4249

"image": { # The image response message. # Optional. The image to display.

4250

"imageUri": "A String", # Optional. The public URI to an image file.

4251

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4252

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4253

},

4254

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

4255

# dialog.

4256

"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

4261

# response is given.

4262

},

4263

"title": "A String", # Required. Title of the carousel item.

4264

"description": "A String", # Optional. The body text of the card.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

4269

# This message in `QueryResult.fulfillment_messages` and

4270

# `WebhookResponse.fulfillment_messages` should contain only one

4271

# `SimpleResponse`.

4272

"simpleResponses": [ # Required. The list of simple responses.

4273

{ # The simple response message containing speech or text.

4274

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

4275

# response to the user in the SSML format. Mutually exclusive with

4276

# text_to_speech.

4277

"displayText": "A String", # Optional. The text to display.

4278

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

4279

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

4284

# https://developers.google.com/actions/assistant/responses#browsing_carousel

4285

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

4286

# items.

4287

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

4288

# items, maximum of ten.

4289

{ # Browsing carousel tile

4290

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

4291

# Card. Maximum of one line of text.

4292

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

4293

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

4294

# text.

4295

"image": { # The image response message. # Optional. Hero image for the carousel item.

4296

"imageUri": "A String", # Optional. The public URI to an image file.

4297

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4298

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4299

},

4300

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

4301

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

4302

# the URL. Defaults to opening via web browser.

4303

"url": "A String", # Required. URL

4304

},

4305

},

4306

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4307

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4308

},

4309

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4310

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

4311

# chain of followup intents. You can set this field when creating an intent,

4312

# for example with CreateIntent or

4313

# BatchUpdateIntents, in order to make this

4314

# intent a followup intent.

4315

#

4316

# It identifies the parent followup intent.

4317

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4318

"parameters": [ # Optional. The collection of parameters associated with the intent.

4319

{ # Represents intent parameters.

4320

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

4321

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

4322

# whether the intent cannot be completed without collecting the parameter

4323

# value.

4324

"prompts": [ # Optional. The collection of prompts that the agent can present to the

4325

# user in order to collect a value for the parameter.

4326

"A String",

4327

],

4328

"name": "A String", # The unique identifier of this parameter.

4329

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

4330

# describes values of the parameter. If the parameter is

4331

# required, this must be provided.

4332

"displayName": "A String", # Required. The name of the parameter.

4333

"value": "A String", # Optional. The definition of the parameter value. It can be:

4334

#

4335

# - a constant string,

4336

# - a parameter value defined as `$parameter_name`,

4337

# - an original parameter value defined as `$parameter_name.original`,

4338

# - a parameter value from some context defined as

4339

# `#context_name.parameter_name`.

4340

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

4341

# result.

4342

# Default values can be extracted from contexts by using the following

4343

# syntax: `#context_name.parameter_name`.

4344

},

4345

],

4346

"events": [ # Optional. The collection of event names that trigger the intent.

4347

# If the collection of input contexts is not empty, all of the contexts must

4348

# be present in the active user session for an event to trigger this intent.

4349

# Event names are limited to 150 characters.

4350

"A String",

4351

],

4352

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4353

"name": "A String", # Optional. The unique identifier of this intent.

4354

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

4355

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4356

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4357

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

4358

# Note: If `ml_enabled` setting is set to false, then this intent is not

4359

# taken into account during inference in `ML ONLY` match mode. Also,

4360

# auto-markup in the UI is turned off.

4361

# DEPRECATED! Please use `ml_disabled` field instead.

4362

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

4363

# then the default value is determined as follows:

4364

# - Before April 15th, 2018 the default is:

4365

# ml_enabled = false / ml_disabled = true.

4366

# - After April 15th, 2018 the default is:

4367

# ml_enabled = true / ml_disabled = false.

4368

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

4369

# a direct or indirect parent. We populate this field only in the output.

4370

{ # Represents a single followup intent in the chain.

4371

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

4372

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4373

"followupIntentName": "A String", # The unique identifier of the followup intent.

4374

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4375

},

4376

],

4377

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

4378

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

4379

"A String",

4380

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4381

"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]

4382

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4383

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4384

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4385

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4386

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

4387

# priorities.

4388

#

4389

# - If the supplied value is unspecified or 0, the service

4390

# translates the value to 500,000, which corresponds to the

4391

# `Normal` priority in the console.

4392

# - If the supplied value is negative, the intent is ignored

4393

# in runtime detect intent requests.

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>

4401

<pre>Retrieves the next page of results.

4402

4403

Args:

4404

previous_request: The request for the previous page. (required)

4405

previous_response: The response from the request for the previous page. (required)

4406

4407

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4408

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]

4409

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4414

<code class="details" id="patch">patch(name, body=None, intentView=None, updateMask=None, languageCode=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4415

<pre>Updates the specified intent.

4416

4417

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4418

name: string, Optional. The unique identifier of this intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4419

Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

4420

methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4421

Format: `projects/<Project ID>/agent/intents/<Intent ID>`. (required)

4422

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4423

The object takes the form of:

4424

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4425

{ # An intent categorizes an end-user's intention for one conversation turn. For

4426

# each agent, you define many intents, where your combined intents can handle a

4427

# complete conversation. When an end-user writes or says something, referred to

4428

# as an end-user expression or end-user input, Dialogflow matches the end-user

4429

# input to the best intent in your agent. Matching an intent is also known as

4430

# intent classification.

4431

#

4432

# For more information, see the [intent

4433

# guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4434

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

4435

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

4436

# to close interaction with an end user. Default is false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4437

"action": "A String", # Optional. The name of the action associated with the intent.

4438

# Note: The action name must not contain whitespaces.

4439

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4440

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

4441

# is matched. Context messages in this collection should not set the

4442

# parameters field. Setting the `lifespan_count` to 0 will reset the context

4443

# when the intent is matched.

4444

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4445

{ # Dialogflow contexts are similar to natural language context. If a person says

4446

# to you "they are orange", you need context in order to understand what "they"

4447

# is referring to. Similarly, for Dialogflow to handle an end-user expression

4448

# like that, it needs to be provided with context in order to correctly match

4449

# an intent.

4450

#

4451

# Using contexts, you can control the flow of a conversation. You can configure

4452

# contexts for an intent by setting input and output contexts, which are

4453

# identified by string names. When an intent is matched, any configured output

4454

# contexts for that intent become active. While any contexts are active,

4455

# Dialogflow is more likely to match intents that are configured with input

4456

# contexts that correspond to the currently active contexts.

4457

#

4458

# For more information about context, see the

4459

# [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

4460

"parameters": { # Optional. The collection of parameters associated with this context.

4461

#

4462

# Depending on your protocol or client library language, this is a

4463

# map, associative array, symbol table, dictionary, or JSON object

4464

# composed of a collection of (MapKey, MapValue) pairs:

4465

#

4466

# - MapKey type: string

4467

# - MapKey value: parameter name

4468

# - MapValue type:

4469

# - If parameter's entity type is a composite entity: map

4470

# - Else: string or number, depending on parameter value type

4471

# - MapValue value:

4472

# - If parameter's entity type is a composite entity:

4473

# map from composite entity property names to property values

4474

# - Else: parameter value

4475

"a_key": "", # Properties of the object.

4476

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4477

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

4478

# context expires. The default is `0`. If set to `0`, the context expires

4479

# immediately. Contexts expire automatically after 20 minutes if there

4480

# are no matching queries.

4481

"name": "A String", # Required. The unique identifier of the context. Format:

4482

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

4483

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

4484

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

4485

#

4486

# The `Context ID` is always converted to lowercase, may only contain

4487

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

4488

#

4489

# If `Environment ID` is not specified, we assume default 'draft'

4490

# environment. If `User ID` is not specified, we assume default '-' user.

4491

#

4492

# The following context names are reserved for internal use by Dialogflow.

4493

# You should not use these contexts or create contexts with these names:

4494

#

4495

# * `__system_counters__`

4496

# * `*_id_dialog_context`

4497

# * `*_dialog_params_size`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4498

},

4499

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4500

"displayName": "A String", # Required. The name of this intent.

4501

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

4502

# session when this intent is matched.

4503

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

4504

# Note: If `ml_disabled` setting is set to true, then this intent is not

4505

# taken into account during inference in `ML ONLY` match mode. Also,

4506

# auto-markup in the UI is turned off.

4507

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

4508

# followup intents. It identifies the correct followup intents chain for

4509

# this intent.

4510

#

4511

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

4512

"trainingPhrases": [ # Optional. The collection of examples that the agent is

4513

# trained on.

4514

{ # Represents an example that the agent is trained on.

4515

"type": "A String", # Required. The type of the training phrase.

4516

"name": "A String", # Output only. The unique identifier of this training phrase.

4517

"parts": [ # Required. The ordered list of training phrase parts.

4518

# The parts are concatenated in order to form the training phrase.

4519

#

4520

# Note: The API does not automatically annotate training phrases like the

4521

# Dialogflow Console does.

4522

#

4523

# Note: Do not forget to include whitespace at part boundaries,

4524

# so the training phrase is well formatted when the parts are concatenated.

4525

#

4526

# If the training phrase does not need to be annotated with parameters,

4527

# you just need a single part with only the Part.text field set.

4528

#

4529

# If you want to annotate the training phrase, you must create multiple

4530

# parts, where the fields of each part are populated in one of two ways:

4531

#

4532

# - `Part.text` is set to a part of the phrase that has no parameters.

4533

# - `Part.text` is set to a part of the phrase that you want to annotate,

4534

# and the `entity_type`, `alias`, and `user_defined` fields are all

4535

# set.

4536

{ # Represents a part of a training phrase.

4537

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

4538

# This field is set to true when the Dialogflow Console is used to

4539

# manually annotate the part. When creating an annotated part with the

4540

# API, you must set this to true.

4541

"alias": "A String", # Optional. The parameter name for the value extracted from the

4542

# annotated part of the example.

4543

# This field is required for annotated parts of the training phrase.

4544

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

4545

# This field is required for annotated parts of the training phrase.

4546

"text": "A String", # Required. The text for this part.

4547

},

4548

],

4549

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

4550

# the intent. Each time a developer adds an existing sample by editing an

4551

# intent or training, this counter is increased.

4552

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4553

],

4554

"messages": [ # Optional. The collection of rich messages corresponding to the

4555

# `Response` field in the Dialogflow console.

4556

{ # Corresponds to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4557

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

4558

"suggestions": [ # Required. The list of suggested replies.

4559

{ # The suggestion chip message that the user can tap to quickly post a reply

4560

# to the conversation.

4561

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

4566

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

4567

"mediaObjects": [ # Required. List of media objects.

4568

{ # Response media object for media content card.

4569

"description": "A String", # Optional. Description of media card.

4570

"icon": { # The image response message. # Optional. Icon to display above media content.

4571

"imageUri": "A String", # Optional. The public URI to an image file.

4572

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4573

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4574

},

4575

"contentUrl": "A String", # Required. Url where the media is stored.

4576

"name": "A String", # Required. Name of media card.

4577

"largeImage": { # The image response message. # Optional. Image to display above media content.

4578

"imageUri": "A String", # Optional. The public URI to an image file.

4579

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4580

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

4586

"phoneNumber": "A String", # Required. The phone number to transfer the call to

4587

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

4588

#

4589

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

4590

},

4591

"platform": "A String", # Optional. The platform that this message is intended for.

4592

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

4593

# Telephony Gateway.

4594

#

4595

# Telephony Gateway takes the synthesizer settings from

4596

# `DetectIntentResponse.output_audio_config` which can either be set

4597

# at request-level or can come from the agent-level synthesizer config.

4598

"text": "A String", # The raw text to be synthesized.

4599

"ssml": "A String", # The SSML to be synthesized. For more information, see

4600

# [SSML](https://developers.google.com/actions/reference/ssml).

4601

},

4602

"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.

4603

# or website associated with this agent.

4604

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

4605

# suggestion chip.

4606

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

4607

},

4608

"quickReplies": { # The quick replies response message. # Displays quick replies.

4609

"quickReplies": [ # Optional. The collection of quick replies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4610

"A String",

4611

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4612

"title": "A String", # Optional. The title of the collection of quick replies.

4613

},

4614

"card": { # The card response message. # Displays a card.

4615

"subtitle": "A String", # Optional. The subtitle of the card.

4616

"buttons": [ # Optional. The collection of card buttons.

4617

{ # Optional. Contains information about a button.

4618

"text": "A String", # Optional. The text to show on the button.

4619

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

4624

"title": "A String", # Optional. The title of the card.

4625

},

4626

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

4627

"subtitle": "A String", # Optional. Subtitle of the list.

4628

"title": "A String", # Optional. The overall title of the list.

4629

"items": [ # Required. List items.

4630

{ # An item in the list.

4631

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

4632

# dialog.

4633

"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

4638

# response is given.

4639

},

4640

"description": "A String", # Optional. The main text describing the item.

4641

"title": "A String", # Required. The title of the list item.

4642

"image": { # The image response message. # Optional. The image to display.

4643

"imageUri": "A String", # Optional. The public URI to an image file.

4644

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4645

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

4651

"buttons": [ # Optional. The collection of card buttons.

4652

{ # The button object that appears at the bottom of a card.

4653

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4654

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4655

},

4656

"title": "A String", # Required. The title of the button.

4657

},

4658

],

4659

"title": "A String", # Optional. The title of the card.

4660

"image": { # The image response message. # Optional. The image for the card.

4661

"imageUri": "A String", # Optional. The public URI to an image file.

4662

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4663

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4664

},

4665

"subtitle": "A String", # Optional. The subtitle of the card.

4666

"formattedText": "A String", # Required, unless image is present. The body text of the card.

4667

},

4668

"image": { # The image response message. # Displays an image.

4669

"imageUri": "A String", # Optional. The public URI to an image file.

4670

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4671

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4672

},

4673

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

4674

#

4675

# Rich cards allow you to respond to users with more vivid content, e.g.

4676

# with media and suggestions.

4677

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4678

# If you want to show a single card with more control over the layout,

4679

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4680

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4681

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

4682

# 2 cards and at most 10.

4683

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4684

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4685

# be set. Media (image, GIF or a video) to include in the card.

4686

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4703

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4704

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4705

# For a standalone card with horizontal layout, height is not

4706

# customizable, and this field is ignored.

4707

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4708

# determines the MIME type of the file from the content-type field in

4709

# the HTTP headers when the platform fetches the file. The content-type

4710

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4711

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

4712

# provide a thumbnail URI, the RBM platform displays a blank

4713

# placeholder thumbnail until the user's device downloads the file.

4714

# Depending on the user's setting, the file may not download

4715

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4716

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4717

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4718

#

4719

# At least one of the title, description or media must be set.

4720

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4721

#

4722

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4723

"suggestions": [ # Optional. List of suggestions to include in the card.

4724

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4725

# easily select/click a predefined response or perform an action (like

4726

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4727

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4728

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4729

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4730

# If the user has an app installed that is

4731

# registered as the default handler for the URL, then this app will be

4732

# opened instead, and its icon will be used in the suggested action UI.

4733

"uri": "A String", # Required. The uri to open on the user device

4734

},

4735

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4736

# to send back to the agent.

4737

},

4738

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4739

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4740

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4741

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4742

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4743

# format. An example of a correctly formatted phone number:

4744

# +15556767888.

4745

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4746

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4747

# when the user taps the suggested action. This data will be also

4748

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4749

},

4750

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4751

# instead of typing in their own response.

4752

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4753

# when the user taps the suggested reply. This data will be also

4754

# forwarded to webhook to allow performing custom business logic.

4755

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4756

},

4757

},

4758

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4759

},

4760

],

4761

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4762

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

4763

"buttons": [ # Optional. List of buttons for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4764

{ # The button object that appears at the bottom of a card.

4765

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

4766

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

4767

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4768

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4769

},

4770

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4771

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4772

"image": { # The image response message. # Optional. Image which should be displayed on the card.

4773

"imageUri": "A String", # Optional. The public URI to an image file.

4774

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4775

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4776

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4777

"rows": [ # Optional. Rows in this table of data.

4778

{ # Row of TableCard.

4779

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

4780

"cells": [ # Optional. List of cells that make up this row.

4781

{ # Cell of TableCardRow.

4782

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4787

"title": "A String", # Required. Title of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4788

"columnProperties": [ # Optional. Display properties for the columns in this table.

4789

{ # Column properties for TableCard.

4790

"header": "A String", # Required. Column heading.

4791

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

4792

},

4793

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4794

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4795

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

4796

#

4797

# RBM allows businesses to send enriched and branded versions of SMS. See

4798

# https://jibe.google.com/business-messaging.

4799

"text": "A String", # Required. Text sent and displayed to the user.

4800

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

4801

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4802

# easily select/click a predefined response or perform an action (like

4803

# opening a web uri).

4804

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4805

# can choose from the card.

4806

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4807

# If the user has an app installed that is

4808

# registered as the default handler for the URL, then this app will be

4809

# opened instead, and its icon will be used in the suggested action UI.

4810

"uri": "A String", # Required. The uri to open on the user device

4811

},

4812

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4813

# to send back to the agent.

4814

},

4815

"text": "A String", # Text to display alongside the action.

4816

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

4817

# but does not dial automatically.

4818

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4819

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4820

# format. An example of a correctly formatted phone number:

4821

# +15556767888.

4822

},

4823

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4824

# when the user taps the suggested action. This data will be also

4825

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4826

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4827

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4828

# instead of typing in their own response.

4829

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4830

# when the user taps the suggested reply. This data will be also

4831

# forwarded to webhook to allow performing custom business logic.

4832

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4833

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4834

},

4835

],

4836

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4837

"payload": { # A custom platform-specific response.

4838

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4839

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4840

"text": { # The text response message. # Returns a text response.

4841

"text": [ # Optional. The collection of the agent's responses.

4842

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4843

],

4844

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4845

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

4846

#

4847

# Rich cards allow you to respond to users with more vivid content, e.g.

4848

# with media and suggestions.

4849

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4850

# You can group multiple rich cards into one using RbmCarouselCard but

4851

# carousel cards will give you less control over the card layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4852

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4853

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

4854

# be set. Media (image, GIF or a video) to include in the card.

4855

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4872

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4873

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4874

# For a standalone card with horizontal layout, height is not

4875

# customizable, and this field is ignored.

4876

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

4877

# determines the MIME type of the file from the content-type field in

4878

# the HTTP headers when the platform fetches the file. The content-type

4879

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4880

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

4881

# provide a thumbnail URI, the RBM platform displays a blank

4882

# placeholder thumbnail until the user's device downloads the file.

4883

# Depending on the user's setting, the file may not download

4884

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4885

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4886

"title": "A String", # Optional. Title of the card (at most 200 bytes).

4887

#

4888

# At least one of the title, description or media must be set.

4889

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

4890

#

4891

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4892

"suggestions": [ # Optional. List of suggestions to include in the card.

4893

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

4894

# easily select/click a predefined response or perform an action (like

4895

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4896

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

4897

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4898

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

4899

# If the user has an app installed that is

4900

# registered as the default handler for the URL, then this app will be

4901

# opened instead, and its icon will be used in the suggested action UI.

4902

"uri": "A String", # Required. The uri to open on the user device

4903

},

4904

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

4905

# to send back to the agent.

4906

},

4907

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4908

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4909

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4910

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

4911

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

4912

# format. An example of a correctly formatted phone number:

4913

# +15556767888.

4914

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4915

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4916

# when the user taps the suggested action. This data will be also

4917

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4918

},

4919

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

4920

# instead of typing in their own response.

4921

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

4922

# when the user taps the suggested reply. This data will be also

4923

# forwarded to webhook to allow performing custom business logic.

4924

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4925

},

4926

},

4927

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4928

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4929

"cardOrientation": "A String", # Required. Orientation of the card.

4930

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

4931

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4932

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4933

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

4934

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

4935

# play, e.g., "gs://bucket/object". The object must contain a single

4936

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

4937

#

4938

# This object must be readable by the `service-<Project

4939

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

4940

# where <Project Number> is the number of the Telephony Gateway project

4941

# (usually the same as the Dialogflow agent project). If the Google Cloud

4942

# Storage bucket is in the Telephony Gateway project, this permission is

4943

# added by default when enabling the Dialogflow V2 API.

4944

#

4945

# For audio from other sources, consider using the

4946

# `TelephonySynthesizeSpeech` message with SSML.

4947

},

4948

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

4949

"items": [ # Required. Carousel items.

4950

{ # An item in the carousel.

4951

"image": { # The image response message. # Optional. The image to display.

4952

"imageUri": "A String", # Optional. The public URI to an image file.

4953

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

4954

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

4955

},

4956

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

4957

# dialog.

4958

"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

4963

# response is given.

4964

},

4965

"title": "A String", # Required. Title of the carousel item.

4966

"description": "A String", # Optional. The body text of the card.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

4971

# This message in `QueryResult.fulfillment_messages` and

4972

# `WebhookResponse.fulfillment_messages` should contain only one

4973

# `SimpleResponse`.

4974

"simpleResponses": [ # Required. The list of simple responses.

4975

{ # The simple response message containing speech or text.

4976

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

4977

# response to the user in the SSML format. Mutually exclusive with

4978

# text_to_speech.

4979

"displayText": "A String", # Optional. The text to display.

4980

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

4981

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

4986

# https://developers.google.com/actions/assistant/responses#browsing_carousel

4987

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

4988

# items.

4989

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

4990

# items, maximum of ten.

4991

{ # Browsing carousel tile

4992

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

4993

# Card. Maximum of one line of text.

4994

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

4995

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

4996

# text.

4997

"image": { # The image response message. # Optional. Hero image for the carousel item.

4998

"imageUri": "A String", # Optional. The public URI to an image file.

4999

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5000

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5001

},

5002

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

5003

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

5004

# the URL. Defaults to opening via web browser.

5005

"url": "A String", # Required. URL

5006

},

5007

},

5008

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5009

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5010

},

5011

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5012

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

5013

# chain of followup intents. You can set this field when creating an intent,

5014

# for example with CreateIntent or

5015

# BatchUpdateIntents, in order to make this

5016

# intent a followup intent.

5017

#

5018

# It identifies the parent followup intent.

5019

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5020

"parameters": [ # Optional. The collection of parameters associated with the intent.

5021

{ # Represents intent parameters.

5022

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

5023

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

5024

# whether the intent cannot be completed without collecting the parameter

5025

# value.

5026

"prompts": [ # Optional. The collection of prompts that the agent can present to the

5027

# user in order to collect a value for the parameter.

5028

"A String",

5029

],

5030

"name": "A String", # The unique identifier of this parameter.

5031

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

5032

# describes values of the parameter. If the parameter is

5033

# required, this must be provided.

5034

"displayName": "A String", # Required. The name of the parameter.

5035

"value": "A String", # Optional. The definition of the parameter value. It can be:

5036

#

5037

# - a constant string,

5038

# - a parameter value defined as `$parameter_name`,

5039

# - an original parameter value defined as `$parameter_name.original`,

5040

# - a parameter value from some context defined as

5041

# `#context_name.parameter_name`.

5042

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

5043

# result.

5044

# Default values can be extracted from contexts by using the following

5045

# syntax: `#context_name.parameter_name`.

5046

},

5047

],

5048

"events": [ # Optional. The collection of event names that trigger the intent.

5049

# If the collection of input contexts is not empty, all of the contexts must

5050

# be present in the active user session for an event to trigger this intent.

5051

# Event names are limited to 150 characters.

5052

"A String",

5053

],

5054

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5055

"name": "A String", # Optional. The unique identifier of this intent.

5056

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

5057

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5058

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5059

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

5060

# Note: If `ml_enabled` setting is set to false, then this intent is not

5061

# taken into account during inference in `ML ONLY` match mode. Also,

5062

# auto-markup in the UI is turned off.

5063

# DEPRECATED! Please use `ml_disabled` field instead.

5064

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

5065

# then the default value is determined as follows:

5066

# - Before April 15th, 2018 the default is:

5067

# ml_enabled = false / ml_disabled = true.

5068

# - After April 15th, 2018 the default is:

5069

# ml_enabled = true / ml_disabled = false.

5070

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

5071

# a direct or indirect parent. We populate this field only in the output.

5072

{ # Represents a single followup intent in the chain.

5073

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

5074

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5075

"followupIntentName": "A String", # The unique identifier of the followup intent.

5076

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5077

},

5078

],

5079

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

5080

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

5081

"A String",

5082

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5083

"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]

5084

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5085

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5086

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5087

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5088

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

5089

# priorities.

5090

#

5091

# - If the supplied value is unspecified or 0, the service

5092

# translates the value to 500,000, which corresponds to the

5093

# `Normal` priority in the console.

5094

# - If the supplied value is negative, the intent is ignored

5095

# in runtime detect intent requests.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5096

}

5097

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5098

intentView: string, Optional. The resource view to apply to the returned intent.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5099

updateMask: string, Optional. The mask to control which fields get updated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5100

languageCode: string, Optional. The language used to access language-specific data.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5101

If not specified, the agent's default language is used.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5102

For more information, see

5103

[Multilingual intent and entity

5104

data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5105

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5112

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5113

{ # An intent categorizes an end-user's intention for one conversation turn. For

5114

# each agent, you define many intents, where your combined intents can handle a

5115

# complete conversation. When an end-user writes or says something, referred to

5116

# as an end-user expression or end-user input, Dialogflow matches the end-user

5117

# input to the best intent in your agent. Matching an intent is also known as

5118

# intent classification.

5119

#

5120

# For more information, see the [intent

5121

# guide](https://cloud.google.com/dialogflow/docs/intents-overview).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5122

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

5123

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

5124

# to close interaction with an end user. Default is false.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5125

"action": "A String", # Optional. The name of the action associated with the intent.

5126

# Note: The action name must not contain whitespaces.

5127

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5128

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

5129

# is matched. Context messages in this collection should not set the

5130

# parameters field. Setting the `lifespan_count` to 0 will reset the context

5131

# when the intent is matched.

5132

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5133

{ # Dialogflow contexts are similar to natural language context. If a person says

5134

# to you "they are orange", you need context in order to understand what "they"

5135

# is referring to. Similarly, for Dialogflow to handle an end-user expression

5136

# like that, it needs to be provided with context in order to correctly match

5137

# an intent.

5138

#

5139

# Using contexts, you can control the flow of a conversation. You can configure

5140

# contexts for an intent by setting input and output contexts, which are

5141

# identified by string names. When an intent is matched, any configured output

5142

# contexts for that intent become active. While any contexts are active,

5143

# Dialogflow is more likely to match intents that are configured with input

5144

# contexts that correspond to the currently active contexts.

5145

#

5146

# For more information about context, see the

5147

# [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

5148

"parameters": { # Optional. The collection of parameters associated with this context.

5149

#

5150

# Depending on your protocol or client library language, this is a

5151

# map, associative array, symbol table, dictionary, or JSON object

5152

# composed of a collection of (MapKey, MapValue) pairs:

5153

#

5154

# - MapKey type: string

5155

# - MapKey value: parameter name

5156

# - MapValue type:

5157

# - If parameter's entity type is a composite entity: map

5158

# - Else: string or number, depending on parameter value type

5159

# - MapValue value:

5160

# - If parameter's entity type is a composite entity:

5161

# map from composite entity property names to property values

5162

# - Else: parameter value

5163

"a_key": "", # Properties of the object.

5164

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5165

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

5166

# context expires. The default is `0`. If set to `0`, the context expires

5167

# immediately. Contexts expire automatically after 20 minutes if there

5168

# are no matching queries.

5169

"name": "A String", # Required. The unique identifier of the context. Format:

5170

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

5171

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

5172

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

5173

#

5174

# The `Context ID` is always converted to lowercase, may only contain

5175

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

5176

#

5177

# If `Environment ID` is not specified, we assume default 'draft'

5178

# environment. If `User ID` is not specified, we assume default '-' user.

5179

#

5180

# The following context names are reserved for internal use by Dialogflow.

5181

# You should not use these contexts or create contexts with these names:

5182

#

5183

# * `__system_counters__`

5184

# * `*_id_dialog_context`

5185

# * `*_dialog_params_size`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5186

},

5187

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5188

"displayName": "A String", # Required. The name of this intent.

5189

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

5190

# session when this intent is matched.

5191

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

5192

# Note: If `ml_disabled` setting is set to true, then this intent is not

5193

# taken into account during inference in `ML ONLY` match mode. Also,

5194

# auto-markup in the UI is turned off.

5195

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

5196

# followup intents. It identifies the correct followup intents chain for

5197

# this intent.

5198

#

5199

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5200

"trainingPhrases": [ # Optional. The collection of examples that the agent is

5201

# trained on.

5202

{ # Represents an example that the agent is trained on.

5203

"type": "A String", # Required. The type of the training phrase.

5204

"name": "A String", # Output only. The unique identifier of this training phrase.

5205

"parts": [ # Required. The ordered list of training phrase parts.

5206

# The parts are concatenated in order to form the training phrase.

5207

#

5208

# Note: The API does not automatically annotate training phrases like the

5209

# Dialogflow Console does.

5210

#

5211

# Note: Do not forget to include whitespace at part boundaries,

5212

# so the training phrase is well formatted when the parts are concatenated.

5213

#

5214

# If the training phrase does not need to be annotated with parameters,

5215

# you just need a single part with only the Part.text field set.

5216

#

5217

# If you want to annotate the training phrase, you must create multiple

5218

# parts, where the fields of each part are populated in one of two ways:

5219

#

5220

# - `Part.text` is set to a part of the phrase that has no parameters.

5221

# - `Part.text` is set to a part of the phrase that you want to annotate,

5222

# and the `entity_type`, `alias`, and `user_defined` fields are all

5223

# set.

5224

{ # Represents a part of a training phrase.

5225

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

5226

# This field is set to true when the Dialogflow Console is used to

5227

# manually annotate the part. When creating an annotated part with the

5228

# API, you must set this to true.

5229

"alias": "A String", # Optional. The parameter name for the value extracted from the

5230

# annotated part of the example.

5231

# This field is required for annotated parts of the training phrase.

5232

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

5233

# This field is required for annotated parts of the training phrase.

5234

"text": "A String", # Required. The text for this part.

5235

},

5236

],

5237

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

5238

# the intent. Each time a developer adds an existing sample by editing an

5239

# intent or training, this counter is increased.

5240

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5241

],

5242

"messages": [ # Optional. The collection of rich messages corresponding to the

5243

# `Response` field in the Dialogflow console.

5244

{ # Corresponds to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5245

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

5246

"suggestions": [ # Required. The list of suggested replies.

5247

{ # The suggestion chip message that the user can tap to quickly post a reply

5248

# to the conversation.

5249

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

5254

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

5255

"mediaObjects": [ # Required. List of media objects.

5256

{ # Response media object for media content card.

5257

"description": "A String", # Optional. Description of media card.

5258

"icon": { # The image response message. # Optional. Icon to display above media content.

5259

"imageUri": "A String", # Optional. The public URI to an image file.

5260

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5261

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5262

},

5263

"contentUrl": "A String", # Required. Url where the media is stored.

5264

"name": "A String", # Required. Name of media card.

5265

"largeImage": { # The image response message. # Optional. Image to display above media content.

5266

"imageUri": "A String", # Optional. The public URI to an image file.

5267

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5268

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

5274

"phoneNumber": "A String", # Required. The phone number to transfer the call to

5275

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

5276

#

5277

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

5278

},

5279

"platform": "A String", # Optional. The platform that this message is intended for.

5280

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

5281

# Telephony Gateway.

5282

#

5283

# Telephony Gateway takes the synthesizer settings from

5284

# `DetectIntentResponse.output_audio_config` which can either be set

5285

# at request-level or can come from the agent-level synthesizer config.

5286

"text": "A String", # The raw text to be synthesized.

5287

"ssml": "A String", # The SSML to be synthesized. For more information, see

5288

# [SSML](https://developers.google.com/actions/reference/ssml).

5289

},

5290

"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.

5291

# or website associated with this agent.

5292

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

5293

# suggestion chip.

5294

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

5295

},

5296

"quickReplies": { # The quick replies response message. # Displays quick replies.

5297

"quickReplies": [ # Optional. The collection of quick replies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5298

"A String",

5299

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5300

"title": "A String", # Optional. The title of the collection of quick replies.

5301

},

5302

"card": { # The card response message. # Displays a card.

5303

"subtitle": "A String", # Optional. The subtitle of the card.

5304

"buttons": [ # Optional. The collection of card buttons.

5305

{ # Optional. Contains information about a button.

5306

"text": "A String", # Optional. The text to show on the button.

5307

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"imageUri": "A String", # Optional. The public URI to an image file for the card.

5312

"title": "A String", # Optional. The title of the card.

5313

},

5314

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

5315

"subtitle": "A String", # Optional. Subtitle of the list.

5316

"title": "A String", # Optional. The overall title of the list.

5317

"items": [ # Required. List items.

5318

{ # An item in the list.

5319

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

5320

# dialog.

5321

"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

5326

# response is given.

5327

},

5328

"description": "A String", # Optional. The main text describing the item.

5329

"title": "A String", # Required. The title of the list item.

5330

"image": { # The image response message. # Optional. The image to display.

5331

"imageUri": "A String", # Optional. The public URI to an image file.

5332

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5333

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

},

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

5339

"buttons": [ # Optional. The collection of card buttons.

5340

{ # The button object that appears at the bottom of a card.

5341

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

5342

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

5343

},

5344

"title": "A String", # Required. The title of the button.

5345

},

5346

],

5347

"title": "A String", # Optional. The title of the card.

5348

"image": { # The image response message. # Optional. The image for the card.

5349

"imageUri": "A String", # Optional. The public URI to an image file.

5350

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5351

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5352

},

5353

"subtitle": "A String", # Optional. The subtitle of the card.

5354

"formattedText": "A String", # Required, unless image is present. The body text of the card.

5355

},

5356

"image": { # The image response message. # Displays an image.

5357

"imageUri": "A String", # Optional. The public URI to an image file.

5358

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5359

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5360

},

5361

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

5362

#

5363

# Rich cards allow you to respond to users with more vivid content, e.g.

5364

# with media and suggestions.

5365

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5366

# If you want to show a single card with more control over the layout,

5367

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5368

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5369

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

5370

# 2 cards and at most 10.

5371

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5372

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

5373

# be set. Media (image, GIF or a video) to include in the card.

5374

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5391

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5392

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5393

# For a standalone card with horizontal layout, height is not

5394

# customizable, and this field is ignored.

5395

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

5396

# determines the MIME type of the file from the content-type field in

5397

# the HTTP headers when the platform fetches the file. The content-type

5398

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5399

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

5400

# provide a thumbnail URI, the RBM platform displays a blank

5401

# placeholder thumbnail until the user's device downloads the file.

5402

# Depending on the user's setting, the file may not download

5403

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5404

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5405

"title": "A String", # Optional. Title of the card (at most 200 bytes).

5406

#

5407

# At least one of the title, description or media must be set.

5408

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

5409

#

5410

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5411

"suggestions": [ # Optional. List of suggestions to include in the card.

5412

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5413

# easily select/click a predefined response or perform an action (like

5414

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5415

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5416

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5417

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5418

# If the user has an app installed that is

5419

# registered as the default handler for the URL, then this app will be

5420

# opened instead, and its icon will be used in the suggested action UI.

5421

"uri": "A String", # Required. The uri to open on the user device

5422

},

5423

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5424

# to send back to the agent.

5425

},

5426

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5427

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5428

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5429

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5430

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5431

# format. An example of a correctly formatted phone number:

5432

# +15556767888.

5433

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5434

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5435

# when the user taps the suggested action. This data will be also

5436

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5437

},

5438

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5439

# instead of typing in their own response.

5440

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5441

# when the user taps the suggested reply. This data will be also

5442

# forwarded to webhook to allow performing custom business logic.

5443

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5444

},

5445

},

5446

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5447

},

5448

],

5449

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5450

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

5451

"buttons": [ # Optional. List of buttons for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5452

{ # The button object that appears at the bottom of a card.

5453

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

5454

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

5455

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5456

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5457

},

5458

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5459

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5460

"image": { # The image response message. # Optional. Image which should be displayed on the card.

5461

"imageUri": "A String", # Optional. The public URI to an image file.

5462

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5463

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5464

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5465

"rows": [ # Optional. Rows in this table of data.

5466

{ # Row of TableCard.

5467

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

5468

"cells": [ # Optional. List of cells that make up this row.

5469

{ # Cell of TableCardRow.

5470

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5475

"title": "A String", # Required. Title of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5476

"columnProperties": [ # Optional. Display properties for the columns in this table.

5477

{ # Column properties for TableCard.

5478

"header": "A String", # Required. Column heading.

5479

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

5480

},

5481

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5482

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5483

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

5484

#

5485

# RBM allows businesses to send enriched and branded versions of SMS. See

5486

# https://jibe.google.com/business-messaging.

5487

"text": "A String", # Required. Text sent and displayed to the user.

5488

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

5489

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5490

# easily select/click a predefined response or perform an action (like

5491

# opening a web uri).

5492

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5493

# can choose from the card.

5494

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5495

# If the user has an app installed that is

5496

# registered as the default handler for the URL, then this app will be

5497

# opened instead, and its icon will be used in the suggested action UI.

5498

"uri": "A String", # Required. The uri to open on the user device

5499

},

5500

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5501

# to send back to the agent.

5502

},

5503

"text": "A String", # Text to display alongside the action.

5504

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

5505

# but does not dial automatically.

5506

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5507

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5508

# format. An example of a correctly formatted phone number:

5509

# +15556767888.

5510

},

5511

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5512

# when the user taps the suggested action. This data will be also

5513

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5514

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5515

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5516

# instead of typing in their own response.

5517

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5518

# when the user taps the suggested reply. This data will be also

5519

# forwarded to webhook to allow performing custom business logic.

5520

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5521

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5522

},

5523

],

5524

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5525

"payload": { # A custom platform-specific response.

5526

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5527

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5528

"text": { # The text response message. # Returns a text response.

5529

"text": [ # Optional. The collection of the agent's responses.

5530

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5531

],

5532

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5533

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

5534

#

5535

# Rich cards allow you to respond to users with more vivid content, e.g.

5536

# with media and suggestions.

5537

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5538

# You can group multiple rich cards into one using RbmCarouselCard but

5539

# carousel cards will give you less control over the card layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5540

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5541

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

5542

# be set. Media (image, GIF or a video) to include in the card.

5543

# 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5560

"height": "A String", # Required for cards with vertical orientation. The height of the media

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5561

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5562

# For a standalone card with horizontal layout, height is not

5563

# customizable, and this field is ignored.

5564

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

5565

# determines the MIME type of the file from the content-type field in

5566

# the HTTP headers when the platform fetches the file. The content-type

5567

# field must be present and accurate in the HTTP response from the URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5568

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

5569

# provide a thumbnail URI, the RBM platform displays a blank

5570

# placeholder thumbnail until the user's device downloads the file.

5571

# Depending on the user's setting, the file may not download

5572

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5573

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5574

"title": "A String", # Optional. Title of the card (at most 200 bytes).

5575

#

5576

# At least one of the title, description or media must be set.

5577

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

5578

#

5579

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5580

"suggestions": [ # Optional. List of suggestions to include in the card.

5581

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

5582

# easily select/click a predefined response or perform an action (like

5583

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5584

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

5585

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5586

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

5587

# If the user has an app installed that is

5588

# registered as the default handler for the URL, then this app will be

5589

# opened instead, and its icon will be used in the suggested action UI.

5590

"uri": "A String", # Required. The uri to open on the user device

5591

},

5592

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

5593

# to send back to the agent.

5594

},

5595

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5596

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5597

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5598

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

5599

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

5600

# format. An example of a correctly formatted phone number:

5601

# +15556767888.

5602

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5603

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5604

# when the user taps the suggested action. This data will be also

5605

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5606

},

5607

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

5608

# instead of typing in their own response.

5609

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

5610

# when the user taps the suggested reply. This data will be also

5611

# forwarded to webhook to allow performing custom business logic.

5612

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5613

},

5614

},

5615

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5616

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5617

"cardOrientation": "A String", # Required. Orientation of the card.

5618

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

5619

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5620

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5621

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

5622

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

5623

# play, e.g., "gs://bucket/object". The object must contain a single

5624

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

5625

#

5626

# This object must be readable by the `service-<Project

5627

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

5628

# where <Project Number> is the number of the Telephony Gateway project

5629

# (usually the same as the Dialogflow agent project). If the Google Cloud

5630

# Storage bucket is in the Telephony Gateway project, this permission is

5631

# added by default when enabling the Dialogflow V2 API.

5632

#

5633

# For audio from other sources, consider using the

5634

# `TelephonySynthesizeSpeech` message with SSML.

5635

},

5636

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

5637

"items": [ # Required. Carousel items.

5638

{ # An item in the carousel.

5639

"image": { # The image response message. # Optional. The image to display.

5640

"imageUri": "A String", # Optional. The public URI to an image file.

5641

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5642

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5643

},

5644

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

5645

# dialog.

5646

"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

5651

# response is given.

5652

},

5653

"title": "A String", # Required. Title of the carousel item.

5654

"description": "A String", # Optional. The body text of the card.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

5659

# This message in `QueryResult.fulfillment_messages` and

5660

# `WebhookResponse.fulfillment_messages` should contain only one

5661

# `SimpleResponse`.

5662

"simpleResponses": [ # Required. The list of simple responses.

5663

{ # The simple response message containing speech or text.

5664

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

5665

# response to the user in the SSML format. Mutually exclusive with

5666

# text_to_speech.

5667

"displayText": "A String", # Optional. The text to display.

5668

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

5669

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

5674

# https://developers.google.com/actions/assistant/responses#browsing_carousel

5675

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

5676

# items.

5677

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

5678

# items, maximum of ten.

5679

{ # Browsing carousel tile

5680

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

5681

# Card. Maximum of one line of text.

5682

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

5683

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

5684

# text.

5685

"image": { # The image response message. # Optional. Hero image for the carousel item.

5686

"imageUri": "A String", # Optional. The public URI to an image file.

5687

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

5688

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

5689

},

5690

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

5691

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

5692

# the URL. Defaults to opening via web browser.

5693

"url": "A String", # Required. URL

5694

},

5695

},

5696

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5697

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5698

},

5699

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5700

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

5701

# chain of followup intents. You can set this field when creating an intent,

5702

# for example with CreateIntent or

5703

# BatchUpdateIntents, in order to make this

5704

# intent a followup intent.

5705

#

5706

# It identifies the parent followup intent.

5707

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5708

"parameters": [ # Optional. The collection of parameters associated with the intent.

5709

{ # Represents intent parameters.

5710

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

5711

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

5712

# whether the intent cannot be completed without collecting the parameter

5713

# value.

5714

"prompts": [ # Optional. The collection of prompts that the agent can present to the

5715

# user in order to collect a value for the parameter.

5716

"A String",

5717

],

5718

"name": "A String", # The unique identifier of this parameter.

5719

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

5720

# describes values of the parameter. If the parameter is

5721

# required, this must be provided.

5722

"displayName": "A String", # Required. The name of the parameter.

5723

"value": "A String", # Optional. The definition of the parameter value. It can be:

5724

#

5725

# - a constant string,

5726

# - a parameter value defined as `$parameter_name`,

5727

# - an original parameter value defined as `$parameter_name.original`,

5728

# - a parameter value from some context defined as

5729

# `#context_name.parameter_name`.

5730

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

5731

# result.

5732

# Default values can be extracted from contexts by using the following

5733

# syntax: `#context_name.parameter_name`.

5734

},

5735

],

5736

"events": [ # Optional. The collection of event names that trigger the intent.

5737

# If the collection of input contexts is not empty, all of the contexts must

5738

# be present in the active user session for an event to trigger this intent.

5739

# Event names are limited to 150 characters.

5740

"A String",

5741

],

5742

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5743

"name": "A String", # Optional. The unique identifier of this intent.

5744

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

5745

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5746

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5747

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

5748

# Note: If `ml_enabled` setting is set to false, then this intent is not

5749

# taken into account during inference in `ML ONLY` match mode. Also,

5750

# auto-markup in the UI is turned off.

5751

# DEPRECATED! Please use `ml_disabled` field instead.

5752

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

5753

# then the default value is determined as follows:

5754

# - Before April 15th, 2018 the default is:

5755

# ml_enabled = false / ml_disabled = true.

5756

# - After April 15th, 2018 the default is:

5757

# ml_enabled = true / ml_disabled = false.

5758

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

5759

# a direct or indirect parent. We populate this field only in the output.

5760

{ # Represents a single followup intent in the chain.

5761

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

5762

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5763

"followupIntentName": "A String", # The unique identifier of the followup intent.

5764

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

5765

},

5766

],

5767

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

5768

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

5769

"A String",

5770

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5771

"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]

5772

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5773

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5774

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5775

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5776

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

5777

# priorities.

5778

#

5779

# - If the supplied value is unspecified or 0, the service

5780

# translates the value to 500,000, which corresponds to the

5781

# `Normal` priority in the console.

5782

# - If the supplied value is negative, the intent is ignored

5783

# in runtime detect intent requests.

Bu Sun Kim