Blame - docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html - platform/external/python/google-api-python-client

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

[diff] [blame]

91

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

Bu Sun Kim

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

[diff] [blame]

92

<p class="firstline">Processes a natural language query and returns structured, actionable data</p>

93

<h3>Method Details</h3>

94

95

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

96

<pre>Deletes all active contexts in the specified session.

97

98

Args:

99

parent: string, Required. The name of the session to delete all contexts from. Format:

Dan O'Meara

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

[diff] [blame]

100

`projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project

101

ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session

Bu Sun Kim

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

[diff] [blame]

102

ID>`. If `Environment ID` is not specified we assume default 'draft'

103

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

Bu Sun Kim

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

[diff] [blame]

104

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

111

112

{ # A generic empty message that you can re-use to avoid defining duplicated

113

# empty messages in your APIs. A typical example is to use it as the request

114

# or the response type of an API method. For instance:

115

#

116

# service Foo {

117

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

118

# }

119

#

120

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

125

<code class="details" id="detectIntent">detectIntent(session, body=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

126

<pre>Processes a natural language query and returns structured, actionable data

127

as a result. This method is not idempotent, because it may cause contexts

128

and session entity types to be updated, which in turn might affect

129

results of future queries.

130

131

Args:

132

session: string, Required. The name of the session this query is sent to. Format:

Dan O'Meara

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

[diff] [blame]

133

`projects/<Project ID>/agent/sessions/<Session ID>`, or

134

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

135

ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume

Bu Sun Kim

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

[diff] [blame]

136

default 'draft' environment. If `User ID` is not specified, we are using

137

"-". It's up to the API caller to choose an appropriate `Session ID` and

Dan O'Meara

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

[diff] [blame]

138

`User Id`. They can be a random number or some type of user and session

Bu Sun Kim

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

[diff] [blame]

139

identifiers (preferably hashed). The length of the `Session ID` and

Bu Sun Kim

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

[diff] [blame]

140

`User ID` must not exceed 36 characters.

141

142

For more information, see the [API interactions

143

guide](https://cloud.google.com/dialogflow/docs/api-overview). (required)

Dan O'Meara

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

[diff] [blame]

144

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

145

The object takes the form of:

146

Bu Sun Kim

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

[diff] [blame]

147

{ # The request to detect user's intent.

Bu Sun Kim

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

[diff] [blame]

148

"outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output

149

# audio. If this field is not set and agent-level speech synthesizer is not

150

# configured, no output audio is generated.

151

# If this audio config is supplied in a request, it overrides all existing

152

# text-to-speech settings applied to the agent.

153

"synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Configuration of how speech should be synthesized.

154

"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal

155

# native speed supported by the specific voice. 2.0 is twice as fast, and

156

# 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any

157

# other values < 0.25 or > 4.0 will return an error.

158

"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20

159

# semitones from the original pitch. -20 means decrease 20 semitones from the

160

# original pitch.

161

"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the

162

# specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of

163

# 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)

164

# will play at approximately half the amplitude of the normal native signal

165

# amplitude. A value of +6.0 (dB) will play at approximately twice the

166

# amplitude of the normal native signal amplitude. We strongly recommend not

167

# to exceed +10 (dB) as there's usually no effective increase in loudness for

168

# any value greater than that.

169

"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.

170

"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will

171

# choose a voice based on the other parameters such as language_code and

172

# name. Note that this is only a preference, not requirement. If a

173

# voice of the appropriate gender is not available, the synthesizer should

174

# substitute a voice with a different gender rather than failing the request.

175

"name": "A String", # Optional. The name of the voice. If not set, the service will choose a

176

# voice based on the other parameters such as language_code and

177

# ssml_gender.

178

},

179

"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are

180

# applied on (post synthesized) text to speech. Effects are applied on top of

181

# each other in the order they are given.

"A String",

],

},

"audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.

186

"sampleRateHertz": 42, # The synthesis sample rate (in hertz) for this audio. If not

187

# provided, then the synthesizer will use the default sample rate based on

188

# the audio encoding. If this is different from the voice's natural sample

189

# rate, then the synthesizer will honor this request by converting to the

190

# desired sample rate (which might result in worse audio quality).

191

},

Bu Sun Kim

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

[diff] [blame]

192

"outputAudioConfigMask": "A String", # Mask for output_audio_config indicating which settings in this

Dan O'Meara

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

[diff] [blame]

193

# request-level config should override speech synthesizer settings defined at

194

# agent-level.

Bu Sun Kim

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

[diff] [blame]

195

#

Dan O'Meara

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

[diff] [blame]

196

# If unspecified or empty, output_audio_config replaces the agent-level

197

# config in its entirety.

Bu Sun Kim

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

[diff] [blame]

198

"inputAudio": "A String", # The natural language speech audio to be processed. This field

199

# should be populated iff `query_input` is set to an input audio config.

200

# A single request can contain up to 1 minute of speech audio data.

Bu Sun Kim

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

[diff] [blame]

201

"queryInput": { # Represents the query input. It can contain either: # Required. The input specification. It can be set to:

Dan O'Meara

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

[diff] [blame]

202

#

203

# 1. an audio config

204

# which instructs the speech recognizer how to process the speech audio,

205

#

206

# 2. a conversational query in the form of text, or

207

#

208

# 3. an event that specifies which intent to trigger.

209

#

210

# 1. An audio config which

211

# instructs the speech recognizer how to process the speech audio.

212

#

213

# 2. A conversational query in the form of text.

214

#

215

# 3. An event that specifies which intent to trigger.

Bu Sun Kim

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

[diff] [blame]

216

"audioConfig": { # Instructs the speech recognizer on how to process the audio content. # Instructs the speech recognizer how to process the speech audio.

217

"languageCode": "A String", # Required. The language of the supplied audio. Dialogflow does not do

218

# translations. See [Language

219

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

220

# for a list of the currently supported language codes. Note that queries in

221

# the same session do not necessarily need to specify the same language.

222

"phraseHints": [ # A list of strings containing words and phrases that the speech

223

# recognizer should recognize with higher likelihood.

224

#

225

# See [the Cloud Speech

226

# documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)

227

# for more details.

228

#

229

# This field is deprecated. Please use [speech_contexts]() instead. If you

230

# specify both [phrase_hints]() and [speech_contexts](), Dialogflow will

231

# treat the [phrase_hints]() as a single additional [SpeechContext]().

232

"A String",

233

],

234

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in

235

# StreamingRecognitionResult with information about the recognized speech

236

# words, e.g. start and end time offsets. If false or unspecified, Speech

237

# doesn't return any word-level information.

238

"model": "A String", # Which Speech model to select for the given request. Select the

239

# model best suited to your domain to get best results. If a model is not

240

# explicitly specified, then we auto-select a model based on the parameters

241

# in the InputAudioConfig.

242

# If enhanced speech model is enabled for the agent and an enhanced

243

# version of the specified model for the language does not exist, then the

244

# speech is recognized using the standard version of the specified model.

245

# Refer to

246

# [Cloud Speech API

247

# documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)

248

# for more details.

249

"audioEncoding": "A String", # Required. Audio encoding of the audio content to process.

250

"modelVariant": "A String", # Which variant of the Speech model to use.

251

"speechContexts": [ # Context information to assist speech recognition.

252

#

253

# See [the Cloud Speech

254

# documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)

255

# for more details.

256

{ # Hints for the speech recognizer to help with recognition in a specific

257

# conversation state.

258

"boost": 3.14, # Optional. Boost for this context compared to other contexts:

259

#

260

# * If the boost is positive, Dialogflow will increase the probability that

261

# the phrases in this context are recognized over similar sounding phrases.

262

# * If the boost is unspecified or non-positive, Dialogflow will not apply

263

# any boost.

264

#

265

# Dialogflow recommends that you use boosts in the range (0, 20] and that you

266

# find a value that fits your use case with binary search.

267

"phrases": [ # Optional. A list of strings containing words and phrases that the speech

268

# recognizer should recognize with higher likelihood.

269

#

270

# This list can be used to:

271

#

272

# * improve accuracy for words and phrases you expect the user to say,

273

# e.g. typical commands for your Dialogflow agent

274

# * add additional words to the speech recognizer vocabulary

275

# * ...

276

#

277

# See the [Cloud Speech

278

# documentation](https://cloud.google.com/speech-to-text/quotas) for usage

# limits.

"A String",

],

},

],

"singleUtterance": True or False, # If `false` (default), recognition does not cease until the

285

# client closes the stream.

286

# If `true`, the recognizer will detect a single spoken utterance in input

287

# audio. Recognition ceases when it detects the audio's voice has

288

# stopped or paused. In this case, once a detected intent is received, the

289

# client should close the stream and start a new request with a new stream as

290

# needed.

291

# Note: This setting is relevant only for streaming methods.

292

# Note: When specified, InputAudioConfig.single_utterance takes precedence

293

# over StreamingDetectIntentRequest.single_utterance.

294

"sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query.

295

# Refer to

296

# [Cloud Speech API

297

# documentation](https://cloud.google.com/speech-to-text/docs/basics) for

298

# more details.

299

},

Bu Sun Kim

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

[diff] [blame]

300

"event": { # Events allow for matching intents by event name instead of the natural # The event to be processed.

301

# language input. For instance, input `<event: { name: "welcome_event",

302

# parameters: { name: "Sam" } }>` can trigger a personalized welcome response.

303

# The parameter `name` may be used by the agent in the response:

304

# `"Hello #welcome_event.name! What can I do for you today?"`.

305

"languageCode": "A String", # Required. The language of this query. See [Language

306

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

307

# for a list of the currently supported language codes. Note that queries in

308

# the same session do not necessarily need to specify the same language.

Bu Sun Kim

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

[diff] [blame]

309

"parameters": { # The collection of parameters associated with the event.

310

#

311

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

312

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

313

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

314

#

315

# - MapKey type: string

316

# - MapKey value: parameter name

317

# - MapValue type:

318

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

319

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

320

# - MapValue value:

321

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

322

# map from composite entity property names to property values

323

# - Else: parameter value

324

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

325

},

Bu Sun Kim

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

[diff] [blame]

326

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

Bu Sun Kim

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

[diff] [blame]

327

},

Bu Sun Kim

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

[diff] [blame]

328

"text": { # Represents the natural language text to be processed. # The natural language text to be processed.

329

"text": "A String", # Required. The UTF-8 encoded natural language text to be processed.

Dan O'Meara

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

[diff] [blame]

330

# Text length must not exceed 256 characters.

Bu Sun Kim

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

[diff] [blame]

331

"languageCode": "A String", # Required. The language of this conversational query. See [Language

Dan O'Meara

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

[diff] [blame]

332

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

333

# for a list of the currently supported language codes. Note that queries in

334

# the same session do not necessarily need to specify the same language.

335

},

Dan O'Meara

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

[diff] [blame]

336

},

Bu Sun Kim

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

[diff] [blame]

337

"queryParams": { # Represents the parameters of the conversational query. # The parameters of this query.

Bu Sun Kim

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

[diff] [blame]

338

"sessionEntityTypes": [ # Additional session entity types to replace or extend developer

339

# entity types with. The entity synonyms apply to all languages and persist

340

# for the session of this query.

341

{ # A session represents a conversation between a Dialogflow agent and an

342

# end-user. You can create special entities, called session entities, during a

343

# session. Session entities can extend or replace custom entity types and only

344

# exist during the session that they were created for. All session data,

345

# including session entities, is stored by Dialogflow for 20 minutes.

346

#

347

# For more information, see the [session entity

348

# guide](https://cloud.google.com/dialogflow/docs/entities-session).

349

"name": "A String", # Required. The unique identifier of this session entity type. Format:

350

# `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type

351

# Display Name>`, or

352

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

353

# ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`.

354

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

355

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

356

#

357

# `<Entity Type Display Name>` must be the display name of an existing entity

358

# type in the same agent that will be overridden or supplemented.

359

"entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or

360

# supplement the custom entity type definition.

361

"entities": [ # Required. The collection of entities associated with this session entity

362

# type.

363

{ # An **entity entry** for an associated entity type.

364

"synonyms": [ # Required. A collection of value synonyms. For example, if the entity type

365

# is *vegetable*, and `value` is *scallions*, a synonym could be *green

366

# onions*.

367

#

368

# For `KIND_LIST` entity types:

369

#

370

# * This collection must contain exactly one synonym equal to `value`.

371

"A String",

372

],

373

"value": "A String", # Required. The primary value associated with this entity entry.

374

# For example, if the entity type is *vegetable*, the value could be

375

# *scallions*.

376

#

377

# For `KIND_MAP` entity types:

378

#

379

# * A reference value to be used in place of synonyms.

380

#

381

# For `KIND_LIST` entity types:

382

#

383

# * A string that can contain references to other entity types (with or

# without aliases).

},

],

},

Bu Sun Kim

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

[diff] [blame]

388

],

Bu Sun Kim

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

[diff] [blame]

389

"sentimentAnalysisRequestConfig": { # Configures the types of sentiment analysis to perform. # Configures the type of sentiment analysis to perform. If not

390

# provided, sentiment analysis is not performed.

391

# Note: Sentiment Analysis is only currently available for Enterprise Edition

392

# agents.

393

"analyzeQueryTextSentiment": True or False, # Instructs the service to perform sentiment analysis on

394

# `query_text`. If not provided, sentiment analysis is not performed on

395

# `query_text`.

396

},

Bu Sun Kim

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

[diff] [blame]

397

"contexts": [ # The collection of contexts to be activated before this query is

398

# executed.

Bu Sun Kim

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

[diff] [blame]

399

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

400

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

401

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

402

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

403

# an intent.

404

#

405

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

406

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

407

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

408

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

409

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

410

# contexts that correspond to the currently active contexts.

411

#

412

# For more information about context, see the

413

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

414

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

415

#

416

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

417

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

418

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

419

#

420

# - MapKey type: string

421

# - MapKey value: parameter name

422

# - MapValue type:

423

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

424

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

425

# - MapValue value:

426

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

427

# map from composite entity property names to property values

428

# - Else: parameter value

429

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

430

},

Bu Sun Kim

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

[diff] [blame]

431

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

432

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

433

# immediately. Contexts expire automatically after 20 minutes if there

434

# are no matching queries.

435

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

436

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

437

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

438

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

439

#

440

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

441

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

442

#

443

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

444

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

445

#

446

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

447

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

448

#

449

# * `__system_counters__`

450

# * `*_id_dialog_context`

451

# * `*_dialog_params_size`

Bu Sun Kim

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

[diff] [blame]

452

},

453

],

Bu Sun Kim

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

[diff] [blame]

454

"geoLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # The geo location of this conversational query.

455

# of doubles representing degrees latitude and degrees longitude. Unless

456

# specified otherwise, this must conform to the

457

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

458

# standard</a>. Values must be within normalized ranges.

459

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

460

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

Bu Sun Kim

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

[diff] [blame]

461

},

Bu Sun Kim

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

[diff] [blame]

462

"knowledgeBaseNames": [ # KnowledgeBases to get alternative results from. If not set, the

463

# KnowledgeBases enabled in the agent (through UI) will be used.

464

# Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.

465

"A String",

Bu Sun Kim

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

[diff] [blame]

466

],

Bu Sun Kim

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

[diff] [blame]

467

"subAgents": [ # For mega agent query, directly specify which sub agents to query.

468

# If any specified sub agent is not linked to the mega agent, an error will

469

# be returned. If empty, Dialogflow will decide which sub agents to query.

470

# If specified for a non-mega-agent query, will be silently ignored.

471

{ # Contains basic configuration for a sub-agent.

Bu Sun Kim

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

[diff] [blame]

472

"environment": "A String", # Optional. The unique identifier (`environment name` in dialogflow console)

473

# of this sub-agent environment. Assumes draft environment if `environment`

474

# is not set.

Bu Sun Kim

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

[diff] [blame]

475

"project": "A String", # Required. The project of this agent.

476

# Format: `projects/<Project ID>`.

Bu Sun Kim

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

[diff] [blame]

477

},

478

],

Bu Sun Kim

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

[diff] [blame]

479

"resetContexts": True or False, # Specifies whether to delete all contexts in the current session

480

# before the new ones are activated.

481

"payload": { # This field can be used to pass custom data to your webhook.

482

# Arbitrary JSON objects are supported.

483

# If supplied, the value is used to populate the

484

# `WebhookRequest.original_detect_intent_request.payload`

485

# field sent to your webhook.

486

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

Bu Sun Kim

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

[diff] [blame]

487

},

Bu Sun Kim

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

[diff] [blame]

488

"timeZone": "A String", # The time zone of this conversational query from the

489

# [time zone database](https://www.iana.org/time-zones), e.g.,

490

# America/New_York, Europe/Paris. If not provided, the time zone specified in

491

# agent settings is used.

492

"webhookHeaders": { # This field can be used to pass HTTP headers for a webhook

493

# call. These headers will be sent to webhook alone with the headers that

494

# have been configured through Dialogflow web console. The headers defined

495

# within this field will overwrite the headers configured through Dialogflow

496

# console if there is a conflict. Header names are case-insensitive.

497

# Google's specified headers are not allowed. Including: "Host",

498

# "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",

499

# "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.

500

"a_key": "A String",

501

},

Bu Sun Kim

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

[diff] [blame]

502

},

Bu Sun Kim

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

[diff] [blame]

503

}

504

505

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

512

513

{ # The message returned from the DetectIntent method.

Bu Sun Kim

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

[diff] [blame]

514

"alternativeQueryResults": [ # If Knowledge Connectors are enabled, there could be more than one result

515

# returned for a given query or event, and this field will contain all

516

# results except for the top one, which is captured in query_result. The

517

# alternative results are ordered by decreasing

518

# `QueryResult.intent_detection_confidence`. If Knowledge Connectors are

519

# disabled, this field will be empty until multiple responses for regular

520

# intents are supported, at which point those additional results will be

521

# surfaced here.

522

{ # Represents the result of conversational query or event processing.

523

"fulfillmentText": "A String", # The text to be pronounced to the user or shown on the screen.

524

# Note: This is a legacy field, `fulfillment_messages` should be preferred.

525

"parameters": { # The collection of extracted parameters.

526

#

527

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

528

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

529

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

530

#

531

# - MapKey type: string

532

# - MapKey value: parameter name

533

# - MapValue type:

534

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

535

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

536

# - MapValue value:

537

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

538

# map from composite entity property names to property values

539

# - Else: parameter value

540

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

Bu Sun Kim

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

[diff] [blame]

541

},

Bu Sun Kim

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

[diff] [blame]

542

"diagnosticInfo": { # Free-form diagnostic information for the associated detect intent request.

543

# The fields of this data can change without notice, so you should not write

544

# code that depends on its structure.

545

# The data may contain:

Bu Sun Kim

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

[diff] [blame]

546

#

Bu Sun Kim

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

[diff] [blame]

547

# - webhook call latency

548

# - webhook errors

549

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

550

},

551

"languageCode": "A String", # The language that was triggered during intent detection.

552

# See [Language

553

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

554

# for a list of the currently supported language codes.

555

"outputContexts": [ # The collection of output contexts. If applicable,

556

# `output_contexts.parameters` contains entries with name

557

# `<parameter name>.original` containing the original parameter values

558

# before the query.

559

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

560

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

561

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

562

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

563

# an intent.

564

#

565

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

566

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

567

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

568

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

569

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

570

# contexts that correspond to the currently active contexts.

571

#

572

# For more information about context, see the

573

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

574

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

Bu Sun Kim

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

[diff] [blame]

575

#

Bu Sun Kim

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

[diff] [blame]

576

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

577

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

578

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

Bu Sun Kim

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

[diff] [blame]

579

#

Bu Sun Kim

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

[diff] [blame]

580

# - MapKey type: string

581

# - MapKey value: parameter name

582

# - MapValue type:

583

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

584

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

585

# - MapValue value:

586

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

587

# map from composite entity property names to property values

588

# - Else: parameter value

589

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

590

},

Bu Sun Kim

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

[diff] [blame]

591

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

592

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

593

# immediately. Contexts expire automatically after 20 minutes if there

594

# are no matching queries.

595

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

Dan O'Meara

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

[diff] [blame]

596

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

597

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

598

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

Bu Sun Kim

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

[diff] [blame]

599

#

600

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

601

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

602

#

Bu Sun Kim

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

[diff] [blame]

603

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

604

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

Dan O'Meara

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

[diff] [blame]

605

#

606

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

607

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

608

#

609

# * `__system_counters__`

610

# * `*_id_dialog_context`

611

# * `*_dialog_params_size`

Bu Sun Kim

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

[diff] [blame]

612

},

613

],

Bu Sun Kim

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

[diff] [blame]

614

"queryText": "A String", # The original conversational query text:

615

#

616

# - If natural language text was provided as input, `query_text` contains

617

# a copy of the input.

618

# - If natural language speech audio was provided as input, `query_text`

619

# contains the speech recognition result. If speech recognizer produced

620

# multiple alternatives, a particular one is picked.

621

# - If automatic spell correction is enabled, `query_text` will contain the

622

# corrected user input.

623

"intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0

624

# (completely uncertain) to 1.0 (completely certain).

625

# This value is for informational purpose only and is only used to

626

# help match the best intent within the classification threshold.

627

# This value may change for the same end-user expression at any time due to a

628

# model retraining or change in implementation.

629

# If there are `multiple knowledge_answers` messages, this value is set to

630

# the greatest `knowledgeAnswers.match_confidence` value in the list.

631

"webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the

632

# value of the `payload` field returned in the webhook response.

633

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

634

},

635

"speechRecognitionConfidence": 3.14, # The Speech recognition confidence between 0.0 and 1.0. A higher number

636

# indicates an estimated greater likelihood that the recognized words are

637

# correct. The default of 0.0 is a sentinel value indicating that confidence

638

# was not set.

639

#

640

# This field is not guaranteed to be accurate or set. In particular this

641

# field isn't set for StreamingDetectIntent since the streaming endpoint has

642

# separate confidence estimates per portion of the audio in

643

# StreamingRecognitionResult.

644

"sentimentAnalysisResult": { # The result of sentiment analysis. Sentiment analysis inspects user input # The sentiment analysis result, which depends on the

645

# `sentiment_analysis_request_config` specified in the request.

646

# and identifies the prevailing subjective opinion, especially to determine a

647

# user's attitude as positive, negative, or neutral.

648

# For Participants.AnalyzeContent, it needs to be configured in

649

# DetectIntentRequest.query_params. For

650

# Participants.StreamingAnalyzeContent, it needs to be configured in

651

# StreamingDetectIntentRequest.query_params.

652

# And for Participants.AnalyzeContent and

653

# Participants.StreamingAnalyzeContent, it needs to be configured in

654

# ConversationProfile.human_agent_assistant_config

655

"queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.

656

# of analysis, such as the query text.

657

"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute

658

# magnitude of sentiment, regardless of score (positive or negative).

659

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive

# sentiment).

},

},

"action": "A String", # The action name from the matched intent.

664

"allRequiredParamsPresent": True or False, # This field is set to:

665

#

666

# - `false` if the matched intent has required parameters and not all of

667

# the required parameter values have been collected.

668

# - `true` if all required parameter values have been collected, or if the

669

# matched intent doesn't contain any required parameters.

670

"fulfillmentMessages": [ # The collection of rich messages to present to the user.

Bu Sun Kim

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

[diff] [blame]

671

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

Bu Sun Kim

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

[diff] [blame]

672

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

673

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

674

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

675

# to the conversation.

676

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

681

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

682

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

683

{ # Response media object for media content card.

684

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

685

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

686

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

687

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

688

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

689

},

690

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

691

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

692

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

693

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

694

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

695

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

701

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

702

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

703

#

704

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

705

},

706

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

707

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

708

# Telephony Gateway.

709

#

710

# Telephony Gateway takes the synthesizer settings from

711

# `DetectIntentResponse.output_audio_config` which can either be set

712

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

713

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

714

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

715

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

716

},

717

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

718

# or website associated with this agent.

719

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

720

# suggestion chip.

721

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

722

},

723

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

724

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

Bu Sun Kim

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

[diff] [blame]

725

"A String",

Bu Sun Kim

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

[diff] [blame]

726

],

Bu Sun Kim

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

[diff] [blame]

727

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

728

},

729

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

730

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

731

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

732

{ # Optional. Contains information about a button.

733

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

734

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

739

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

740

},

741

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

742

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

743

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

744

"items": [ # Required. List items.

745

{ # An item in the list.

746

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

747

# dialog.

748

"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

753

# response is given.

754

},

755

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

756

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

757

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

758

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

759

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

760

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

766

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

767

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

768

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

769

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

770

},

771

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

772

},

773

],

774

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

775

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

776

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

777

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

778

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

779

},

780

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

781

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

782

},

783

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

784

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

785

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

786

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

Bu Sun Kim

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

[diff] [blame]

787

},

Bu Sun Kim

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

[diff] [blame]

788

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

Dan O'Meara

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

[diff] [blame]

789

#

790

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

791

# with media and suggestions.

792

#

Dan O'Meara

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

[diff] [blame]

793

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

794

# please use RbmStandaloneCard instead.

Bu Sun Kim

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

[diff] [blame]

795

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

Bu Sun Kim

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

[diff] [blame]

796

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

Dan O'Meara

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

[diff] [blame]

797

# 2 cards and at most 10.

798

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

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

[diff] [blame]

799

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

800

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

801

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

Bu Sun Kim

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

[diff] [blame]

806

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

818

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

819

# within a rich card with a vertical layout.

Dan O'Meara

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

[diff] [blame]

820

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

821

# customizable, and this field is ignored.

Bu Sun Kim

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

[diff] [blame]

822

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

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

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

Dan O'Meara

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

[diff] [blame]

831

},

Bu Sun Kim

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

[diff] [blame]

832

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

833

#

834

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

835

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

836

#

837

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

Bu Sun Kim

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

[diff] [blame]

838

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

Dan O'Meara

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

[diff] [blame]

839

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

840

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

841

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

842

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

843

# can choose from the card.

Bu Sun Kim

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

[diff] [blame]

844

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

845

# If the user has an app installed that is

846

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

847

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

848

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

849

},

850

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

851

# to send back to the agent.

852

},

853

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

Bu Sun Kim

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

[diff] [blame]

854

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

855

# but does not dial automatically.

Bu Sun Kim

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

[diff] [blame]

856

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

857

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

858

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

859

# +15556767888.

860

},

Bu Sun Kim

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

[diff] [blame]

861

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

862

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

863

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame]

864

},

865

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

866

# instead of typing in their own response.

867

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

868

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

869

# forwarded to webhook to allow performing custom business logic.

870

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

Dan O'Meara

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

[diff] [blame]

871

},

872

},

873

],

Bu Sun Kim

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

[diff] [blame]

874

},

875

],

876

},

Bu Sun Kim

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

[diff] [blame]

877

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

878

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

Bu Sun Kim

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

[diff] [blame]

879

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

880

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

881

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

882

},

Bu Sun Kim

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

[diff] [blame]

883

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

Bu Sun Kim

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

[diff] [blame]

884

},

885

],

Bu Sun Kim

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

[diff] [blame]

886

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

Bu Sun Kim

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

[diff] [blame]

887

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

888

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

889

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

890

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

891

},

Bu Sun Kim

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

[diff] [blame]

892

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

893

{ # Row of TableCard.

894

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

895

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

896

{ # Cell of TableCardRow.

897

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

902

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

Bu Sun Kim

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

[diff] [blame]

903

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

904

{ # Column properties for TableCard.

905

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

906

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

907

},

908

],

Bu Sun Kim

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

[diff] [blame]

909

},

Bu Sun Kim

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

[diff] [blame]

910

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

911

#

912

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

913

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

914

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

915

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

916

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

917

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

918

# opening a web uri).

919

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

920

# can choose from the card.

921

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

922

# If the user has an app installed that is

923

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

924

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

925

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

926

},

927

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

928

# to send back to the agent.

929

},

930

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

931

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

932

# but does not dial automatically.

933

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

934

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

935

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

936

# +15556767888.

937

},

938

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

939

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

940

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame]

941

},

Bu Sun Kim

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

[diff] [blame]

942

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

943

# instead of typing in their own response.

944

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

945

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

946

# forwarded to webhook to allow performing custom business logic.

947

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

Bu Sun Kim

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

[diff] [blame]

948

},

Bu Sun Kim

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

[diff] [blame]

949

},

950

],

951

},

Bu Sun Kim

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

[diff] [blame]

952

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

953

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

Bu Sun Kim

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

[diff] [blame]

954

},

Bu Sun Kim

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

[diff] [blame]

955

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

956

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

957

"A String",

Bu Sun Kim

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

[diff] [blame]

958

],

959

},

Bu Sun Kim

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

[diff] [blame]

960

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

Dan O'Meara

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

[diff] [blame]

961

#

962

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

963

# with media and suggestions.

964

#

Dan O'Meara

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

[diff] [blame]

965

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

966

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

Bu Sun Kim

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

[diff] [blame]

967

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

Bu Sun Kim

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

[diff] [blame]

968

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

969

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

970

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

Bu Sun Kim

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

[diff] [blame]

975

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

987

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

988

# within a rich card with a vertical layout.

Dan O'Meara

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

[diff] [blame]

989

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

990

# customizable, and this field is ignored.

Bu Sun Kim

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

[diff] [blame]

991

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

992

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

993

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

994

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

995

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

996

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

997

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

998

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

999

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

Dan O'Meara

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

[diff] [blame]

1000

},

Bu Sun Kim

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

[diff] [blame]

1001

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

1002

#

1003

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

1004

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

1005

#

1006

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

Bu Sun Kim

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

[diff] [blame]

1007

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

Dan O'Meara

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

[diff] [blame]

1008

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

1009

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

1010

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

1011

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

1012

# can choose from the card.

Bu Sun Kim

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

[diff] [blame]

1013

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

1014

# If the user has an app installed that is

1015

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

1016

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

1017

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

1018

},

1019

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

1020

# to send back to the agent.

1021

},

1022

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

Bu Sun Kim

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

[diff] [blame]

1023

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

1024

# but does not dial automatically.

Bu Sun Kim

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

[diff] [blame]

1025

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

1026

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

1027

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

1028

# +15556767888.

1029

},

Bu Sun Kim

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

[diff] [blame]

1030

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

1031

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

1032

# forwarded to webhook to allow performing custom business logic.

Dan O'Meara

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

[diff] [blame]

1033

},

Bu Sun Kim

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

[diff] [blame]

1034

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

1035

# instead of typing in their own response.

Bu Sun Kim

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

[diff] [blame]

1036

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

1037

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

1038

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame]

1039

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

Bu Sun Kim

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

[diff] [blame]

1040

},

Bu Sun Kim

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

[diff] [blame]

1041

},

1042

],

1043

},

Bu Sun Kim

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

[diff] [blame]

1044

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

1045

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

1046

# Image preview alignment for standalone cards with horizontal layout.

1047

},

1048

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

1049

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

1050

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

1051

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

Bu Sun Kim

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

[diff] [blame]

1052

#

Bu Sun Kim

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

[diff] [blame]

1053

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

1054

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

1055

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

1056

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

1057

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

1058

# added by default when enabling the Dialogflow V2 API.

Bu Sun Kim

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

[diff] [blame]

1059

#

Bu Sun Kim

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

[diff] [blame]

1060

# For audio from other sources, consider using the

1061

# `TelephonySynthesizeSpeech` message with SSML.

1062

},

1063

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

1064

"items": [ # Required. Carousel items.

1065

{ # An item in the carousel.

1066

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

1067

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

1068

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

1069

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

Bu Sun Kim

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

[diff] [blame]

1070

},

Bu Sun Kim

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

[diff] [blame]

1071

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

1072

# dialog.

1073

"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

1078

# response is given.

1079

},

1080

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

1081

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

1086

# This message in `QueryResult.fulfillment_messages` and

1087

# `WebhookResponse.fulfillment_messages` should contain only one

1088

# `SimpleResponse`.

1089

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

1090

{ # The simple response message containing speech or text.

1091

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

1092

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

1093

# text_to_speech.

1094

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

1095

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

1096

# speech output. Mutually exclusive with ssml.

},

],

},

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

1101

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

1102

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

1103

# items.

1104

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

1105

# items, maximum of ten.

1106

{ # Browsing carousel tile

1107

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

1108

# Card. Maximum of one line of text.

1109

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

1110

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

1111

# text.

1112

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

1113

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

1114

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

1115

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

1116

},

1117

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

1118

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

1119

# the URL. Defaults to opening via web browser.

1120

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

Bu Sun Kim

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

[diff] [blame]

1121

},

1122

},

1123

],

Bu Sun Kim

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

[diff] [blame]

1124

},

1125

},

Bu Sun Kim

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

[diff] [blame]

1126

],

1127

"intent": { # An intent categorizes an end-user's intention for one conversation turn. For # The intent that matched the conversational query. Some, not

Bu Sun Kim

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

[diff] [blame]

1128

# all fields are filled in this message, including but not limited to:

Dan O'Meara

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

[diff] [blame]

1129

# `name`, `display_name`, `end_interaction` and `is_fallback`.

Bu Sun Kim

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

[diff] [blame]

1130

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

1131

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

1132

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

1133

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

1134

# intent classification.

1135

#

1136

# For more information, see the [intent

1137

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

Bu Sun Kim

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

[diff] [blame]

1138

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

1139

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

1140

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

Bu Sun Kim

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

[diff] [blame]

1141

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

1142

# Note: The action name must not contain whitespaces.

1143

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

Bu Sun Kim

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

[diff] [blame]

1144

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

1145

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

1146

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

1147

# when the intent is matched.

1148

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

Bu Sun Kim

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

[diff] [blame]

1149

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

1150

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

1151

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

1152

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

1153

# an intent.

1154

#

1155

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

1156

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

1157

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

1158

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

1159

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

1160

# contexts that correspond to the currently active contexts.

1161

#

1162

# For more information about context, see the

1163

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

1164

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

1165

#

1166

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

1167

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

1168

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

1169

#

1170

# - MapKey type: string

1171

# - MapKey value: parameter name

1172

# - MapValue type:

1173

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

1174

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

1175

# - MapValue value:

1176

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

1177

# map from composite entity property names to property values

1178

# - Else: parameter value

1179

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

1180

},

Bu Sun Kim

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

[diff] [blame]

1181

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

1182

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

1183

# immediately. Contexts expire automatically after 20 minutes if there

1184

# are no matching queries.

1185

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

1186

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

1187

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

1188

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

1189

#

1190

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

1191

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

1192

#

1193

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

1194

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

1195

#

1196

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

1197

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

1198

#

1199

# * `__system_counters__`

1200

# * `*_id_dialog_context`

1201

# * `*_dialog_params_size`

Bu Sun Kim

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

[diff] [blame]

1202

},

1203

],

Bu Sun Kim

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

[diff] [blame]

1204

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

1205

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

1206

# session when this intent is matched.

1207

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

1208

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

1209

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

1210

# auto-markup in the UI is turned off.

1211

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

1212

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

1213

# this intent.

1214

#

1215

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

1216

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

1217

# trained on.

1218

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

1219

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

1220

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

1221

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

1222

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

1223

#

1224

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

1225

# Dialogflow Console does.

1226

#

1227

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

1228

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

1229

#

1230

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

1231

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

1232

#

1233

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

1234

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

1235

#

1236

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

1237

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

1238

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

1239

# set.

1240

{ # Represents a part of a training phrase.

1241

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

1242

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

1243

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

1244

# API, you must set this to true.

1245

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

1246

# annotated part of the example.

1247

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

1248

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

1249

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

1250

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

1251

},

1252

],

1253

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

1254

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

1255

# intent or training, this counter is increased.

1256

},

Bu Sun Kim

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

[diff] [blame]

1257

],

1258

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

1259

# `Response` field in the Dialogflow console.

1260

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

Bu Sun Kim

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

[diff] [blame]

1261

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

1262

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

1263

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

1264

# to the conversation.

1265

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

1270

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

1271

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

1272

{ # Response media object for media content card.

1273

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

1274

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

1275

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

1276

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

1277

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

1278

},

1279

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

1280

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

1281

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

1282

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

1283

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

1284

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

1290

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

1291

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

1292

#

1293

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

1294

},

1295

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

1296

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

1297

# Telephony Gateway.

1298

#

1299

# Telephony Gateway takes the synthesizer settings from

1300

# `DetectIntentResponse.output_audio_config` which can either be set

1301

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

1302

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

1303

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

1304

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

1305

},

1306

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

1307

# or website associated with this agent.

1308

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

1309

# suggestion chip.

1310

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

1311

},

1312

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

1313

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

Bu Sun Kim

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

[diff] [blame]

1314

"A String",

1315

],

Bu Sun Kim

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

[diff] [blame]

1316

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

1317

},

1318

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

1319

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

1320

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

1321

{ # Optional. Contains information about a button.

1322

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

1323

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

1328

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

1329

},

1330

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

1331

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

1332

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

1333

"items": [ # Required. List items.

1334

{ # An item in the list.

1335

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

1336

# dialog.

1337

"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

1342

# response is given.

1343

},

1344

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

1345

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

1346

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

1347

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

1348

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

1349

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

1355

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

1356

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

1357

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

1358

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

1359

},

1360

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

1361

},

1362

],

1363

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

1364

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

1365

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

1366

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

1367

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

1368

},

1369

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

1370

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

1371

},

1372

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

1373

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

1374

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

1375

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

Bu Sun Kim

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

[diff] [blame]

1376

},

1377

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

1378

#

1379

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

1380

# with media and suggestions.

1381

#

Bu Sun Kim

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

[diff] [blame]

1382

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

1383

# please use RbmStandaloneCard instead.

Bu Sun Kim

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

[diff] [blame]

1384

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

Bu Sun Kim

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

[diff] [blame]

1385

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

1386

# 2 cards and at most 10.

1387

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

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

[diff] [blame]

1388

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

1389

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

1390

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

1407

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

1408

# within a rich card with a vertical layout.

Bu Sun Kim

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

[diff] [blame]

1409

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

1410

# customizable, and this field is ignored.

1411

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

1412

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

1413

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

1414

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

1415

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

1416

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

1417

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

1418

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

1419

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

Bu Sun Kim

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

[diff] [blame]

1420

},

Bu Sun Kim

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

[diff] [blame]

1421

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

1422

#

1423

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

1424

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

1425

#

1426

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

Bu Sun Kim

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

[diff] [blame]

1427

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

1428

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

1429

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

1430

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

1431

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

1432

# can choose from the card.

Bu Sun Kim

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

[diff] [blame]

1433

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

1434

# If the user has an app installed that is

1435

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

1436

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

1437

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

1438

},

1439

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

1440

# to send back to the agent.

1441

},

1442

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

Bu Sun Kim

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

[diff] [blame]

1443

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

1444

# but does not dial automatically.

Bu Sun Kim

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

[diff] [blame]

1445

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

1446

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

1447

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

1448

# +15556767888.

1449

},

Bu Sun Kim

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

[diff] [blame]

1450

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

1451

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

1452

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame]

1453

},

1454

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

1455

# instead of typing in their own response.

1456

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

1457

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

1458

# forwarded to webhook to allow performing custom business logic.

1459

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

Bu Sun Kim

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

[diff] [blame]

1460

},

1461

},

1462

],

Bu Sun Kim

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

[diff] [blame]

1463

},

1464

],

1465

},

Bu Sun Kim

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

[diff] [blame]

1466

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

1467

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

Bu Sun Kim

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

[diff] [blame]

1468

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

1469

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

1470

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

1471

},

Bu Sun Kim

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

[diff] [blame]

1472

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

Bu Sun Kim

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

[diff] [blame]

1473

},

1474

],

Bu Sun Kim

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

[diff] [blame]

1475

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

Bu Sun Kim

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

[diff] [blame]

1476

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

1477

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

1478

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

1479

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

1480

},

Bu Sun Kim

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

[diff] [blame]

1481

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

1482

{ # Row of TableCard.

1483

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

1484

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

1485

{ # Cell of TableCardRow.

1486

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1491

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

Bu Sun Kim

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

[diff] [blame]

1492

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

1493

{ # Column properties for TableCard.

1494

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

1495

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

1496

},

1497

],

Bu Sun Kim

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

[diff] [blame]

1498

},

Bu Sun Kim

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

[diff] [blame]

1499

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

1500

#

1501

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

1502

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

1503

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

1504

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

1505

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

1506

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

1507

# opening a web uri).

1508

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

1509

# can choose from the card.

1510

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

1511

# If the user has an app installed that is

1512

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

1513

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

1514

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

1515

},

1516

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

1517

# to send back to the agent.

1518

},

1519

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

1520

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

1521

# but does not dial automatically.

1522

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

1523

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

1524

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

1525

# +15556767888.

1526

},

1527

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

1528

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

1529

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

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

[diff] [blame]

1530

},

Bu Sun Kim

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

[diff] [blame]

1531

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

1532

# instead of typing in their own response.

1533

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

1534

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

1535

# forwarded to webhook to allow performing custom business logic.

1536

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

Bu Sun Kim

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

[diff] [blame]

1537

},

Bu Sun Kim

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

[diff] [blame]

1538

},

1539

],

1540

},

Bu Sun Kim

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

[diff] [blame]

1541

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

1542

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

Bu Sun Kim

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

[diff] [blame]

1543

},

Bu Sun Kim

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

[diff] [blame]

1544

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

1545

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

1546

"A String",

Bu Sun Kim

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

[diff] [blame]

1547

],

1548

},

Bu Sun Kim

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

[diff] [blame]

1549

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

1550

#

1551

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

1552

# with media and suggestions.

1553

#

Bu Sun Kim

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

[diff] [blame]

1554

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

1555

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

Bu Sun Kim

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

[diff] [blame]

1556

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

Bu Sun Kim

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

[diff] [blame]

1557

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

1558

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

1559

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

1576

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

1577

# within a rich card with a vertical layout.

Bu Sun Kim

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

[diff] [blame]

1578

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

1579

# customizable, and this field is ignored.

1580

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

1581

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

1582

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

1583

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

1584

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

1585

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

1586

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

1587

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

1588

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

Bu Sun Kim

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

[diff] [blame]

1589

},

Bu Sun Kim

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

[diff] [blame]

1590

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

1591

#

1592

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

1593

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

1594

#

1595

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

Bu Sun Kim

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

[diff] [blame]

1596

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

1597

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

1598

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

1599

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

1600

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

1601

# can choose from the card.

Bu Sun Kim

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

[diff] [blame]

1602

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

1603

# If the user has an app installed that is

1604

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

1605

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

1606

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

1607

},

1608

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

1609

# to send back to the agent.

1610

},

1611

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

Bu Sun Kim

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

[diff] [blame]

1612

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

1613

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1614

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1615

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1616

# format. An example of a correctly formatted phone number:

1617

# +15556767888.

1618

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1619

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1620

# when the user taps the suggested action. This data will be also

1621

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1622

},

1623

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1624

# instead of typing in their own response.

1625

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1626

# when the user taps the suggested reply. This data will be also

1627

# forwarded to webhook to allow performing custom business logic.

1628

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1629

},

1630

},

1631

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1632

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1633

"cardOrientation": "A String", # Required. Orientation of the card.

1634

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

1635

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1636

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1637

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

1638

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

1639

# play, e.g., "gs://bucket/object". The object must contain a single

1640

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

1641

#

1642

# This object must be readable by the `service-<Project

1643

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

1644

# where <Project Number> is the number of the Telephony Gateway project

1645

# (usually the same as the Dialogflow agent project). If the Google Cloud

1646

# Storage bucket is in the Telephony Gateway project, this permission is

1647

# added by default when enabling the Dialogflow V2 API.

1648

#

1649

# For audio from other sources, consider using the

1650

# `TelephonySynthesizeSpeech` message with SSML.

1651

},

1652

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

1653

"items": [ # Required. Carousel items.

1654

{ # An item in the carousel.

1655

"image": { # The image response message. # Optional. The image to display.

1656

"imageUri": "A String", # Optional. The public URI to an image file.

1657

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1658

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1659

},

1660

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

1661

# dialog.

1662

"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

1667

# response is given.

1668

},

1669

"title": "A String", # Required. Title of the carousel item.

1670

"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.

1675

# This message in `QueryResult.fulfillment_messages` and

1676

# `WebhookResponse.fulfillment_messages` should contain only one

1677

# `SimpleResponse`.

1678

"simpleResponses": [ # Required. The list of simple responses.

1679

{ # The simple response message containing speech or text.

1680

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

1681

# response to the user in the SSML format. Mutually exclusive with

1682

# text_to_speech.

1683

"displayText": "A String", # Optional. The text to display.

1684

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

1685

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

1690

# https://developers.google.com/actions/assistant/responses#browsing_carousel

1691

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

1692

# items.

1693

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

1694

# items, maximum of ten.

1695

{ # Browsing carousel tile

1696

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

1697

# Card. Maximum of one line of text.

1698

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

1699

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

1700

# text.

1701

"image": { # The image response message. # Optional. Hero image for the carousel item.

1702

"imageUri": "A String", # Optional. The public URI to an image file.

1703

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1704

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1705

},

1706

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1707

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

1708

# the URL. Defaults to opening via web browser.

1709

"url": "A String", # Required. URL

1710

},

1711

},

1712

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1713

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1714

},

1715

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1716

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

1717

# chain of followup intents. You can set this field when creating an intent,

1718

# for example with CreateIntent or

1719

# BatchUpdateIntents, in order to make this

1720

# intent a followup intent.

1721

#

1722

# It identifies the parent followup intent.

1723

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1724

"parameters": [ # Optional. The collection of parameters associated with the intent.

1725

{ # Represents intent parameters.

1726

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1727

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

1728

# whether the intent cannot be completed without collecting the parameter

1729

# value.

1730

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1731

# user in order to collect a value for the parameter.

1732

"A String",

1733

],

1734

"name": "A String", # The unique identifier of this parameter.

1735

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1736

# describes values of the parameter. If the parameter is

1737

# required, this must be provided.

1738

"displayName": "A String", # Required. The name of the parameter.

1739

"value": "A String", # Optional. The definition of the parameter value. It can be:

1740

#

1741

# - a constant string,

1742

# - a parameter value defined as `$parameter_name`,

1743

# - an original parameter value defined as `$parameter_name.original`,

1744

# - a parameter value from some context defined as

1745

# `#context_name.parameter_name`.

1746

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1747

# result.

1748

# Default values can be extracted from contexts by using the following

1749

# syntax: `#context_name.parameter_name`.

1750

},

1751

],

1752

"events": [ # Optional. The collection of event names that trigger the intent.

1753

# If the collection of input contexts is not empty, all of the contexts must

1754

# be present in the active user session for an event to trigger this intent.

1755

# Event names are limited to 150 characters.

1756

"A String",

1757

],

1758

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1759

"name": "A String", # Optional. The unique identifier of this intent.

1760

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1761

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1762

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1763

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

1764

# Note: If `ml_enabled` setting is set to false, then this intent is not

1765

# taken into account during inference in `ML ONLY` match mode. Also,

1766

# auto-markup in the UI is turned off.

1767

# DEPRECATED! Please use `ml_disabled` field instead.

1768

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

1769

# then the default value is determined as follows:

1770

# - Before April 15th, 2018 the default is:

1771

# ml_enabled = false / ml_disabled = true.

1772

# - After April 15th, 2018 the default is:

1773

# ml_enabled = true / ml_disabled = false.

1774

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

1775

# a direct or indirect parent. We populate this field only in the output.

1776

{ # Represents a single followup intent in the chain.

1777

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

1778

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1779

"followupIntentName": "A String", # The unique identifier of the followup intent.

1780

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1781

},

1782

],

1783

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

1784

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

1785

"A String",

1786

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1787

"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]

1788

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1789

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1790

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1791

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1792

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

1793

# priorities.

1794

#

1795

# - If the supplied value is unspecified or 0, the service

1796

# translates the value to 500,000, which corresponds to the

1797

# `Normal` priority in the console.

1798

# - If the supplied value is negative, the intent is ignored

1799

# in runtime detect intent requests.

1800

},

1801

"webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the

1802

# value of the `source` field returned in the webhook response.

1803

"knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing

1804

# `KnowledgeAnswers.match_confidence`.

1805

"answers": [ # A list of answers from Knowledge Connector.

1806

{ # An answer from Knowledge Connector.

1807

"source": "A String", # Indicates which Knowledge Document this answer was extracted from.

1808

# Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base

1809

# ID>/documents/<Document ID>`.

1810

"matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match

1811

# for this conversational query.

1812

# The range is from 0.0 (completely uncertain) to 1.0 (completely certain).

1813

# Note: The confidence score is likely to vary somewhat (possibly even for

1814

# identical requests), as the underlying model is under constant

1815

# improvement. It may be deprecated in the future. We recommend using

1816

# `match_confidence_level` which should be generally more stable.

1817

"answer": "A String", # The piece of text from the `source` knowledge base document that answers

1818

# this conversational query.

1819

"faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ

1820

# Document, empty otherwise.

1821

"matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match

1822

# for this conversational query.

1823

# NOTE: The confidence level for a given `<query, answer>` pair may change

1824

# without notice, as it depends on models that are constantly being

1825

# improved. However, it will change less frequently than the confidence

1826

# score below, and should be preferred for referencing the quality of an

1827

# answer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1828

},

1829

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1830

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1831

},

1832

],

1833

"outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.

1834

# If this audio config is supplied in a request, it overrides all existing

1835

# text-to-speech settings applied to the agent.

1836

"synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Configuration of how speech should be synthesized.

1837

"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal

1838

# native speed supported by the specific voice. 2.0 is twice as fast, and

1839

# 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any

1840

# other values < 0.25 or > 4.0 will return an error.

1841

"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20

1842

# semitones from the original pitch. -20 means decrease 20 semitones from the

1843

# original pitch.

1844

"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the

1845

# specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of

1846

# 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)

1847

# will play at approximately half the amplitude of the normal native signal

1848

# amplitude. A value of +6.0 (dB) will play at approximately twice the

1849

# amplitude of the normal native signal amplitude. We strongly recommend not

1850

# to exceed +10 (dB) as there's usually no effective increase in loudness for

1851

# any value greater than that.

1852

"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.

1853

"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will

1854

# choose a voice based on the other parameters such as language_code and

1855

# name. Note that this is only a preference, not requirement. If a

1856

# voice of the appropriate gender is not available, the synthesizer should

1857

# substitute a voice with a different gender rather than failing the request.

1858

"name": "A String", # Optional. The name of the voice. If not set, the service will choose a

1859

# voice based on the other parameters such as language_code and

1860

# ssml_gender.

1861

},

1862

"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are

1863

# applied on (post synthesized) text to speech. Effects are applied on top of

1864

# each other in the order they are given.

"A String",

],

},

"audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.

1869

"sampleRateHertz": 42, # The synthesis sample rate (in hertz) for this audio. If not

1870

# provided, then the synthesizer will use the default sample rate based on

1871

# the audio encoding. If this is different from the voice's natural sample

1872

# rate, then the synthesizer will honor this request by converting to the

1873

# desired sample rate (which might result in worse audio quality).

1874

},

1875

"outputAudio": "A String", # The audio data bytes encoded as specified in the request.

1876

# Note: The output audio is generated based on the values of default platform

1877

# text responses found in the `query_result.fulfillment_messages` field. If

1878

# multiple default text responses exist, they will be concatenated when

1879

# generating audio. If no default platform text responses exist, the

1880

# generated audio content will be empty.

1881

#

1882

# In some scenarios, multiple output audio fields may be present in the

1883

# response structure. In these cases, only the top-most-level audio output

1884

# has content.

1885

"webhookStatus": { # The `Status` type defines a logical error model that is suitable for # Specifies the status of the webhook request.

1886

# different programming environments, including REST APIs and RPC APIs. It is

1887

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1888

# three pieces of data: error code, error message, and error details.

1889

#

1890

# You can find out more about this error model and how to work with it in the

1891

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1892

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1893

"details": [ # A list of messages that carry the error details. There is a common set of

1894

# message types for APIs to use.

1895

{

1896

"a_key": "", # Properties of the object. Contains field @type with type URL.

1897

},

1898

],

1899

"message": "A String", # A developer-facing error message, which should be in English. Any

1900

# user-facing error message should be localized and sent in the

1901

# google.rpc.Status.details field, or localized by the client.

1902

},

1903

"queryResult": { # Represents the result of conversational query or event processing. # The selected results of the conversational query or event processing.

1904

# See `alternative_query_results` for additional potential results.

1905

"fulfillmentText": "A String", # The text to be pronounced to the user or shown on the screen.

1906

# Note: This is a legacy field, `fulfillment_messages` should be preferred.

1907

"parameters": { # The collection of extracted parameters.

1908

#

1909

# Depending on your protocol or client library language, this is a

1910

# map, associative array, symbol table, dictionary, or JSON object

1911

# composed of a collection of (MapKey, MapValue) pairs:

1912

#

1913

# - MapKey type: string

1914

# - MapKey value: parameter name

1915

# - MapValue type:

1916

# - If parameter's entity type is a composite entity: map

1917

# - Else: string or number, depending on parameter value type

1918

# - MapValue value:

1919

# - If parameter's entity type is a composite entity:

1920

# map from composite entity property names to property values

1921

# - Else: parameter value

1922

"a_key": "", # Properties of the object.

1923

},

1924

"diagnosticInfo": { # Free-form diagnostic information for the associated detect intent request.

1925

# The fields of this data can change without notice, so you should not write

1926

# code that depends on its structure.

1927

# The data may contain:

1928

#

1929

# - webhook call latency

1930

# - webhook errors

1931

"a_key": "", # Properties of the object.

1932

},

1933

"languageCode": "A String", # The language that was triggered during intent detection.

1934

# See [Language

1935

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

1936

# for a list of the currently supported language codes.

1937

"outputContexts": [ # The collection of output contexts. If applicable,

1938

# `output_contexts.parameters` contains entries with name

1939

# `<parameter name>.original` containing the original parameter values

1940

# before the query.

1941

{ # Dialogflow contexts are similar to natural language context. If a person says

1942

# to you "they are orange", you need context in order to understand what "they"

1943

# is referring to. Similarly, for Dialogflow to handle an end-user expression

1944

# like that, it needs to be provided with context in order to correctly match

1945

# an intent.

1946

#

1947

# Using contexts, you can control the flow of a conversation. You can configure

1948

# contexts for an intent by setting input and output contexts, which are

1949

# identified by string names. When an intent is matched, any configured output

1950

# contexts for that intent become active. While any contexts are active,

1951

# Dialogflow is more likely to match intents that are configured with input

1952

# contexts that correspond to the currently active contexts.

1953

#

1954

# For more information about context, see the

1955

# [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

1956

"parameters": { # Optional. The collection of parameters associated with this context.

1957

#

1958

# Depending on your protocol or client library language, this is a

1959

# map, associative array, symbol table, dictionary, or JSON object

1960

# composed of a collection of (MapKey, MapValue) pairs:

1961

#

1962

# - MapKey type: string

1963

# - MapKey value: parameter name

1964

# - MapValue type:

1965

# - If parameter's entity type is a composite entity: map

1966

# - Else: string or number, depending on parameter value type

1967

# - MapValue value:

1968

# - If parameter's entity type is a composite entity:

1969

# map from composite entity property names to property values

1970

# - Else: parameter value

1971

"a_key": "", # Properties of the object.

1972

},

1973

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1974

# context expires. The default is `0`. If set to `0`, the context expires

1975

# immediately. Contexts expire automatically after 20 minutes if there

1976

# are no matching queries.

1977

"name": "A String", # Required. The unique identifier of the context. Format:

1978

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1979

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1980

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

1981

#

1982

# The `Context ID` is always converted to lowercase, may only contain

1983

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

1984

#

1985

# If `Environment ID` is not specified, we assume default 'draft'

1986

# environment. If `User ID` is not specified, we assume default '-' user.

1987

#

1988

# The following context names are reserved for internal use by Dialogflow.

1989

# You should not use these contexts or create contexts with these names:

1990

#

1991

# * `__system_counters__`

1992

# * `*_id_dialog_context`

1993

# * `*_dialog_params_size`

1994

},

1995

],

1996

"queryText": "A String", # The original conversational query text:

1997

#

1998

# - If natural language text was provided as input, `query_text` contains

1999

# a copy of the input.

2000

# - If natural language speech audio was provided as input, `query_text`

2001

# contains the speech recognition result. If speech recognizer produced

2002

# multiple alternatives, a particular one is picked.

2003

# - If automatic spell correction is enabled, `query_text` will contain the

2004

# corrected user input.

2005

"intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0

2006

# (completely uncertain) to 1.0 (completely certain).

2007

# This value is for informational purpose only and is only used to

2008

# help match the best intent within the classification threshold.

2009

# This value may change for the same end-user expression at any time due to a

2010

# model retraining or change in implementation.

2011

# If there are `multiple knowledge_answers` messages, this value is set to

2012

# the greatest `knowledgeAnswers.match_confidence` value in the list.

2013

"webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the

2014

# value of the `payload` field returned in the webhook response.

2015

"a_key": "", # Properties of the object.

2016

},

2017

"speechRecognitionConfidence": 3.14, # The Speech recognition confidence between 0.0 and 1.0. A higher number

2018

# indicates an estimated greater likelihood that the recognized words are

2019

# correct. The default of 0.0 is a sentinel value indicating that confidence

2020

# was not set.

2021

#

2022

# This field is not guaranteed to be accurate or set. In particular this

2023

# field isn't set for StreamingDetectIntent since the streaming endpoint has

2024

# separate confidence estimates per portion of the audio in

2025

# StreamingRecognitionResult.

2026

"sentimentAnalysisResult": { # The result of sentiment analysis. Sentiment analysis inspects user input # The sentiment analysis result, which depends on the

2027

# `sentiment_analysis_request_config` specified in the request.

2028

# and identifies the prevailing subjective opinion, especially to determine a

2029

# user's attitude as positive, negative, or neutral.

2030

# For Participants.AnalyzeContent, it needs to be configured in

2031

# DetectIntentRequest.query_params. For

2032

# Participants.StreamingAnalyzeContent, it needs to be configured in

2033

# StreamingDetectIntentRequest.query_params.

2034

# And for Participants.AnalyzeContent and

2035

# Participants.StreamingAnalyzeContent, it needs to be configured in

2036

# ConversationProfile.human_agent_assistant_config

2037

"queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.

2038

# of analysis, such as the query text.

2039

"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute

2040

# magnitude of sentiment, regardless of score (positive or negative).

2041

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive

# sentiment).

},

},

"action": "A String", # The action name from the matched intent.

2046

"allRequiredParamsPresent": True or False, # This field is set to:

2047

#

2048

# - `false` if the matched intent has required parameters and not all of

2049

# the required parameter values have been collected.

2050

# - `true` if all required parameter values have been collected, or if the

2051

# matched intent doesn't contain any required parameters.

2052

"fulfillmentMessages": [ # The collection of rich messages to present to the user.

2053

{ # Corresponds to the `Response` field in the Dialogflow console.

2054

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2055

"suggestions": [ # Required. The list of suggested replies.

2056

{ # The suggestion chip message that the user can tap to quickly post a reply

2057

# to the conversation.

2058

"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.

2063

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2064

"mediaObjects": [ # Required. List of media objects.

2065

{ # Response media object for media content card.

2066

"description": "A String", # Optional. Description of media card.

2067

"icon": { # The image response message. # Optional. Icon to display above media content.

2068

"imageUri": "A String", # Optional. The public URI to an image file.

2069

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2070

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2071

},

2072

"contentUrl": "A String", # Required. Url where the media is stored.

2073

"name": "A String", # Required. Name of media card.

2074

"largeImage": { # The image response message. # Optional. Image to display above media content.

2075

"imageUri": "A String", # Optional. The public URI to an image file.

2076

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2077

# 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.

2083

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2084

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2085

#

2086

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2087

},

2088

"platform": "A String", # Optional. The platform that this message is intended for.

2089

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

2090

# Telephony Gateway.

2091

#

2092

# Telephony Gateway takes the synthesizer settings from

2093

# `DetectIntentResponse.output_audio_config` which can either be set

2094

# at request-level or can come from the agent-level synthesizer config.

2095

"text": "A String", # The raw text to be synthesized.

2096

"ssml": "A String", # The SSML to be synthesized. For more information, see

2097

# [SSML](https://developers.google.com/actions/reference/ssml).

2098

},

2099

"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.

2100

# or website associated with this agent.

2101

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2102

# suggestion chip.

2103

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2104

},

2105

"quickReplies": { # The quick replies response message. # Displays quick replies.

2106

"quickReplies": [ # Optional. The collection of quick replies.

2107

"A String",

2108

],

2109

"title": "A String", # Optional. The title of the collection of quick replies.

2110

},

2111

"card": { # The card response message. # Displays a card.

2112

"subtitle": "A String", # Optional. The subtitle of the card.

2113

"buttons": [ # Optional. The collection of card buttons.

2114

{ # Optional. Contains information about a button.

2115

"text": "A String", # Optional. The text to show on the button.

2116

"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.

2121

"title": "A String", # Optional. The title of the card.

2122

},

2123

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

2124

"subtitle": "A String", # Optional. Subtitle of the list.

2125

"title": "A String", # Optional. The overall title of the list.

2126

"items": [ # Required. List items.

2127

{ # An item in the list.

2128

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2129

# dialog.

2130

"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

2135

# response is given.

2136

},

2137

"description": "A String", # Optional. The main text describing the item.

2138

"title": "A String", # Required. The title of the list item.

2139

"image": { # The image response message. # Optional. The image to display.

2140

"imageUri": "A String", # Optional. The public URI to an image file.

2141

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2142

# 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.

2148

"buttons": [ # Optional. The collection of card buttons.

2149

{ # The button object that appears at the bottom of a card.

2150

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2151

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2152

},

2153

"title": "A String", # Required. The title of the button.

2154

},

2155

],

2156

"title": "A String", # Optional. The title of the card.

2157

"image": { # The image response message. # Optional. The image for the card.

2158

"imageUri": "A String", # Optional. The public URI to an image file.

2159

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2160

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2161

},

2162

"subtitle": "A String", # Optional. The subtitle of the card.

2163

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2164

},

2165

"image": { # The image response message. # Displays an image.

2166

"imageUri": "A String", # Optional. The public URI to an image file.

2167

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2168

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2169

},

2170

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

2171

#

2172

# Rich cards allow you to respond to users with more vivid content, e.g.

2173

# with media and suggestions.

2174

#

2175

# If you want to show a single card with more control over the layout,

2176

# please use RbmStandaloneCard instead.

2177

"cardWidth": "A String", # Required. The width of the cards in the carousel.

2178

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

2179

# 2 cards and at most 10.

2180

{ # Rich Business Messaging (RBM) Card content

2181

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2182

# be set. Media (image, GIF or a video) to include in the card.

2183

# 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

"height": "A String", # Required for cards with vertical orientation. The height of the media

2201

# within a rich card with a vertical layout.

2202

# For a standalone card with horizontal layout, height is not

2203

# customizable, and this field is ignored.

2204

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2205

# determines the MIME type of the file from the content-type field in

2206

# the HTTP headers when the platform fetches the file. The content-type

2207

# field must be present and accurate in the HTTP response from the URL.

2208

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2209

# provide a thumbnail URI, the RBM platform displays a blank

2210

# placeholder thumbnail until the user's device downloads the file.

2211

# Depending on the user's setting, the file may not download

2212

# automatically and may require the user to tap a download button.

2213

},

2214

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2215

#

2216

# At least one of the title, description or media must be set.

2217

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2218

#

2219

# At least one of the title, description or media must be set.

2220

"suggestions": [ # Optional. List of suggestions to include in the card.

2221

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2222

# easily select/click a predefined response or perform an action (like

2223

# opening a web uri).

2224

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2225

# can choose from the card.

2226

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2227

# If the user has an app installed that is

2228

# registered as the default handler for the URL, then this app will be

2229

# opened instead, and its icon will be used in the suggested action UI.

2230

"uri": "A String", # Required. The uri to open on the user device

2231

},

2232

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2233

# to send back to the agent.

2234

},

2235

"text": "A String", # Text to display alongside the action.

2236

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2237

# but does not dial automatically.

2238

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2239

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2240

# format. An example of a correctly formatted phone number:

2241

# +15556767888.

2242

},

2243

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2244

# when the user taps the suggested action. This data will be also

2245

# forwarded to webhook to allow performing custom business logic.

2246

},

2247

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2248

# instead of typing in their own response.

2249

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2250

# when the user taps the suggested reply. This data will be also

2251

# forwarded to webhook to allow performing custom business logic.

2252

"text": "A String", # Suggested reply text.

},

},

],

},

],

},

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2260

"buttons": [ # Optional. List of buttons for the card.

2261

{ # The button object that appears at the bottom of a card.

2262

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2263

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2264

},

2265

"title": "A String", # Required. The title of the button.

2266

},

2267

],

2268

"subtitle": "A String", # Optional. Subtitle to the title.

2269

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2270

"imageUri": "A String", # Optional. The public URI to an image file.

2271

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2272

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2273

},

2274

"rows": [ # Optional. Rows in this table of data.

2275

{ # Row of TableCard.

2276

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2277

"cells": [ # Optional. List of cells that make up this row.

2278

{ # Cell of TableCardRow.

2279

"text": "A String", # Required. Text in this cell.

},

],

},

],

"title": "A String", # Required. Title of the card.

2285

"columnProperties": [ # Optional. Display properties for the columns in this table.

2286

{ # Column properties for TableCard.

2287

"header": "A String", # Required. Column heading.

2288

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

2293

#

2294

# RBM allows businesses to send enriched and branded versions of SMS. See

2295

# https://jibe.google.com/business-messaging.

2296

"text": "A String", # Required. Text sent and displayed to the user.

2297

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2298

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2299

# easily select/click a predefined response or perform an action (like

2300

# opening a web uri).

2301

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2302

# can choose from the card.

2303

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2304

# If the user has an app installed that is

2305

# registered as the default handler for the URL, then this app will be

2306

# opened instead, and its icon will be used in the suggested action UI.

2307

"uri": "A String", # Required. The uri to open on the user device

2308

},

2309

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2310

# to send back to the agent.

2311

},

2312

"text": "A String", # Text to display alongside the action.

2313

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2314

# but does not dial automatically.

2315

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2316

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2317

# format. An example of a correctly formatted phone number:

2318

# +15556767888.

2319

},

2320

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2321

# when the user taps the suggested action. This data will be also

2322

# forwarded to webhook to allow performing custom business logic.

2323

},

2324

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2325

# instead of typing in their own response.

2326

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2327

# when the user taps the suggested reply. This data will be also

2328

# forwarded to webhook to allow performing custom business logic.

2329

"text": "A String", # Suggested reply text.

},

},

],

},

"payload": { # A custom platform-specific response.

2335

"a_key": "", # Properties of the object.

2336

},

2337

"text": { # The text response message. # Returns a text response.

2338

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2343

#

2344

# Rich cards allow you to respond to users with more vivid content, e.g.

2345

# with media and suggestions.

2346

#

2347

# You can group multiple rich cards into one using RbmCarouselCard but

2348

# carousel cards will give you less control over the card layout.

2349

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

2350

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2351

# be set. Media (image, GIF or a video) to include in the card.

2352

# 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

"height": "A String", # Required for cards with vertical orientation. The height of the media

2370

# within a rich card with a vertical layout.

2371

# For a standalone card with horizontal layout, height is not

2372

# customizable, and this field is ignored.

2373

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2374

# determines the MIME type of the file from the content-type field in

2375

# the HTTP headers when the platform fetches the file. The content-type

2376

# field must be present and accurate in the HTTP response from the URL.

2377

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2378

# provide a thumbnail URI, the RBM platform displays a blank

2379

# placeholder thumbnail until the user's device downloads the file.

2380

# Depending on the user's setting, the file may not download

2381

# automatically and may require the user to tap a download button.

2382

},

2383

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2384

#

2385

# At least one of the title, description or media must be set.

2386

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2387

#

2388

# At least one of the title, description or media must be set.

2389

"suggestions": [ # Optional. List of suggestions to include in the card.

2390

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2391

# easily select/click a predefined response or perform an action (like

2392

# opening a web uri).

2393

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2394

# can choose from the card.

2395

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2396

# If the user has an app installed that is

2397

# registered as the default handler for the URL, then this app will be

2398

# opened instead, and its icon will be used in the suggested action UI.

2399

"uri": "A String", # Required. The uri to open on the user device

2400

},

2401

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2402

# to send back to the agent.

2403

},

2404

"text": "A String", # Text to display alongside the action.

2405

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2406

# but does not dial automatically.

2407

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2408

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2409

# format. An example of a correctly formatted phone number:

2410

# +15556767888.

2411

},

2412

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2413

# when the user taps the suggested action. This data will be also

2414

# forwarded to webhook to allow performing custom business logic.

2415

},

2416

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2417

# instead of typing in their own response.

2418

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2419

# when the user taps the suggested reply. This data will be also

2420

# forwarded to webhook to allow performing custom business logic.

2421

"text": "A String", # Suggested reply text.

},

},

],

},

"cardOrientation": "A String", # Required. Orientation of the card.

2427

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2428

# Image preview alignment for standalone cards with horizontal layout.

2429

},

2430

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2431

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

2432

# play, e.g., "gs://bucket/object". The object must contain a single

2433

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

2434

#

2435

# This object must be readable by the `service-<Project

2436

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

2437

# where <Project Number> is the number of the Telephony Gateway project

2438

# (usually the same as the Dialogflow agent project). If the Google Cloud

2439

# Storage bucket is in the Telephony Gateway project, this permission is

2440

# added by default when enabling the Dialogflow V2 API.

2441

#

2442

# For audio from other sources, consider using the

2443

# `TelephonySynthesizeSpeech` message with SSML.

2444

},

2445

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2446

"items": [ # Required. Carousel items.

2447

{ # An item in the carousel.

2448

"image": { # The image response message. # Optional. The image to display.

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.

2452

},

2453

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2454

# dialog.

2455

"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

2460

# response is given.

2461

},

2462

"title": "A String", # Required. Title of the carousel item.

2463

"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.

2468

# This message in `QueryResult.fulfillment_messages` and

2469

# `WebhookResponse.fulfillment_messages` should contain only one

2470

# `SimpleResponse`.

2471

"simpleResponses": [ # Required. The list of simple responses.

2472

{ # The simple response message containing speech or text.

2473

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2474

# response to the user in the SSML format. Mutually exclusive with

2475

# text_to_speech.

2476

"displayText": "A String", # Optional. The text to display.

2477

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2478

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2483

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2484

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2485

# items.

2486

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2487

# items, maximum of ten.

2488

{ # Browsing carousel tile

2489

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2490

# Card. Maximum of one line of text.

2491

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2492

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2493

# text.

2494

"image": { # The image response message. # Optional. Hero image for the carousel item.

2495

"imageUri": "A String", # Optional. The public URI to an image file.

2496

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2497

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2498

},

2499

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2500

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2501

# the URL. Defaults to opening via web browser.

2502

"url": "A String", # Required. URL

},

},

],

},

},

],

"intent": { # An intent categorizes an end-user's intention for one conversation turn. For # The intent that matched the conversational query. Some, not

2510

# all fields are filled in this message, including but not limited to:

2511

# `name`, `display_name`, `end_interaction` and `is_fallback`.

2512

# each agent, you define many intents, where your combined intents can handle a

2513

# complete conversation. When an end-user writes or says something, referred to

2514

# as an end-user expression or end-user input, Dialogflow matches the end-user

2515

# input to the best intent in your agent. Matching an intent is also known as

2516

# intent classification.

2517

#

2518

# For more information, see the [intent

2519

# guide](https://cloud.google.com/dialogflow/docs/intents-overview).

2520

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

2521

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

2522

# to close interaction with an end user. Default is false.

2523

"action": "A String", # Optional. The name of the action associated with the intent.

2524

# Note: The action name must not contain whitespaces.

2525

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2526

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

2527

# is matched. Context messages in this collection should not set the

2528

# parameters field. Setting the `lifespan_count` to 0 will reset the context

2529

# when the intent is matched.

2530

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

2531

{ # Dialogflow contexts are similar to natural language context. If a person says

2532

# to you "they are orange", you need context in order to understand what "they"

2533

# is referring to. Similarly, for Dialogflow to handle an end-user expression

2534

# like that, it needs to be provided with context in order to correctly match

2535

# an intent.

2536

#

2537

# Using contexts, you can control the flow of a conversation. You can configure

2538

# contexts for an intent by setting input and output contexts, which are

2539

# identified by string names. When an intent is matched, any configured output

2540

# contexts for that intent become active. While any contexts are active,

2541

# Dialogflow is more likely to match intents that are configured with input

2542

# contexts that correspond to the currently active contexts.

2543

#

2544

# For more information about context, see the

2545

# [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

2546

"parameters": { # Optional. The collection of parameters associated with this context.

2547

#

2548

# Depending on your protocol or client library language, this is a

2549

# map, associative array, symbol table, dictionary, or JSON object

2550

# composed of a collection of (MapKey, MapValue) pairs:

2551

#

2552

# - MapKey type: string

2553

# - MapKey value: parameter name

2554

# - MapValue type:

2555

# - If parameter's entity type is a composite entity: map

2556

# - Else: string or number, depending on parameter value type

2557

# - MapValue value:

2558

# - If parameter's entity type is a composite entity:

2559

# map from composite entity property names to property values

2560

# - Else: parameter value

2561

"a_key": "", # Properties of the object.

2562

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2563

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

2564

# context expires. The default is `0`. If set to `0`, the context expires

2565

# immediately. Contexts expire automatically after 20 minutes if there

2566

# are no matching queries.

2567

"name": "A String", # Required. The unique identifier of the context. Format:

2568

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

2569

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

2570

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

2571

#

2572

# The `Context ID` is always converted to lowercase, may only contain

2573

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2574

#

2575

# If `Environment ID` is not specified, we assume default 'draft'

2576

# environment. If `User ID` is not specified, we assume default '-' user.

2577

#

2578

# The following context names are reserved for internal use by Dialogflow.

2579

# You should not use these contexts or create contexts with these names:

2580

#

2581

# * `__system_counters__`

2582

# * `*_id_dialog_context`

2583

# * `*_dialog_params_size`

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2584

},

2585

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2586

"displayName": "A String", # Required. The name of this intent.

2587

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

2588

# session when this intent is matched.

2589

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2590

# Note: If `ml_disabled` setting is set to true, then this intent is not

2591

# taken into account during inference in `ML ONLY` match mode. Also,

2592

# auto-markup in the UI is turned off.

2593

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

2594

# followup intents. It identifies the correct followup intents chain for

2595

# this intent.

2596

#

2597

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2598

"trainingPhrases": [ # Optional. The collection of examples that the agent is

2599

# trained on.

2600

{ # Represents an example that the agent is trained on.

2601

"type": "A String", # Required. The type of the training phrase.

2602

"name": "A String", # Output only. The unique identifier of this training phrase.

2603

"parts": [ # Required. The ordered list of training phrase parts.

2604

# The parts are concatenated in order to form the training phrase.

2605

#

2606

# Note: The API does not automatically annotate training phrases like the

2607

# Dialogflow Console does.

2608

#

2609

# Note: Do not forget to include whitespace at part boundaries,

2610

# so the training phrase is well formatted when the parts are concatenated.

2611

#

2612

# If the training phrase does not need to be annotated with parameters,

2613

# you just need a single part with only the Part.text field set.

2614

#

2615

# If you want to annotate the training phrase, you must create multiple

2616

# parts, where the fields of each part are populated in one of two ways:

2617

#

2618

# - `Part.text` is set to a part of the phrase that has no parameters.

2619

# - `Part.text` is set to a part of the phrase that you want to annotate,

2620

# and the `entity_type`, `alias`, and `user_defined` fields are all

2621

# set.

2622

{ # Represents a part of a training phrase.

2623

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

2624

# This field is set to true when the Dialogflow Console is used to

2625

# manually annotate the part. When creating an annotated part with the

2626

# API, you must set this to true.

2627

"alias": "A String", # Optional. The parameter name for the value extracted from the

2628

# annotated part of the example.

2629

# This field is required for annotated parts of the training phrase.

2630

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

2631

# This field is required for annotated parts of the training phrase.

2632

"text": "A String", # Required. The text for this part.

2633

},

2634

],

2635

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

2636

# the intent. Each time a developer adds an existing sample by editing an

2637

# intent or training, this counter is increased.

2638

},

2639

],

2640

"messages": [ # Optional. The collection of rich messages corresponding to the

2641

# `Response` field in the Dialogflow console.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2642

{ # Corresponds to the `Response` field in the Dialogflow console.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2643

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2644

"suggestions": [ # Required. The list of suggested replies.

2645

{ # The suggestion chip message that the user can tap to quickly post a reply

2646

# to the conversation.

2647

"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.

2652

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2653

"mediaObjects": [ # Required. List of media objects.

2654

{ # Response media object for media content card.

2655

"description": "A String", # Optional. Description of media card.

2656

"icon": { # The image response message. # Optional. Icon to display above media content.

2657

"imageUri": "A String", # Optional. The public URI to an image file.

2658

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2659

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2660

},

2661

"contentUrl": "A String", # Required. Url where the media is stored.

2662

"name": "A String", # Required. Name of media card.

2663

"largeImage": { # The image response message. # Optional. Image to display above media content.

2664

"imageUri": "A String", # Optional. The public URI to an image file.

2665

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2666

# 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.

2672

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2673

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2674

#

2675

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2676

},

2677

"platform": "A String", # Optional. The platform that this message is intended for.

2678

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

2679

# Telephony Gateway.

2680

#

2681

# Telephony Gateway takes the synthesizer settings from

2682

# `DetectIntentResponse.output_audio_config` which can either be set

2683

# at request-level or can come from the agent-level synthesizer config.

2684

"text": "A String", # The raw text to be synthesized.

2685

"ssml": "A String", # The SSML to be synthesized. For more information, see

2686

# [SSML](https://developers.google.com/actions/reference/ssml).

2687

},

2688

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

2689

# or website associated with this agent.

2690

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2691

# suggestion chip.

2692

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2693

},

2694

"quickReplies": { # The quick replies response message. # Displays quick replies.

2695

"quickReplies": [ # Optional. The collection of quick replies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2696

"A String",

2697

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2698

"title": "A String", # Optional. The title of the collection of quick replies.

2699

},

2700

"card": { # The card response message. # Displays a card.

2701

"subtitle": "A String", # Optional. The subtitle of the card.

2702

"buttons": [ # Optional. The collection of card buttons.

2703

{ # Optional. Contains information about a button.

2704

"text": "A String", # Optional. The text to show on the button.

2705

"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.

2710

"title": "A String", # Optional. The title of the card.

2711

},

2712

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

2713

"subtitle": "A String", # Optional. Subtitle of the list.

2714

"title": "A String", # Optional. The overall title of the list.

2715

"items": [ # Required. List items.

2716

{ # An item in the list.

2717

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2718

# dialog.

2719

"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

2724

# response is given.

2725

},

2726

"description": "A String", # Optional. The main text describing the item.

2727

"title": "A String", # Required. The title of the list item.

2728

"image": { # The image response message. # Optional. The image to display.

2729

"imageUri": "A String", # Optional. The public URI to an image file.

2730

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2731

# 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.

2737

"buttons": [ # Optional. The collection of card buttons.

2738

{ # The button object that appears at the bottom of a card.

2739

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2740

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2741

},

2742

"title": "A String", # Required. The title of the button.

2743

},

2744

],

2745

"title": "A String", # Optional. The title of the card.

2746

"image": { # The image response message. # Optional. The image for the card.

2747

"imageUri": "A String", # Optional. The public URI to an image file.

2748

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2749

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2750

},

2751

"subtitle": "A String", # Optional. The subtitle of the card.

2752

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2753

},

2754

"image": { # The image response message. # Displays an image.

2755

"imageUri": "A String", # Optional. The public URI to an image file.

2756

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2757

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2758

},

2759

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

2760

#

2761

# Rich cards allow you to respond to users with more vivid content, e.g.

2762

# with media and suggestions.

2763

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2764

# If you want to show a single card with more control over the layout,

2765

# please use RbmStandaloneCard instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2766

"cardWidth": "A String", # Required. The width of the cards in the carousel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2767

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

2768

# 2 cards and at most 10.

2769

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2770

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2771

# be set. Media (image, GIF or a video) to include in the card.

2772

# 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]

2789

"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]

2790

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2791

# For a standalone card with horizontal layout, height is not

2792

# customizable, and this field is ignored.

2793

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2794

# determines the MIME type of the file from the content-type field in

2795

# the HTTP headers when the platform fetches the file. The content-type

2796

# 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]

2797

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2798

# provide a thumbnail URI, the RBM platform displays a blank

2799

# placeholder thumbnail until the user's device downloads the file.

2800

# Depending on the user's setting, the file may not download

2801

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2802

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2803

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2804

#

2805

# At least one of the title, description or media must be set.

2806

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2807

#

2808

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2809

"suggestions": [ # Optional. List of suggestions to include in the card.

2810

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2811

# easily select/click a predefined response or perform an action (like

2812

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2813

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2814

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2815

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2816

# If the user has an app installed that is

2817

# registered as the default handler for the URL, then this app will be

2818

# opened instead, and its icon will be used in the suggested action UI.

2819

"uri": "A String", # Required. The uri to open on the user device

2820

},

2821

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2822

# to send back to the agent.

2823

},

2824

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2825

"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]

2826

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2827

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2828

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2829

# format. An example of a correctly formatted phone number:

2830

# +15556767888.

2831

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2832

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2833

# when the user taps the suggested action. This data will be also

2834

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2835

},

2836

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2837

# instead of typing in their own response.

2838

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2839

# when the user taps the suggested reply. This data will be also

2840

# forwarded to webhook to allow performing custom business logic.

2841

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2842

},

2843

},

2844

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2845

},

2846

],

2847

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2848

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2849

"buttons": [ # Optional. List of buttons for the card.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2850

{ # The button object that appears at the bottom of a card.

2851

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2852

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2853

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2854

"title": "A String", # Required. The title of the button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2855

},

2856

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2857

"subtitle": "A String", # Optional. Subtitle to the title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2858

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2859

"imageUri": "A String", # Optional. The public URI to an image file.

2860

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2861

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2862

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2863

"rows": [ # Optional. Rows in this table of data.

2864

{ # Row of TableCard.

2865

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2866

"cells": [ # Optional. List of cells that make up this row.

2867

{ # Cell of TableCardRow.

2868

"text": "A String", # Required. Text in this cell.

},

],

},

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2873

"title": "A String", # Required. Title of the card.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2874

"columnProperties": [ # Optional. Display properties for the columns in this table.

2875

{ # Column properties for TableCard.

2876

"header": "A String", # Required. Column heading.

2877

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2878

},

2879

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2880

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2881

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

2882

#

2883

# RBM allows businesses to send enriched and branded versions of SMS. See

2884

# https://jibe.google.com/business-messaging.

2885

"text": "A String", # Required. Text sent and displayed to the user.

2886

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2887

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2888

# easily select/click a predefined response or perform an action (like

2889

# opening a web uri).

2890

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2891

# can choose from the card.

2892

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2893

# If the user has an app installed that is

2894

# registered as the default handler for the URL, then this app will be

2895

# opened instead, and its icon will be used in the suggested action UI.

2896

"uri": "A String", # Required. The uri to open on the user device

2897

},

2898

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2899

# to send back to the agent.

2900

},

2901

"text": "A String", # Text to display alongside the action.

2902

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2903

# but does not dial automatically.

2904

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2905

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2906

# format. An example of a correctly formatted phone number:

2907

# +15556767888.

2908

},

2909

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2910

# when the user taps the suggested action. This data will be also

2911

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2912

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2913

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2914

# instead of typing in their own response.

2915

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2916

# when the user taps the suggested reply. This data will be also

2917

# forwarded to webhook to allow performing custom business logic.

2918

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2919

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2920

},

2921

],

2922

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2923

"payload": { # A custom platform-specific response.

2924

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2925

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2926

"text": { # The text response message. # Returns a text response.

2927

"text": [ # Optional. The collection of the agent's responses.

2928

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2929

],

2930

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2931

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2932

#

2933

# Rich cards allow you to respond to users with more vivid content, e.g.

2934

# with media and suggestions.

2935

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2936

# You can group multiple rich cards into one using RbmCarouselCard but

2937

# carousel cards will give you less control over the card layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2938

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2939

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2940

# be set. Media (image, GIF or a video) to include in the card.

2941

# 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]

2958

"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]

2959

# within a rich card with a vertical layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2960

# For a standalone card with horizontal layout, height is not

2961

# customizable, and this field is ignored.

2962

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2963

# determines the MIME type of the file from the content-type field in

2964

# the HTTP headers when the platform fetches the file. The content-type

2965

# 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]

2966

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2967

# provide a thumbnail URI, the RBM platform displays a blank

2968

# placeholder thumbnail until the user's device downloads the file.

2969

# Depending on the user's setting, the file may not download

2970

# automatically and may require the user to tap a download button.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2971

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2972

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2973

#

2974

# At least one of the title, description or media must be set.

2975

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2976

#

2977

# At least one of the title, description or media must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2978

"suggestions": [ # Optional. List of suggestions to include in the card.

2979

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2980

# easily select/click a predefined response or perform an action (like

2981

# opening a web uri).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2982

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2983

# can choose from the card.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2984

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2985

# If the user has an app installed that is

2986

# registered as the default handler for the URL, then this app will be

2987

# opened instead, and its icon will be used in the suggested action UI.

2988

"uri": "A String", # Required. The uri to open on the user device

2989

},

2990

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2991

# to send back to the agent.

2992

},

2993

"text": "A String", # Text to display alongside the action.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2994

"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]

2995

# but does not dial automatically.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2996

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2997

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2998

# format. An example of a correctly formatted phone number:

2999

# +15556767888.

3000

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3001

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3002

# when the user taps the suggested action. This data will be also

3003

# forwarded to webhook to allow performing custom business logic.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3004

},

3005

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

3006

# instead of typing in their own response.

3007

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

3008

# when the user taps the suggested reply. This data will be also

3009

# forwarded to webhook to allow performing custom business logic.

3010

"text": "A String", # Suggested reply text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3011

},

3012

},

3013

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3014

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3015

"cardOrientation": "A String", # Required. Orientation of the card.

3016

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

3017

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3018

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3019

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

3020

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

3021

# play, e.g., "gs://bucket/object". The object must contain a single

3022

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

3023

#

3024

# This object must be readable by the `service-<Project

3025

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

3026

# where <Project Number> is the number of the Telephony Gateway project

3027

# (usually the same as the Dialogflow agent project). If the Google Cloud

3028

# Storage bucket is in the Telephony Gateway project, this permission is

3029

# added by default when enabling the Dialogflow V2 API.

3030

#

3031

# For audio from other sources, consider using the

3032

# `TelephonySynthesizeSpeech` message with SSML.

3033

},

3034

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

3035

"items": [ # Required. Carousel items.

3036

{ # An item in the carousel.

3037

"image": { # The image response message. # Optional. The image to display.

3038

"imageUri": "A String", # Optional. The public URI to an image file.

3039

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3040

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3041

},

3042

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

3043

# dialog.

3044

"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

3049

# response is given.

3050

},

3051

"title": "A String", # Required. Title of the carousel item.

3052

"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.

3057

# This message in `QueryResult.fulfillment_messages` and

3058

# `WebhookResponse.fulfillment_messages` should contain only one

3059

# `SimpleResponse`.

3060

"simpleResponses": [ # Required. The list of simple responses.

3061

{ # The simple response message containing speech or text.

3062

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

3063

# response to the user in the SSML format. Mutually exclusive with

3064

# text_to_speech.

3065

"displayText": "A String", # Optional. The text to display.

3066

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

3067

# speech output. Mutually exclusive with ssml.

},

],

},

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

3072

# https://developers.google.com/actions/assistant/responses#browsing_carousel

3073

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

3074

# items.

3075

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

3076

# items, maximum of ten.

3077

{ # Browsing carousel tile

3078

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

3079

# Card. Maximum of one line of text.

3080

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

3081

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

3082

# text.

3083

"image": { # The image response message. # Optional. Hero image for the carousel item.

3084

"imageUri": "A String", # Optional. The public URI to an image file.

3085

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

3086

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

3087

},

3088

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

3089

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

3090

# the URL. Defaults to opening via web browser.

3091

"url": "A String", # Required. URL

3092

},

3093

},

3094

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3095

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3096

},

3097

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3098

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

3099

# chain of followup intents. You can set this field when creating an intent,

3100

# for example with CreateIntent or

3101

# BatchUpdateIntents, in order to make this

3102

# intent a followup intent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3103

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3104

# It identifies the parent followup intent.

3105

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3106

"parameters": [ # Optional. The collection of parameters associated with the intent.

3107

{ # Represents intent parameters.

3108

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

3109

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

3110

# whether the intent cannot be completed without collecting the parameter

3111

# value.

3112

"prompts": [ # Optional. The collection of prompts that the agent can present to the

3113

# user in order to collect a value for the parameter.

3114

"A String",

3115

],

3116

"name": "A String", # The unique identifier of this parameter.

3117

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

3118

# describes values of the parameter. If the parameter is

3119

# required, this must be provided.

3120

"displayName": "A String", # Required. The name of the parameter.

3121

"value": "A String", # Optional. The definition of the parameter value. It can be:

3122

#

3123

# - a constant string,

3124

# - a parameter value defined as `$parameter_name`,

3125

# - an original parameter value defined as `$parameter_name.original`,

3126

# - a parameter value from some context defined as

3127

# `#context_name.parameter_name`.

3128

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

3129

# result.

3130

# Default values can be extracted from contexts by using the following

3131

# syntax: `#context_name.parameter_name`.

3132

},

3133

],

3134

"events": [ # Optional. The collection of event names that trigger the intent.

3135

# If the collection of input contexts is not empty, all of the contexts must

3136

# be present in the active user session for an event to trigger this intent.

3137

# Event names are limited to 150 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3138

"A String",

3139

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3140

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

3141

"name": "A String", # Optional. The unique identifier of this intent.

3142

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

3143

# methods.

3144

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3145

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

3146

# Note: If `ml_enabled` setting is set to false, then this intent is not

3147

# taken into account during inference in `ML ONLY` match mode. Also,

3148

# auto-markup in the UI is turned off.

3149

# DEPRECATED! Please use `ml_disabled` field instead.

3150

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

3151

# then the default value is determined as follows:

3152

# - Before April 15th, 2018 the default is:

3153

# ml_enabled = false / ml_disabled = true.

3154

# - After April 15th, 2018 the default is:

3155

# ml_enabled = true / ml_disabled = false.

3156

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

3157

# a direct or indirect parent. We populate this field only in the output.

3158

{ # Represents a single followup intent in the chain.

3159

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

3160

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3161

"followupIntentName": "A String", # The unique identifier of the followup intent.

3162

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

3163

},

3164

],

3165

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

3166

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

3167

"A String",

3168

],

3169

"inputContextNames": [ # Optional. The list of context names required for this intent to be

3170

# triggered.

3171

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

3172

"A String",

3173

],

3174

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

3175

# priorities.

3176

#

3177

# - If the supplied value is unspecified or 0, the service

3178

# translates the value to 500,000, which corresponds to the

3179

# `Normal` priority in the console.

3180

# - If the supplied value is negative, the intent is ignored

3181

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3182

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3183

"webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the

3184

# value of the `source` field returned in the webhook response.

3185

"knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing

3186

# `KnowledgeAnswers.match_confidence`.

3187

"answers": [ # A list of answers from Knowledge Connector.

3188

{ # An answer from Knowledge Connector.

3189

"source": "A String", # Indicates which Knowledge Document this answer was extracted from.

3190

# Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base

3191

# ID>/documents/<Document ID>`.

3192

"matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match

3193

# for this conversational query.

3194

# The range is from 0.0 (completely uncertain) to 1.0 (completely certain).

3195

# Note: The confidence score is likely to vary somewhat (possibly even for

3196

# identical requests), as the underlying model is under constant

3197

# improvement. It may be deprecated in the future. We recommend using

3198

# `match_confidence_level` which should be generally more stable.

3199

"answer": "A String", # The piece of text from the `source` knowledge base document that answers

3200

# this conversational query.

3201

"faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ

3202

# Document, empty otherwise.

3203

"matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match

3204

# for this conversational query.

3205

# NOTE: The confidence level for a given `<query, answer>` pair may change

3206

# without notice, as it depends on models that are constantly being

3207

# improved. However, it will change less frequently than the confidence

3208

# score below, and should be preferred for referencing the quality of an

# answer.

},

],

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3213

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3214

"responseId": "A String", # The unique identifier of the response. It can be used to

3215

# locate a response in the training example set or for reporting issues.

Bu Sun Kim