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

140

`User ID` must not exceed 36 characters. (required)

Dan O'Meara

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

[diff] [blame]

141

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

142

The object takes the form of:

143

Bu Sun Kim

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

[diff] [blame]

144

{ # The request to detect user's intent.

145

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

146

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

147

# agent-level.

Bu Sun Kim

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

[diff] [blame]

148

#

Dan O'Meara

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

[diff] [blame]

149

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

150

# config in its entirety.

Bu Sun Kim

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

[diff] [blame]

151

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

152

#

153

# 1. an audio config

154

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

155

#

156

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

157

#

158

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

159

#

160

# 1. An audio config which

161

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

162

#

163

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

164

#

165

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

Bu Sun Kim

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

[diff] [blame]

166

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

167

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

168

# Text length must not exceed 256 characters.

Bu Sun Kim

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

[diff] [blame]

169

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

Dan O'Meara

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

[diff] [blame]

170

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

171

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

172

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

173

},

Bu Sun Kim

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

[diff] [blame]

174

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

175

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

Dan O'Meara

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

[diff] [blame]

176

# translations. See [Language

177

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

178

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

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

Dan O'Meara

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

[diff] [blame]

181

#

182

# See [the Cloud Speech

183

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

184

# for more details.

185

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

186

# conversation state.

Bu Sun Kim

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

[diff] [blame]

187

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

Dan O'Meara

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

[diff] [blame]

188

# recognizer should recognize with higher likelihood.

189

#

190

# This list can be used to:

191

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

192

# e.g. typical commands for your Dialogflow agent

193

# * add additional words to the speech recognizer vocabulary

194

# * ...

195

#

196

# See the [Cloud Speech

197

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

198

# limits.

Bu Sun Kim

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

[diff] [blame]

199

"A String",

Dan O'Meara

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

[diff] [blame]

200

],

Bu Sun Kim

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

[diff] [blame]

201

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

202

#

Dan O'Meara

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

[diff] [blame]

203

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

204

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

205

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

206

# any boost.

207

#

208

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

209

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

210

},

211

],

Bu Sun Kim

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

[diff] [blame]

212

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

213

# recognizer should recognize with higher likelihood.

214

#

215

# See [the Cloud Speech

216

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

217

# for more details.

218

#

219

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

220

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

221

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

222

"A String",

223

],

224

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

225

# StreamingRecognitionResult with information about the recognized speech

226

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

227

# doesn't return any word-level information.

228

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

229

# Refer to

230

# [Cloud Speech API

231

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

232

# more details.

233

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

234

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

235

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

236

# in the InputAudioConfig.

237

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

238

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

239

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

240

# Refer to

241

# [Cloud Speech API

242

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

243

# for more details.

244

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

245

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

246

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

Dan O'Meara

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

[diff] [blame]

247

# client closes the stream.

248

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

Bu Sun Kim

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

[diff] [blame]

249

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

Dan O'Meara

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

[diff] [blame]

250

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

251

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

252

# needed.

253

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

254

# Note: When specified, InputAudioConfig.single_utterance takes precedence

255

# over StreamingDetectIntentRequest.single_utterance.

256

},

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

#

265

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

266

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

267

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

268

#

269

# - MapKey type: string

270

# - MapKey value: parameter name

271

# - MapValue type:

272

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

273

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

274

# - MapValue value:

275

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

276

# map from composite entity property names to property values

277

# - Else: parameter value

278

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

279

},

280

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

281

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

282

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

283

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

284

},

Dan O'Meara

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

[diff] [blame]

285

},

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

288

# before the new ones are activated.

289

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

290

# Arbitrary JSON objects are supported.

291

# If supplied, the value is used to populate the

292

# `WebhookRequest.original_detect_intent_request.payload`

293

# field sent to your webhook.

294

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

295

},

296

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

297

# of doubles representing degrees latitude and degrees longitude. Unless

298

# specified otherwise, this must conform to the

299

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

300

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

301

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

302

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

303

},

304

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

305

# executed.

306

{ # Represents a context.

307

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

308

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

309

# immediately. Contexts expire automatically after 20 minutes if there

310

# are no matching queries.

311

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

312

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

313

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

314

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

315

#

316

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

317

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

318

#

319

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

320

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

321

#

322

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

323

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

324

#

325

# * `__system_counters__`

326

# * `*_id_dialog_context`

327

# * `*_dialog_params_size`

328

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

329

#

330

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

331

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

332

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

333

#

334

# - MapKey type: string

335

# - MapKey value: parameter name

336

# - MapValue type:

337

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

338

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

339

# - MapValue value:

340

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

341

# map from composite entity property names to property values

342

# - Else: parameter value

343

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

},

},

],

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

348

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

349

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

350

"A String",

351

],

352

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

353

# provided, sentiment analysis is not performed.

354

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

355

# agents.

356

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

357

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

358

# `query_text`.

359

},

360

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

361

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

362

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

363

# agent settings is used.

364

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

365

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

366

# for the session of this query.

367

{ # Represents a session entity type.

368

#

369

# Extends or replaces a custom entity type at the user session level (we

370

# refer to the entity types defined at the agent level as "custom entity

371

# types").

372

#

373

# Note: session entity types apply to all queries, regardless of the language.

374

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

375

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

376

# Display Name>`, or

377

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

378

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

379

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

380

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

381

#

382

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

383

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

384

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

385

# supplement the custom entity type definition.

386

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

387

# type.

388

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

389

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

390

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

391

# *scallions*.

392

#

393

# For `KIND_MAP` entity types:

394

#

395

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

396

#

397

# For `KIND_LIST` entity types:

398

#

399

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

400

# without aliases).

401

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

402

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

403

# onions*.

404

#

405

# For `KIND_LIST` entity types:

406

#

407

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

"A String",

],

},

],

},

],

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

415

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

416

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

417

# within this field will overwrite the headers configured through Dialogflow

418

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

419

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

420

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

421

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

422

"a_key": "A String",

423

},

424

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

425

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

426

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

427

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

428

{ # Contains basic configuration for a sub-agent.

429

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

430

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

431

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

432

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

# is not set.

},

],

},

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

438

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

439

# configured, no output audio is generated.

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

# any value greater than that.

452

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

453

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

454

# original pitch.

455

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

456

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

457

# voice based on the other parameters such as language_code and

458

# ssml_gender.

459

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

460

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

461

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

462

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

463

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

464

},

465

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

466

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

467

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

468

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

469

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

470

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

471

# each other in the order they are given.

"A String",

],

},

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

476

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

477

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

478

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

479

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

480

},

481

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

482

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

483

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

Bu Sun Kim

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

[diff] [blame]

484

}

485

486

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

493

494

{ # The message returned from the DetectIntent method.

Bu Sun Kim

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

[diff] [blame]

495

"queryResult": { # Represents the result of conversational query or event processing. # The selected results of the conversational query or event processing.

Bu Sun Kim

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

[diff] [blame]

496

# See `alternative_query_results` for additional potential results.

Bu Sun Kim

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

[diff] [blame]

497

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

Bu Sun Kim

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

[diff] [blame]

498

#

Bu Sun Kim

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

[diff] [blame]

499

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

500

# the required parameter values have been collected.

501

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

502

# matched intent doesn't contain any required parameters.

503

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

Dan O'Meara

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

[diff] [blame]

504

#

505

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

506

# a copy of the input.

507

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

508

# contains the speech recognition result. If speech recognizer produced

509

# multiple alternatives, a particular one is picked.

510

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

511

# corrected user input.

Bu Sun Kim

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

[diff] [blame]

512

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

513

# indicates an estimated greater likelihood that the recognized words are

514

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

515

# was not set.

516

#

517

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

518

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

519

# separate confidence estimates per portion of the audio in

520

# StreamingRecognitionResult.

521

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

522

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

523

# code that depends on its structure.

524

# The data may contain:

525

#

526

# - webhook call latency

527

# - webhook errors

528

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

529

},

530

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

531

# `output_contexts.parameters` contains entries with name

532

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

533

# before the query.

534

{ # Represents a context.

535

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

536

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

537

# immediately. Contexts expire automatically after 20 minutes if there

538

# are no matching queries.

539

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

540

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

541

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

542

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

543

#

544

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

545

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

546

#

547

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

548

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

549

#

550

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

551

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

552

#

553

# * `__system_counters__`

554

# * `*_id_dialog_context`

555

# * `*_dialog_params_size`

556

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

557

#

558

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

559

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

560

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

561

#

562

# - MapKey type: string

563

# - MapKey value: parameter name

564

# - MapValue type:

565

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

566

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

567

# - MapValue value:

568

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

569

# map from composite entity property names to property values

570

# - Else: parameter value

571

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

},

},

],

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

576

# See [Language

577

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

578

# for a list of the currently supported language codes.

579

"intent": { # Represents an intent. # The intent that matched the conversational query. Some, not

Bu Sun Kim

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

[diff] [blame]

580

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

Dan O'Meara

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

[diff] [blame]

581

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

Bu Sun Kim

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

[diff] [blame]

582

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

583

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

Bu Sun Kim

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

[diff] [blame]

584

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

Bu Sun Kim

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

[diff] [blame]

585

# trained on.

586

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

Bu Sun Kim

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

[diff] [blame]

587

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

Bu Sun Kim

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

[diff] [blame]

588

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

589

#

590

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

591

# Dialogflow Console does.

592

#

593

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

594

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

595

#

596

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

597

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

598

#

599

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

600

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

601

#

602

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

603

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

604

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

605

# set.

606

{ # Represents a part of a training phrase.

Bu Sun Kim

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

[diff] [blame]

607

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

Dan O'Meara

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

[diff] [blame]

608

# annotated part of the example.

609

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

Bu Sun Kim

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

[diff] [blame]

610

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

Bu Sun Kim

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

[diff] [blame]

611

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

612

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

613

# API, you must set this to true.

Bu Sun Kim

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

[diff] [blame]

614

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

615

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

616

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

Bu Sun Kim

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

[diff] [blame]

617

},

618

],

Bu Sun Kim

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

[diff] [blame]

619

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

620

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

Bu Sun Kim

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

[diff] [blame]

621

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

622

# intent or training, this counter is increased.

Bu Sun Kim

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

[diff] [blame]

623

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

Bu Sun Kim

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

[diff] [blame]

624

},

625

],

Bu Sun Kim

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

[diff] [blame]

626

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

627

# session when this intent is matched.

628

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

629

{ # Represents intent parameters.

630

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

631

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

632

# describes values of the parameter. If the parameter is

633

# required, this must be provided.

634

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

635

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

636

"A String",

637

],

638

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

639

# result.

640

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

641

# syntax: `#context_name.parameter_name`.

642

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

643

# whether the intent cannot be completed without collecting the parameter

644

# value.

645

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

646

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

647

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

648

#

649

# - a constant string,

650

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

651

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

652

# - a parameter value from some context defined as

653

# `#context_name.parameter_name`.

654

},

Bu Sun Kim

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

[diff] [blame]

655

],

Bu Sun Kim

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

[diff] [blame]

656

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

657

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

658

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

659

# Event names are limited to 150 characters.

660

"A String",

661

],

662

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

663

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

664

# for example with CreateIntent or

665

# BatchUpdateIntents, in order to make this

666

# intent a followup intent.

667

#

668

# It identifies the parent followup intent.

669

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

670

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

Dan O'Meara

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

[diff] [blame]

671

# priorities.

Bu Sun Kim

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

[diff] [blame]

672

#

Dan O'Meara

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

[diff] [blame]

673

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

674

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

675

# `Normal` priority in the console.

676

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

677

# in runtime detect intent requests.

Bu Sun Kim

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

[diff] [blame]

678

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

679

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

680

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

681

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

Bu Sun Kim

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

[diff] [blame]

682

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

683

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

684

# when the intent is matched.

Dan O'Meara

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

[diff] [blame]

685

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

Bu Sun Kim

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

[diff] [blame]

686

{ # Represents a context.

Bu Sun Kim

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

[diff] [blame]

687

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

688

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

689

# immediately. Contexts expire automatically after 20 minutes if there

690

# are no matching queries.

691

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

Dan O'Meara

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

[diff] [blame]

692

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

693

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

694

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

Bu Sun Kim

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

[diff] [blame]

695

#

696

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

697

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

698

#

Bu Sun Kim

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

[diff] [blame]

699

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

700

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

Dan O'Meara

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

[diff] [blame]

701

#

702

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

703

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

704

#

705

# * `__system_counters__`

706

# * `*_id_dialog_context`

707

# * `*_dialog_params_size`

Bu Sun Kim

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

[diff] [blame]

708

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

Dan O'Meara

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

[diff] [blame]

709

#

710

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

711

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

712

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

713

#

714

# - MapKey type: string

715

# - MapKey value: parameter name

716

# - MapValue type:

Bu Sun Kim

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

[diff] [blame]

717

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

Dan O'Meara

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

[diff] [blame]

718

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

719

# - MapValue value:

Bu Sun Kim

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

[diff] [blame]

720

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

Dan O'Meara

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

[diff] [blame]

721

# map from composite entity property names to property values

722

# - Else: parameter value

Bu Sun Kim

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

[diff] [blame]

723

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

Dan O'Meara

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

[diff] [blame]

724

},

Bu Sun Kim

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

[diff] [blame]

725

},

726

],

Bu Sun Kim

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

[diff] [blame]

727

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

728

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

729

"A String",

Bu Sun Kim

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

[diff] [blame]

730

],

Bu Sun Kim

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

[diff] [blame]

731

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

732

# `Response` field in the Dialogflow console.

Bu Sun Kim

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

[diff] [blame]

733

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

Bu Sun Kim

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

[diff] [blame]

734

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

735

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

736

"A String",

Bu Sun Kim

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

[diff] [blame]

737

],

738

},

Bu Sun Kim

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

[diff] [blame]

739

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

740

#

741

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

742

# with media and suggestions.

743

#

744

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

745

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

746

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

747

# please use RbmStandaloneCard instead.

Bu Sun Kim

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

[diff] [blame]

748

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

749

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

750

# 2 cards and at most 10.

751

{ # Rich Business Messaging (RBM) Card content

Bu Sun Kim

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

[diff] [blame]

752

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

753

#

754

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

755

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

756

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

757

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

Bu Sun Kim

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

[diff] [blame]

762

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

774

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

Dan O'Meara

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

[diff] [blame]

775

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

Bu Sun Kim

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

[diff] [blame]

776

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

777

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

Dan O'Meara

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

[diff] [blame]

778

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

Bu Sun Kim

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

[diff] [blame]

779

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

Dan O'Meara

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

[diff] [blame]

780

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

781

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

782

# customizable, and this field is ignored.

Bu Sun Kim

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

[diff] [blame]

783

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

784

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

785

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

786

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

Dan O'Meara

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

[diff] [blame]

787

},

Bu Sun Kim

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

[diff] [blame]

788

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

Dan O'Meara

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

[diff] [blame]

789

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

790

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

791

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

792

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

793

# instead of typing in their own response.

794

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

795

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

796

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

797

# forwarded to webhook to allow performing custom business logic.

798

},

799

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

800

# can choose from the card.

Bu Sun Kim

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

[diff] [blame]

801

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

802

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

803

# forwarded to webhook to allow performing custom business logic.

804

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

Dan O'Meara

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

[diff] [blame]

805

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

806

},

Bu Sun Kim

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

[diff] [blame]

807

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

808

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

Dan O'Meara

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

[diff] [blame]

809

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

810

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

811

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

Bu Sun Kim

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

[diff] [blame]

812

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

Dan O'Meara

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

[diff] [blame]

813

},

Bu Sun Kim

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

[diff] [blame]

814

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

Dan O'Meara

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

[diff] [blame]

815

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

Bu Sun Kim

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

[diff] [blame]

816

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

Dan O'Meara

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

[diff] [blame]

817

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

818

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

819

# +15556767888.

820

},

Dan O'Meara

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

[diff] [blame]

821

},

822

},

823

],

Bu Sun Kim

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

[diff] [blame]

824

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

Dan O'Meara

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

[diff] [blame]

825

#

826

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

Bu Sun Kim

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

[diff] [blame]

827

},

828

],

829

},

Bu Sun Kim

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

[diff] [blame]

830

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

831

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

832

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

833

# to the conversation.

834

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

},

],

},

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

839

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

840

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

841

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

Bu Sun Kim

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

[diff] [blame]

842

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

843

#

Dan O'Meara

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

[diff] [blame]

844

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

845

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

846

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

Bu Sun Kim

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

[diff] [blame]

847

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

848

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

849

# added by default when enabling the Dialogflow V2 API.

850

#

851

# For audio from other sources, consider using the

852

# `TelephonySynthesizeSpeech` message with SSML.

853

},

Bu Sun Kim

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

[diff] [blame]

854

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

855

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

856

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

857

"items": [ # Required. List items.

858

{ # An item in the list.

859

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

860

# dialog.

861

"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

866

# response is given.

867

},

868

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

869

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

870

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

871

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

872

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

873

},

874

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

},

],

},

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

879

#

880

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

881

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

882

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

883

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

884

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

885

# opening a web uri).

886

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

887

# instead of typing in their own response.

888

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

889

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

890

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

891

# forwarded to webhook to allow performing custom business logic.

892

},

893

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

894

# can choose from the card.

895

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

896

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

897

# forwarded to webhook to allow performing custom business logic.

898

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

899

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

900

},

901

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

902

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

903

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

904

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

905

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

906

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

907

},

908

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

909

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

910

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

911

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

912

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

# +15556767888.

},

},

},

],

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

919

},

920

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

921

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

922

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

"A String",

],

},

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

927

# Telephony Gateway.

928

#

929

# Telephony Gateway takes the synthesizer settings from

930

# `DetectIntentResponse.output_audio_config` which can either be set

931

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

932

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

933

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

934

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

935

},

936

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

937

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

938

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

939

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

940

{ # Optional. Contains information about a button.

941

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

942

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

# open.

},

],

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

947

},

948

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

949

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

950

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

951

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

952

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

953

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

954

},

955

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

956

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

957

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

958

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

959

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

960

},

961

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

962

},

963

],

964

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

965

},

966

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

967

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

968

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

969

{ # Column properties for TableCard.

970

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

971

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

972

},

973

],

974

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

975

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

976

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

977

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

978

},

979

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

980

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

981

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

982

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

983

},

984

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

985

},

986

],

987

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

988

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

989

{ # Row of TableCard.

990

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

991

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

992

{ # Cell of TableCardRow.

993

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

},

],

},

],

},

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

1000

"items": [ # Required. Carousel items.

1001

{ # An item in the carousel.

1002

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

1003

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

1004

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

1005

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

1006

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

1007

},

1008

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

1009

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

1010

# dialog.

1011

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

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

1022

# or website associated with this agent.

1023

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

1024

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

1025

# suggestion chip.

1026

},

1027

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

1028

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

1029

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

1030

# items.

1031

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

1032

# items, maximum of ten.

1033

{ # Browsing carousel tile

1034

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

1035

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

1036

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

1037

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

1038

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

1039

},

1040

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

1041

# text.

1042

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

1043

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

1044

# the URL. Defaults to opening via web browser.

1045

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

1046

},

1047

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

1048

# Card. Maximum of one line of text.

},

],

},

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

1053

# This message in `QueryResult.fulfillment_messages` and

1054

# `WebhookResponse.fulfillment_messages` should contain only one

1055

# `SimpleResponse`.

1056

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

1057

{ # The simple response message containing speech or text.

1058

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

1059

# speech output. Mutually exclusive with ssml.

1060

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

1061

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

1062

# text_to_speech.

1063

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

},

],

},

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

1068

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

1069

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

1070

#

1071

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

1072

},

1073

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

1074

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

1075

{ # Response media object for media content card.

1076

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

1077

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

1078

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

1079

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

1080

},

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

},

},

],

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

1092

},

1093

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

1094

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

1095

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

1096

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

1097

},

1098

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

1099

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

1100

},

1101

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

1102

#

1103

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

1104

# with media and suggestions.

1105

#

1106

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

1107

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

1108

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

1109

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

Bu Sun Kim

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

[diff] [blame]

1110

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

Dan O'Meara

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

[diff] [blame]

1111

# Image preview alignment for standalone cards with horizontal layout.

Bu Sun Kim

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

[diff] [blame]

1112

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

1113

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

1114

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

1115

#

1116

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

1117

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

1118

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

1119

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

Bu Sun Kim

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

[diff] [blame]

1124

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

1136

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

Dan O'Meara

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

[diff] [blame]

1137

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

Bu Sun Kim

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

[diff] [blame]

1138

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

1139

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

Dan O'Meara

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

[diff] [blame]

1140

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

Bu Sun Kim

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

[diff] [blame]

1141

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

Dan O'Meara

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

[diff] [blame]

1142

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

1143

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

1144

# customizable, and this field is ignored.

Bu Sun Kim

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

[diff] [blame]

1145

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

1146

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

1147

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

1148

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

Dan O'Meara

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

[diff] [blame]

1149

},

Bu Sun Kim

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

[diff] [blame]

1150

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

Dan O'Meara

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

[diff] [blame]

1151

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

1152

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

1153

# opening a web uri).

Bu Sun Kim

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

[diff] [blame]

1154

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

1155

# instead of typing in their own response.

1156

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

1157

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

1158

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

1159

# forwarded to webhook to allow performing custom business logic.

1160

},

1161

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

1162

# can choose from the card.

Bu Sun Kim

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

[diff] [blame]

1163

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

1164

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

1165

# forwarded to webhook to allow performing custom business logic.

1166

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

Dan O'Meara

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

[diff] [blame]

1167

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

1168

},

Bu Sun Kim

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

[diff] [blame]

1169

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

1170

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

Dan O'Meara

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

[diff] [blame]

1171

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

1172

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

1173

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

Bu Sun Kim

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

[diff] [blame]

1174

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

Dan O'Meara

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

[diff] [blame]

1175

},

Bu Sun Kim

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

[diff] [blame]

1176

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

Dan O'Meara

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

[diff] [blame]

1177

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

Bu Sun Kim

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

[diff] [blame]

1178

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

Dan O'Meara

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

[diff] [blame]

1179

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

1180

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

1181

# +15556767888.

1182

},

Dan O'Meara

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

[diff] [blame]

1183

},

1184

},

1185

],

Bu Sun Kim

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

[diff] [blame]

1186

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

Dan O'Meara

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

[diff] [blame]

1187

#

1188

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

1189

},

Bu Sun Kim

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

[diff] [blame]

1190

},

1191

},

1192

],

Bu Sun Kim

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

[diff] [blame]

1193

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

1194

# Note: The action name must not contain whitespaces.

1195

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

1196

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

1197

# methods.

1198

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

1199

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

1200

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

1201

# triggered.

1202

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

1203

"A String",

1204

],

1205

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

1206

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

1207

{ # Represents a single followup intent in the chain.

1208

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

1209

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

1210

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

1211

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

1212

},

1213

],

1214

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

1215

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

1216

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

1217

# this intent.

Dan O'Meara

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

[diff] [blame]

1218

#

Bu Sun Kim

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

[diff] [blame]

1219

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

1220

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

1221

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

1222

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

1223

# auto-markup in the UI is turned off.

1224

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

1225

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

1226

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

1227

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

1228

# auto-markup in the UI is turned off.

1229

# DEPRECATED! Please use `ml_disabled` field instead.

1230

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

1231

# then the default value is determined as follows:

1232

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

1233

# ml_enabled = false / ml_disabled = true.

1234

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

1235

# ml_enabled = true / ml_disabled = false.

1236

},

1237

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

1238

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

1239

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

1240

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

"A String",

],

},

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

1245

#

1246

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

1247

# with media and suggestions.

1248

#

1249

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

1250

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

1251

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

1252

# please use RbmStandaloneCard instead.

1253

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

1254

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

1255

# 2 cards and at most 10.

1256

{ # Rich Business Messaging (RBM) Card content

1257

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

1258

#

1259

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

1260

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

1261

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

1262

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

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

1280

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

1281

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

1282

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

1283

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

1284

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

1285

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

1286

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

1287

# customizable, and this field is ignored.

1288

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

1289

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

1290

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

1291

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

1292

},

1293

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

1294

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

1295

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

1296

# opening a web uri).

1297

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

1298

# instead of typing in their own response.

1299

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

1300

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

1301

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

1302

# forwarded to webhook to allow performing custom business logic.

1303

},

1304

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

1305

# can choose from the card.

1306

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

1307

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

1308

# forwarded to webhook to allow performing custom business logic.

1309

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

1310

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

1311

},

1312

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

1313

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

1314

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

1315

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

1316

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

1317

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

1318

},

1319

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

1320

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

1321

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

1322

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

1323

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

# +15556767888.

},

},

},

],

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

1330

#

1331

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

},

],

},

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

1336

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

1337

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

1338

# to the conversation.

1339

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

},

],

},

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

1344

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

1345

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

1346

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

1347

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

1348

#

1349

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

1350

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

1351

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

1352

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

1353

# Storage bucket is in the Telephony Gateway project, this permission is

1354

# added by default when enabling the Dialogflow V2 API.

1355

#

1356

# For audio from other sources, consider using the

1357

# `TelephonySynthesizeSpeech` message with SSML.

1358

},

1359

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

1360

"title": "A String", # Optional. The overall title of the list.

1361

"subtitle": "A String", # Optional. Subtitle of the list.

1362

"items": [ # Required. List items.

1363

{ # An item in the list.

1364

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

1365

# dialog.

1366

"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

1371

# response is given.

1372

},

1373

"title": "A String", # Required. The title of the list item.

1374

"image": { # The image response message. # Optional. The image to display.

1375

"imageUri": "A String", # Optional. The public URI to an image file.

1376

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1377

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1378

},

1379

"description": "A String", # Optional. The main text describing the item.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

1384

#

1385

# RBM allows businesses to send enriched and branded versions of SMS. See

1386

# https://jibe.google.com/business-messaging.

1387

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

1388

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1389

# easily select/click a predefined response or perform an action (like

1390

# opening a web uri).

1391

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1392

# instead of typing in their own response.

1393

"text": "A String", # Suggested reply text.

1394

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1395

# when the user taps the suggested reply. This data will be also

1396

# forwarded to webhook to allow performing custom business logic.

1397

},

1398

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1399

# can choose from the card.

1400

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1401

# when the user taps the suggested action. This data will be also

1402

# forwarded to webhook to allow performing custom business logic.

1403

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1404

# to send back to the agent (https://goo.gl/GXotJW).

1405

},

1406

"text": "A String", # Text to display alongside the action.

1407

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1408

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1409

# registered as the default handler for the URL, then this app will be

1410

# opened instead, and its icon will be used in the suggested action UI.

1411

"uri": "A String", # Required. The uri to open on the user device

1412

},

1413

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1414

# but does not dial automatically (https://goo.gl/ergbB2).

1415

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1416

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1417

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

1424

},

1425

"quickReplies": { # The quick replies response message. # Displays quick replies.

1426

"title": "A String", # Optional. The title of the collection of quick replies.

1427

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

1432

# Telephony Gateway.

1433

#

1434

# Telephony Gateway takes the synthesizer settings from

1435

# `DetectIntentResponse.output_audio_config` which can either be set

1436

# at request-level or can come from the agent-level synthesizer config.

1437

"text": "A String", # The raw text to be synthesized.

1438

"ssml": "A String", # The SSML to be synthesized. For more information, see

1439

# [SSML](https://developers.google.com/actions/reference/ssml).

1440

},

1441

"card": { # The card response message. # Displays a card.

1442

"imageUri": "A String", # Optional. The public URI to an image file for the card.

1443

"title": "A String", # Optional. The title of the card.

1444

"buttons": [ # Optional. The collection of card buttons.

1445

{ # Optional. Contains information about a button.

1446

"text": "A String", # Optional. The text to show on the button.

1447

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

1452

},

1453

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

1454

"title": "A String", # Optional. The title of the card.

1455

"image": { # The image response message. # Optional. The image for the card.

1456

"imageUri": "A String", # Optional. The public URI to an image file.

1457

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1458

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1459

},

1460

"formattedText": "A String", # Required, unless image is present. The body text of the card.

1461

"buttons": [ # Optional. The collection of card buttons.

1462

{ # The button object that appears at the bottom of a card.

1463

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1464

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1465

},

1466

"title": "A String", # Required. The title of the button.

1467

},

1468

],

1469

"subtitle": "A String", # Optional. The subtitle of the card.

1470

},

1471

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

1472

"subtitle": "A String", # Optional. Subtitle to the title.

1473

"columnProperties": [ # Optional. Display properties for the columns in this table.

1474

{ # Column properties for TableCard.

1475

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

1476

"header": "A String", # Required. Column heading.

1477

},

1478

],

1479

"image": { # The image response message. # Optional. Image which should be displayed on the card.

1480

"imageUri": "A String", # Optional. The public URI to an image file.

1481

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1482

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1483

},

1484

"buttons": [ # Optional. List of buttons for the card.

1485

{ # The button object that appears at the bottom of a card.

1486

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

1487

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

1488

},

1489

"title": "A String", # Required. The title of the button.

1490

},

1491

],

1492

"title": "A String", # Required. Title of the card.

1493

"rows": [ # Optional. Rows in this table of data.

1494

{ # Row of TableCard.

1495

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

1496

"cells": [ # Optional. List of cells that make up this row.

1497

{ # Cell of TableCardRow.

1498

"text": "A String", # Required. Text in this cell.

},

],

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

1505

"items": [ # Required. Carousel items.

1506

{ # An item in the carousel.

1507

"title": "A String", # Required. Title of the carousel item.

1508

"image": { # The image response message. # Optional. The image to display.

1509

"imageUri": "A String", # Optional. The public URI to an image file.

1510

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1511

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1512

},

1513

"description": "A String", # Optional. The body text of the card.

1514

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

1515

# dialog.

1516

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

1527

# or website associated with this agent.

1528

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

1529

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

1530

# suggestion chip.

1531

},

1532

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

1533

# https://developers.google.com/actions/assistant/responses#browsing_carousel

1534

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

1535

# items.

1536

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

1537

# items, maximum of ten.

1538

{ # Browsing carousel tile

1539

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

1540

"image": { # The image response message. # Optional. Hero image for the carousel item.

1541

"imageUri": "A String", # Optional. The public URI to an image file.

1542

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1543

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1544

},

1545

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

1546

# text.

1547

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

1548

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

1549

# the URL. Defaults to opening via web browser.

1550

"url": "A String", # Required. URL

1551

},

1552

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

1553

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

1558

# This message in `QueryResult.fulfillment_messages` and

1559

# `WebhookResponse.fulfillment_messages` should contain only one

1560

# `SimpleResponse`.

1561

"simpleResponses": [ # Required. The list of simple responses.

1562

{ # The simple response message containing speech or text.

1563

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

1564

# speech output. Mutually exclusive with ssml.

1565

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

1566

# response to the user in the SSML format. Mutually exclusive with

1567

# text_to_speech.

1568

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

1573

"phoneNumber": "A String", # Required. The phone number to transfer the call to

1574

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

1575

#

1576

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

1577

},

1578

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

1579

"mediaObjects": [ # Required. List of media objects.

1580

{ # Response media object for media content card.

1581

"largeImage": { # The image response message. # Optional. Image to display above media content.

1582

"imageUri": "A String", # Optional. The public URI to an image file.

1583

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1584

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1585

},

1586

"name": "A String", # Required. Name of media card.

1587

"description": "A String", # Optional. Description of media card.

1588

"contentUrl": "A String", # Required. Url where the media is stored.

1589

"icon": { # The image response message. # Optional. Icon to display above media content.

1590

"imageUri": "A String", # Optional. The public URI to an image file.

1591

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1592

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

1597

},

1598

"image": { # The image response message. # Displays an image.

1599

"imageUri": "A String", # Optional. The public URI to an image file.

1600

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

1601

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

1602

},

1603

"payload": { # A custom platform-specific response.

1604

"a_key": "", # Properties of the object.

1605

},

1606

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

1607

#

1608

# Rich cards allow you to respond to users with more vivid content, e.g.

1609

# with media and suggestions.

1610

#

1611

# For more details about RBM rich cards, please see:

1612

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

1613

# You can group multiple rich cards into one using RbmCarouselCard but

1614

# carousel cards will give you less control over the card layout.

1615

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

1616

# Image preview alignment for standalone cards with horizontal layout.

1617

"cardOrientation": "A String", # Required. Orientation of the card.

1618

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

1619

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

1620

#

1621

# At least one of the title, description or media must be set.

1622

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

1623

# be set. Media (image, GIF or a video) to include in the card.

1624

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

1642

# provide a thumbnail URI, the RBM platform displays a blank

1643

# placeholder thumbnail until the user's device downloads the file.

1644

# Depending on the user's setting, the file may not download

1645

# automatically and may require the user to tap a download button.

1646

"height": "A String", # Required for cards with vertical orientation. The height of the media

1647

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

1648

# For a standalone card with horizontal layout, height is not

1649

# customizable, and this field is ignored.

1650

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

1651

# determines the MIME type of the file from the content-type field in

1652

# the HTTP headers when the platform fetches the file. The content-type

1653

# field must be present and accurate in the HTTP response from the URL.

1654

},

1655

"suggestions": [ # Optional. List of suggestions to include in the card.

1656

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

1657

# easily select/click a predefined response or perform an action (like

1658

# opening a web uri).

1659

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

1660

# instead of typing in their own response.

1661

"text": "A String", # Suggested reply text.

1662

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1663

# when the user taps the suggested reply. This data will be also

1664

# forwarded to webhook to allow performing custom business logic.

1665

},

1666

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

1667

# can choose from the card.

1668

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

1669

# when the user taps the suggested action. This data will be also

1670

# forwarded to webhook to allow performing custom business logic.

1671

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

1672

# to send back to the agent (https://goo.gl/GXotJW).

1673

},

1674

"text": "A String", # Text to display alongside the action.

1675

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

1676

# (https://goo.gl/6GLJD2). If the user has an app installed that is

1677

# registered as the default handler for the URL, then this app will be

1678

# opened instead, and its icon will be used in the suggested action UI.

1679

"uri": "A String", # Required. The uri to open on the user device

1680

},

1681

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

1682

# but does not dial automatically (https://goo.gl/ergbB2).

1683

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

1684

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

1685

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

1692

#

1693

# At least one of the title, description or media must be set.

},

},

},

],

"webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the

1699

# value of the `payload` field returned in the webhook response.

1700

"a_key": "", # Properties of the object.

1701

},

1702

"action": "A String", # The action name from the matched intent.

1703

"webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the

1704

# value of the `source` field returned in the webhook response.

1705

"fulfillmentText": "A String", # The text to be pronounced to the user or shown on the screen.

1706

# Note: This is a legacy field, `fulfillment_messages` should be preferred.

1707

"parameters": { # The collection of extracted parameters.

1708

#

1709

# Depending on your protocol or client library language, this is a

1710

# map, associative array, symbol table, dictionary, or JSON object

1711

# composed of a collection of (MapKey, MapValue) pairs:

1712

#

1713

# - MapKey type: string

1714

# - MapKey value: parameter name

1715

# - MapValue type:

1716

# - If parameter's entity type is a composite entity: map

1717

# - Else: string or number, depending on parameter value type

1718

# - MapValue value:

1719

# - If parameter's entity type is a composite entity:

1720

# map from composite entity property names to property values

1721

# - Else: parameter value

1722

"a_key": "", # Properties of the object.

1723

},

1724

"knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing

1725

# `KnowledgeAnswers.match_confidence`.

1726

"answers": [ # A list of answers from Knowledge Connector.

1727

{ # An answer from Knowledge Connector.

1728

"source": "A String", # Indicates which Knowledge Document this answer was extracted from.

1729

# Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base

1730

# ID>/documents/<Document ID>`.

1731

"answer": "A String", # The piece of text from the `source` knowledge base document that answers

1732

# this conversational query.

1733

"faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ

1734

# Document, empty otherwise.

1735

"matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match

1736

# for this conversational query.

1737

# NOTE: The confidence level for a given `<query, answer>` pair may change

1738

# without notice, as it depends on models that are constantly being

1739

# improved. However, it will change less frequently than the confidence

1740

# score below, and should be preferred for referencing the quality of an

1741

# answer.

1742

"matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match

1743

# for this conversational query.

1744

# The range is from 0.0 (completely uncertain) to 1.0 (completely certain).

1745

# Note: The confidence score is likely to vary somewhat (possibly even for

1746

# identical requests), as the underlying model is under constant

1747

# improvement. It may be deprecated in the future. We recommend using

1748

# `match_confidence_level` which should be generally more stable.

},

],

},

"sentimentAnalysisResult": { # The result of sentiment analysis as configured by # The sentiment analysis result, which depends on the

1753

# `sentiment_analysis_request_config` specified in the request.

1754

# `sentiment_analysis_request_config`.

1755

"queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.

1756

# of analysis, such as the query text.

1757

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive

1758

# sentiment).

1759

"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute

1760

# magnitude of sentiment, regardless of score (positive or negative).

1761

},

1762

},

1763

"intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0

1764

# (completely uncertain) to 1.0 (completely certain).

1765

# This value is for informational purpose only and is only used to

1766

# help match the best intent within the classification threshold.

1767

# This value may change for the same end-user expression at any time due to a

1768

# model retraining or change in implementation.

1769

# If there are `multiple knowledge_answers` messages, this value is set to

1770

# the greatest `knowledgeAnswers.match_confidence` value in the list.

1771

},

1772

"webhookStatus": { # The `Status` type defines a logical error model that is suitable for # Specifies the status of the webhook request.

1773

# different programming environments, including REST APIs and RPC APIs. It is

1774

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1775

# three pieces of data: error code, error message, and error details.

1776

#

1777

# You can find out more about this error model and how to work with it in the

1778

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1779

"details": [ # A list of messages that carry the error details. There is a common set of

1780

# message types for APIs to use.

1781

{

1782

"a_key": "", # Properties of the object. Contains field @type with type URL.

1783

},

1784

],

1785

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1786

"message": "A String", # A developer-facing error message, which should be in English. Any

1787

# user-facing error message should be localized and sent in the

1788

# google.rpc.Status.details field, or localized by the client.

1789

},

1790

"alternativeQueryResults": [ # If Knowledge Connectors are enabled, there could be more than one result

1791

# returned for a given query or event, and this field will contain all

1792

# results except for the top one, which is captured in query_result. The

1793

# alternative results are ordered by decreasing

1794

# `QueryResult.intent_detection_confidence`. If Knowledge Connectors are

1795

# disabled, this field will be empty until multiple responses for regular

1796

# intents are supported, at which point those additional results will be

1797

# surfaced here.

1798

{ # Represents the result of conversational query or event processing.

1799

"allRequiredParamsPresent": True or False, # This field is set to:

1800

#

1801

# - `false` if the matched intent has required parameters and not all of

1802

# the required parameter values have been collected.

1803

# - `true` if all required parameter values have been collected, or if the

1804

# matched intent doesn't contain any required parameters.

1805

"queryText": "A String", # The original conversational query text:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1806

#

1807

# - If natural language text was provided as input, `query_text` contains

1808

# a copy of the input.

1809

# - If natural language speech audio was provided as input, `query_text`

1810

# contains the speech recognition result. If speech recognizer produced

1811

# multiple alternatives, a particular one is picked.

1812

# - If automatic spell correction is enabled, `query_text` will contain the

1813

# corrected user input.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1814

"speechRecognitionConfidence": 3.14, # The Speech recognition confidence between 0.0 and 1.0. A higher number

1815

# indicates an estimated greater likelihood that the recognized words are

1816

# correct. The default of 0.0 is a sentinel value indicating that confidence

1817

# was not set.

1818

#

1819

# This field is not guaranteed to be accurate or set. In particular this

1820

# field isn't set for StreamingDetectIntent since the streaming endpoint has

1821

# separate confidence estimates per portion of the audio in

1822

# StreamingRecognitionResult.

1823

"diagnosticInfo": { # Free-form diagnostic information for the associated detect intent request.

1824

# The fields of this data can change without notice, so you should not write

1825

# code that depends on its structure.

1826

# The data may contain:

1827

#

1828

# - webhook call latency

1829

# - webhook errors

1830

"a_key": "", # Properties of the object.

1831

},

1832

"outputContexts": [ # The collection of output contexts. If applicable,

1833

# `output_contexts.parameters` contains entries with name

1834

# `<parameter name>.original` containing the original parameter values

1835

# before the query.

1836

{ # Represents a context.

1837

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1838

# context expires. The default is `0`. If set to `0`, the context expires

1839

# immediately. Contexts expire automatically after 20 minutes if there

1840

# are no matching queries.

1841

"name": "A String", # Required. The unique identifier of the context. Format:

1842

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1843

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1844

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

1845

#

1846

# The `Context ID` is always converted to lowercase, may only contain

1847

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

1848

#

1849

# If `Environment ID` is not specified, we assume default 'draft'

1850

# environment. If `User ID` is not specified, we assume default '-' user.

1851

#

1852

# The following context names are reserved for internal use by Dialogflow.

1853

# You should not use these contexts or create contexts with these names:

1854

#

1855

# * `__system_counters__`

1856

# * `*_id_dialog_context`

1857

# * `*_dialog_params_size`

1858

"parameters": { # Optional. The collection of parameters associated with this context.

1859

#

1860

# Depending on your protocol or client library language, this is a

1861

# map, associative array, symbol table, dictionary, or JSON object

1862

# composed of a collection of (MapKey, MapValue) pairs:

1863

#

1864

# - MapKey type: string

1865

# - MapKey value: parameter name

1866

# - MapValue type:

1867

# - If parameter's entity type is a composite entity: map

1868

# - Else: string or number, depending on parameter value type

1869

# - MapValue value:

1870

# - If parameter's entity type is a composite entity:

1871

# map from composite entity property names to property values

1872

# - Else: parameter value

1873

"a_key": "", # Properties of the object.

},

},

],

"languageCode": "A String", # The language that was triggered during intent detection.

1878

# See [Language

1879

# Support](https://cloud.google.com/dialogflow/docs/reference/language)

1880

# for a list of the currently supported language codes.

1881

"intent": { # Represents an intent. # The intent that matched the conversational query. Some, not

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1882

# all fields are filled in this message, including but not limited to:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1883

# `name`, `display_name`, `end_interaction` and `is_fallback`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1884

# Intents convert a number of user expressions or patterns into an action. An

1885

# action is an extraction of a user command or sentence semantics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1886

"trainingPhrases": [ # Optional. The collection of examples that the agent is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1887

# trained on.

1888

{ # Represents an example that the agent is trained on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1889

"parts": [ # Required. The ordered list of training phrase parts.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1890

# The parts are concatenated in order to form the training phrase.

1891

#

1892

# Note: The API does not automatically annotate training phrases like the

1893

# Dialogflow Console does.

1894

#

1895

# Note: Do not forget to include whitespace at part boundaries,

1896

# so the training phrase is well formatted when the parts are concatenated.

1897

#

1898

# If the training phrase does not need to be annotated with parameters,

1899

# you just need a single part with only the Part.text field set.

1900

#

1901

# If you want to annotate the training phrase, you must create multiple

1902

# parts, where the fields of each part are populated in one of two ways:

1903

#

1904

# - `Part.text` is set to a part of the phrase that has no parameters.

1905

# - `Part.text` is set to a part of the phrase that you want to annotate,

1906

# and the `entity_type`, `alias`, and `user_defined` fields are all

1907

# set.

1908

{ # Represents a part of a training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1909

"alias": "A String", # Optional. The parameter name for the value extracted from the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1910

# annotated part of the example.

1911

# This field is required for annotated parts of the training phrase.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1912

"userDefined": True or False, # Optional. Indicates whether the text was manually annotated.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1913

# This field is set to true when the Dialogflow Console is used to

1914

# manually annotate the part. When creating an annotated part with the

1915

# API, you must set this to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1916

"text": "A String", # Required. The text for this part.

1917

"entityType": "A String", # Optional. The entity type name prefixed with `@`.

1918

# This field is required for annotated parts of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1919

},

1920

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1921

"name": "A String", # Output only. The unique identifier of this training phrase.

1922

"timesAddedCount": 42, # Optional. Indicates how many times this example was added to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1923

# the intent. Each time a developer adds an existing sample by editing an

1924

# intent or training, this counter is increased.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1925

"type": "A String", # Required. The type of the training phrase.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1926

},

1927

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1928

"resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current

1929

# session when this intent is matched.

1930

"parameters": [ # Optional. The collection of parameters associated with the intent.

1931

{ # Represents intent parameters.

1932

"displayName": "A String", # Required. The name of the parameter.

1933

"entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that

1934

# describes values of the parameter. If the parameter is

1935

# required, this must be provided.

1936

"prompts": [ # Optional. The collection of prompts that the agent can present to the

1937

# user in order to collect a value for the parameter.

1938

"A String",

1939

],

1940

"defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty

1941

# result.

1942

# Default values can be extracted from contexts by using the following

1943

# syntax: `#context_name.parameter_name`.

1944

"mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,

1945

# whether the intent cannot be completed without collecting the parameter

1946

# value.

1947

"isList": True or False, # Optional. Indicates whether the parameter represents a list of values.

1948

"name": "A String", # The unique identifier of this parameter.

1949

"value": "A String", # Optional. The definition of the parameter value. It can be:

1950

#

1951

# - a constant string,

1952

# - a parameter value defined as `$parameter_name`,

1953

# - an original parameter value defined as `$parameter_name.original`,

1954

# - a parameter value from some context defined as

1955

# `#context_name.parameter_name`.

1956

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1957

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1958

"events": [ # Optional. The collection of event names that trigger the intent.

1959

# If the collection of input contexts is not empty, all of the contexts must

1960

# be present in the active user session for an event to trigger this intent.

1961

# Event names are limited to 150 characters.

1962

"A String",

1963

],

1964

"parentFollowupIntentName": "A String", # Optional. The unique identifier of the parent intent in the

1965

# chain of followup intents. You can set this field when creating an intent,

1966

# for example with CreateIntent or

1967

# BatchUpdateIntents, in order to make this

1968

# intent a followup intent.

1969

#

1970

# It identifies the parent followup intent.

1971

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

1972

"priority": 42, # Optional. The priority of this intent. Higher numbers represent higher

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1973

# priorities.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1974

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1975

# - If the supplied value is unspecified or 0, the service

1976

# translates the value to 500,000, which corresponds to the

1977

# `Normal` priority in the console.

1978

# - If the supplied value is negative, the intent is ignored

1979

# in runtime detect intent requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1980

"endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations

1981

# (e.g., Actions on Google or Dialogflow phone gateway) use this information

1982

# to close interaction with an end user. Default is false.

1983

"outputContexts": [ # Optional. The collection of contexts that are activated when the intent

1984

# is matched. Context messages in this collection should not set the

1985

# parameters field. Setting the `lifespan_count` to 0 will reset the context

1986

# when the intent is matched.

1987

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

1988

{ # Represents a context.

1989

"lifespanCount": 42, # Optional. The number of conversational query requests after which the

1990

# context expires. The default is `0`. If set to `0`, the context expires

1991

# immediately. Contexts expire automatically after 20 minutes if there

1992

# are no matching queries.

1993

"name": "A String", # Required. The unique identifier of the context. Format:

1994

# `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,

1995

# or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User

1996

# ID>/sessions/<Session ID>/contexts/<Context ID>`.

1997

#

1998

# The `Context ID` is always converted to lowercase, may only contain

1999

# characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

2000

#

2001

# If `Environment ID` is not specified, we assume default 'draft'

2002

# environment. If `User ID` is not specified, we assume default '-' user.

2003

#

2004

# The following context names are reserved for internal use by Dialogflow.

2005

# You should not use these contexts or create contexts with these names:

2006

#

2007

# * `__system_counters__`

2008

# * `*_id_dialog_context`

2009

# * `*_dialog_params_size`

2010

"parameters": { # Optional. The collection of parameters associated with this context.

2011

#

2012

# Depending on your protocol or client library language, this is a

2013

# map, associative array, symbol table, dictionary, or JSON object

2014

# composed of a collection of (MapKey, MapValue) pairs:

2015

#

2016

# - MapKey type: string

2017

# - MapKey value: parameter name

2018

# - MapValue type:

2019

# - If parameter's entity type is a composite entity: map

2020

# - Else: string or number, depending on parameter value type

2021

# - MapValue value:

2022

# - If parameter's entity type is a composite entity:

2023

# map from composite entity property names to property values

2024

# - Else: parameter value

2025

"a_key": "", # Properties of the object.

},

},

],

"defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be

2030

# copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

2031

"A String",

2032

],

2033

"messages": [ # Optional. The collection of rich messages corresponding to the

2034

# `Response` field in the Dialogflow console.

2035

{ # Corresponds to the `Response` field in the Dialogflow console.

2036

"text": { # The text response message. # Returns a text response.

2037

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

2042

#

2043

# Rich cards allow you to respond to users with more vivid content, e.g.

2044

# with media and suggestions.

2045

#

2046

# For more details about RBM rich cards, please see:

2047

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2048

# If you want to show a single card with more control over the layout,

2049

# please use RbmStandaloneCard instead.

2050

"cardWidth": "A String", # Required. The width of the cards in the carousel.

2051

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

2052

# 2 cards and at most 10.

2053

{ # Rich Business Messaging (RBM) Card content

2054

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2055

#

2056

# At least one of the title, description or media must be set.

2057

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2058

# be set. Media (image, GIF or a video) to include in the card.

2059

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2077

# provide a thumbnail URI, the RBM platform displays a blank

2078

# placeholder thumbnail until the user's device downloads the file.

2079

# Depending on the user's setting, the file may not download

2080

# automatically and may require the user to tap a download button.

2081

"height": "A String", # Required for cards with vertical orientation. The height of the media

2082

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2083

# For a standalone card with horizontal layout, height is not

2084

# customizable, and this field is ignored.

2085

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2086

# determines the MIME type of the file from the content-type field in

2087

# the HTTP headers when the platform fetches the file. The content-type

2088

# field must be present and accurate in the HTTP response from the URL.

2089

},

2090

"suggestions": [ # Optional. List of suggestions to include in the card.

2091

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2092

# easily select/click a predefined response or perform an action (like

2093

# opening a web uri).

2094

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2095

# instead of typing in their own response.

2096

"text": "A String", # Suggested reply text.

2097

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2098

# when the user taps the suggested reply. This data will be also

2099

# forwarded to webhook to allow performing custom business logic.

2100

},

2101

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2102

# can choose from the card.

2103

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2104

# when the user taps the suggested action. This data will be also

2105

# forwarded to webhook to allow performing custom business logic.

2106

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2107

# to send back to the agent (https://goo.gl/GXotJW).

2108

},

2109

"text": "A String", # Text to display alongside the action.

2110

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2111

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2112

# registered as the default handler for the URL, then this app will be

2113

# opened instead, and its icon will be used in the suggested action UI.

2114

"uri": "A String", # Required. The uri to open on the user device

2115

},

2116

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2117

# but does not dial automatically (https://goo.gl/ergbB2).

2118

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2119

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2120

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2127

#

2128

# At least one of the title, description or media must be set.

},

],

},

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2133

"suggestions": [ # Required. The list of suggested replies.

2134

{ # The suggestion chip message that the user can tap to quickly post a reply

2135

# to the conversation.

2136

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2141

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2142

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

2143

# play, e.g., "gs://bucket/object". The object must contain a single

2144

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

2145

#

2146

# This object must be readable by the `service-<Project

2147

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

2148

# where <Project Number> is the number of the Telephony Gateway project

2149

# (usually the same as the Dialogflow agent project). If the Google Cloud

2150

# Storage bucket is in the Telephony Gateway project, this permission is

2151

# added by default when enabling the Dialogflow V2 API.

2152

#

2153

# For audio from other sources, consider using the

2154

# `TelephonySynthesizeSpeech` message with SSML.

2155

},

2156

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

2157

"title": "A String", # Optional. The overall title of the list.

2158

"subtitle": "A String", # Optional. Subtitle of the list.

2159

"items": [ # Required. List items.

2160

{ # An item in the list.

2161

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2162

# dialog.

2163

"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

2168

# response is given.

2169

},

2170

"title": "A String", # Required. The title of the list item.

2171

"image": { # The image response message. # Optional. The image to display.

2172

"imageUri": "A String", # Optional. The public URI to an image file.

2173

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2174

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2175

},

2176

"description": "A String", # Optional. The main text describing the item.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

2181

#

2182

# RBM allows businesses to send enriched and branded versions of SMS. See

2183

# https://jibe.google.com/business-messaging.

2184

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2185

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2186

# easily select/click a predefined response or perform an action (like

2187

# opening a web uri).

2188

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2189

# instead of typing in their own response.

2190

"text": "A String", # Suggested reply text.

2191

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2192

# when the user taps the suggested reply. This data will be also

2193

# forwarded to webhook to allow performing custom business logic.

2194

},

2195

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2196

# can choose from the card.

2197

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2198

# when the user taps the suggested action. This data will be also

2199

# forwarded to webhook to allow performing custom business logic.

2200

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2201

# to send back to the agent (https://goo.gl/GXotJW).

2202

},

2203

"text": "A String", # Text to display alongside the action.

2204

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2205

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2206

# registered as the default handler for the URL, then this app will be

2207

# opened instead, and its icon will be used in the suggested action UI.

2208

"uri": "A String", # Required. The uri to open on the user device

2209

},

2210

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2211

# but does not dial automatically (https://goo.gl/ergbB2).

2212

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2213

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2214

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

2221

},

2222

"quickReplies": { # The quick replies response message. # Displays quick replies.

2223

"title": "A String", # Optional. The title of the collection of quick replies.

2224

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

2229

# Telephony Gateway.

2230

#

2231

# Telephony Gateway takes the synthesizer settings from

2232

# `DetectIntentResponse.output_audio_config` which can either be set

2233

# at request-level or can come from the agent-level synthesizer config.

2234

"text": "A String", # The raw text to be synthesized.

2235

"ssml": "A String", # The SSML to be synthesized. For more information, see

2236

# [SSML](https://developers.google.com/actions/reference/ssml).

2237

},

2238

"card": { # The card response message. # Displays a card.

2239

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2240

"title": "A String", # Optional. The title of the card.

2241

"buttons": [ # Optional. The collection of card buttons.

2242

{ # Optional. Contains information about a button.

2243

"text": "A String", # Optional. The text to show on the button.

2244

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

2249

},

2250

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

2251

"title": "A String", # Optional. The title of the card.

2252

"image": { # The image response message. # Optional. The image for the card.

2253

"imageUri": "A String", # Optional. The public URI to an image file.

2254

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2255

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2256

},

2257

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2258

"buttons": [ # Optional. The collection of card buttons.

2259

{ # The button object that appears at the bottom of a card.

2260

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2261

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2262

},

2263

"title": "A String", # Required. The title of the button.

2264

},

2265

],

2266

"subtitle": "A String", # Optional. The subtitle of the card.

2267

},

2268

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2269

"subtitle": "A String", # Optional. Subtitle to the title.

2270

"columnProperties": [ # Optional. Display properties for the columns in this table.

2271

{ # Column properties for TableCard.

2272

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2273

"header": "A String", # Required. Column heading.

2274

},

2275

],

2276

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2277

"imageUri": "A String", # Optional. The public URI to an image file.

2278

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2279

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2280

},

2281

"buttons": [ # Optional. List of buttons for the card.

2282

{ # The button object that appears at the bottom of a card.

2283

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2284

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2285

},

2286

"title": "A String", # Required. The title of the button.

2287

},

2288

],

2289

"title": "A String", # Required. Title of the card.

2290

"rows": [ # Optional. Rows in this table of data.

2291

{ # Row of TableCard.

2292

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2293

"cells": [ # Optional. List of cells that make up this row.

2294

{ # Cell of TableCardRow.

2295

"text": "A String", # Required. Text in this cell.

},

],

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2302

"items": [ # Required. Carousel items.

2303

{ # An item in the carousel.

2304

"title": "A String", # Required. Title of the carousel item.

2305

"image": { # The image response message. # Optional. The image to display.

2306

"imageUri": "A String", # Optional. The public URI to an image file.

2307

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2308

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2309

},

2310

"description": "A String", # Optional. The body text of the card.

2311

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2312

# dialog.

2313

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

2324

# or website associated with this agent.

2325

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2326

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2327

# suggestion chip.

2328

},

2329

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2330

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2331

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2332

# items.

2333

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2334

# items, maximum of ten.

2335

{ # Browsing carousel tile

2336

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2337

"image": { # The image response message. # Optional. Hero image for the carousel item.

2338

"imageUri": "A String", # Optional. The public URI to an image file.

2339

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2340

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2341

},

2342

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2343

# text.

2344

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2345

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2346

# the URL. Defaults to opening via web browser.

2347

"url": "A String", # Required. URL

2348

},

2349

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2350

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

2355

# This message in `QueryResult.fulfillment_messages` and

2356

# `WebhookResponse.fulfillment_messages` should contain only one

2357

# `SimpleResponse`.

2358

"simpleResponses": [ # Required. The list of simple responses.

2359

{ # The simple response message containing speech or text.

2360

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2361

# speech output. Mutually exclusive with ssml.

2362

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2363

# response to the user in the SSML format. Mutually exclusive with

2364

# text_to_speech.

2365

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2370

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2371

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2372

#

2373

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2374

},

2375

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2376

"mediaObjects": [ # Required. List of media objects.

2377

{ # Response media object for media content card.

2378

"largeImage": { # The image response message. # Optional. Image to display above media content.

2379

"imageUri": "A String", # Optional. The public URI to an image file.

2380

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2381

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2382

},

2383

"name": "A String", # Required. Name of media card.

2384

"description": "A String", # Optional. Description of media card.

2385

"contentUrl": "A String", # Required. Url where the media is stored.

2386

"icon": { # The image response message. # Optional. Icon to display above media content.

2387

"imageUri": "A String", # Optional. The public URI to an image file.

2388

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2389

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2394

},

2395

"image": { # The image response message. # Displays an image.

2396

"imageUri": "A String", # Optional. The public URI to an image file.

2397

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2398

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2399

},

2400

"payload": { # A custom platform-specific response.

2401

"a_key": "", # Properties of the object.

2402

},

2403

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2404

#

2405

# Rich cards allow you to respond to users with more vivid content, e.g.

2406

# with media and suggestions.

2407

#

2408

# For more details about RBM rich cards, please see:

2409

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2410

# You can group multiple rich cards into one using RbmCarouselCard but

2411

# carousel cards will give you less control over the card layout.

2412

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2413

# Image preview alignment for standalone cards with horizontal layout.

2414

"cardOrientation": "A String", # Required. Orientation of the card.

2415

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

2416

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2417

#

2418

# At least one of the title, description or media must be set.

2419

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2420

# be set. Media (image, GIF or a video) to include in the card.

2421

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2439

# provide a thumbnail URI, the RBM platform displays a blank

2440

# placeholder thumbnail until the user's device downloads the file.

2441

# Depending on the user's setting, the file may not download

2442

# automatically and may require the user to tap a download button.

2443

"height": "A String", # Required for cards with vertical orientation. The height of the media

2444

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2445

# For a standalone card with horizontal layout, height is not

2446

# customizable, and this field is ignored.

2447

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2448

# determines the MIME type of the file from the content-type field in

2449

# the HTTP headers when the platform fetches the file. The content-type

2450

# field must be present and accurate in the HTTP response from the URL.

2451

},

2452

"suggestions": [ # Optional. List of suggestions to include in the card.

2453

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2454

# easily select/click a predefined response or perform an action (like

2455

# opening a web uri).

2456

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2457

# instead of typing in their own response.

2458

"text": "A String", # Suggested reply text.

2459

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2460

# when the user taps the suggested reply. This data will be also

2461

# forwarded to webhook to allow performing custom business logic.

2462

},

2463

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2464

# can choose from the card.

2465

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2466

# when the user taps the suggested action. This data will be also

2467

# forwarded to webhook to allow performing custom business logic.

2468

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2469

# to send back to the agent (https://goo.gl/GXotJW).

2470

},

2471

"text": "A String", # Text to display alongside the action.

2472

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2473

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2474

# registered as the default handler for the URL, then this app will be

2475

# opened instead, and its icon will be used in the suggested action UI.

2476

"uri": "A String", # Required. The uri to open on the user device

2477

},

2478

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2479

# but does not dial automatically (https://goo.gl/ergbB2).

2480

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2481

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2482

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2489

#

2490

# At least one of the title, description or media must be set.

},

},

},

],

"action": "A String", # Optional. The name of the action associated with the intent.

2496

# Note: The action name must not contain whitespaces.

2497

"name": "A String", # Optional. The unique identifier of this intent.

2498

# Required for Intents.UpdateIntent and Intents.BatchUpdateIntents

2499

# methods.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2500

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2501

"webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.

2502

"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]

2503

# triggered.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2504

# Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2505

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2506

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2507

"followupIntentInfo": [ # Output only. Information about all followup intents that have this intent as

2508

# a direct or indirect parent. We populate this field only in the output.

2509

{ # Represents a single followup intent in the chain.

2510

"followupIntentName": "A String", # The unique identifier of the followup intent.

2511

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2512

"parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.

2513

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2514

},

2515

],

2516

"displayName": "A String", # Required. The name of this intent.

2517

"rootFollowupIntentName": "A String", # Output only. The unique identifier of the root intent in the chain of

2518

# followup intents. It identifies the correct followup intents chain for

2519

# this intent.

2520

#

2521

# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

2522

"mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.

2523

# Note: If `ml_disabled` setting is set to true, then this intent is not

2524

# taken into account during inference in `ML ONLY` match mode. Also,

2525

# auto-markup in the UI is turned off.

2526

"isFallback": True or False, # Optional. Indicates whether this is a fallback intent.

2527

"mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2528

# Note: If `ml_enabled` setting is set to false, then this intent is not

2529

# taken into account during inference in `ML ONLY` match mode. Also,

2530

# auto-markup in the UI is turned off.

2531

# DEPRECATED! Please use `ml_disabled` field instead.

2532

# NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,

2533

# then the default value is determined as follows:

2534

# - Before April 15th, 2018 the default is:

2535

# ml_enabled = false / ml_disabled = true.

2536

# - After April 15th, 2018 the default is:

2537

# ml_enabled = true / ml_disabled = false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2538

},

2539

"fulfillmentMessages": [ # The collection of rich messages to present to the user.

2540

{ # Corresponds to the `Response` field in the Dialogflow console.

2541

"text": { # The text response message. # Returns a text response.

2542

"text": [ # Optional. The collection of the agent's responses.

"A String",

],

},

"rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.

2547

#

2548

# Rich cards allow you to respond to users with more vivid content, e.g.

2549

# with media and suggestions.

2550

#

2551

# For more details about RBM rich cards, please see:

2552

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2553

# If you want to show a single card with more control over the layout,

2554

# please use RbmStandaloneCard instead.

2555

"cardWidth": "A String", # Required. The width of the cards in the carousel.

2556

"cardContents": [ # Required. The cards in the carousel. A carousel must have at least

2557

# 2 cards and at most 10.

2558

{ # Rich Business Messaging (RBM) Card content

2559

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2560

#

2561

# At least one of the title, description or media must be set.

2562

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2563

# be set. Media (image, GIF or a video) to include in the card.

2564

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2582

# provide a thumbnail URI, the RBM platform displays a blank

2583

# placeholder thumbnail until the user's device downloads the file.

2584

# Depending on the user's setting, the file may not download

2585

# automatically and may require the user to tap a download button.

2586

"height": "A String", # Required for cards with vertical orientation. The height of the media

2587

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2588

# For a standalone card with horizontal layout, height is not

2589

# customizable, and this field is ignored.

2590

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2591

# determines the MIME type of the file from the content-type field in

2592

# the HTTP headers when the platform fetches the file. The content-type

2593

# field must be present and accurate in the HTTP response from the URL.

2594

},

2595

"suggestions": [ # Optional. List of suggestions to include in the card.

2596

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2597

# easily select/click a predefined response or perform an action (like

2598

# opening a web uri).

2599

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2600

# instead of typing in their own response.

2601

"text": "A String", # Suggested reply text.

2602

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2603

# when the user taps the suggested reply. This data will be also

2604

# forwarded to webhook to allow performing custom business logic.

2605

},

2606

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2607

# can choose from the card.

2608

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2609

# when the user taps the suggested action. This data will be also

2610

# forwarded to webhook to allow performing custom business logic.

2611

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2612

# to send back to the agent (https://goo.gl/GXotJW).

2613

},

2614

"text": "A String", # Text to display alongside the action.

2615

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2616

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2617

# registered as the default handler for the URL, then this app will be

2618

# opened instead, and its icon will be used in the suggested action UI.

2619

"uri": "A String", # Required. The uri to open on the user device

2620

},

2621

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2622

# but does not dial automatically (https://goo.gl/ergbB2).

2623

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2624

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2625

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2632

#

2633

# At least one of the title, description or media must be set.

},

],

},

"suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.

2638

"suggestions": [ # Required. The list of suggested replies.

2639

{ # The suggestion chip message that the user can tap to quickly post a reply

2640

# to the conversation.

2641

"title": "A String", # Required. The text shown the in the suggestion chip.

},

],

},

"platform": "A String", # Optional. The platform that this message is intended for.

2646

"telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.

2647

"audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to

2648

# play, e.g., "gs://bucket/object". The object must contain a single

2649

# channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2650

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2651

# This object must be readable by the `service-<Project

2652

# Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account

2653

# where <Project Number> is the number of the Telephony Gateway project

2654

# (usually the same as the Dialogflow agent project). If the Google Cloud

2655

# Storage bucket is in the Telephony Gateway project, this permission is

2656

# added by default when enabling the Dialogflow V2 API.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2657

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2658

# For audio from other sources, consider using the

2659

# `TelephonySynthesizeSpeech` message with SSML.

2660

},

2661

"listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.

2662

"title": "A String", # Optional. The overall title of the list.

2663

"subtitle": "A String", # Optional. Subtitle of the list.

2664

"items": [ # Required. List items.

2665

{ # An item in the list.

2666

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.

2667

# dialog.

2668

"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

2673

# response is given.

2674

},

2675

"title": "A String", # Required. The title of the list item.

2676

"image": { # The image response message. # Optional. The image to display.

2677

"imageUri": "A String", # Optional. The public URI to an image file.

2678

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2679

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2680

},

2681

"description": "A String", # Optional. The main text describing the item.

},

],

},

"rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.

2686

#

2687

# RBM allows businesses to send enriched and branded versions of SMS. See

2688

# https://jibe.google.com/business-messaging.

2689

"rbmSuggestion": [ # Optional. One or more suggestions to show to the user.

2690

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2691

# easily select/click a predefined response or perform an action (like

2692

# opening a web uri).

2693

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2694

# instead of typing in their own response.

2695

"text": "A String", # Suggested reply text.

2696

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2697

# when the user taps the suggested reply. This data will be also

2698

# forwarded to webhook to allow performing custom business logic.

2699

},

2700

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2701

# can choose from the card.

2702

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2703

# when the user taps the suggested action. This data will be also

2704

# forwarded to webhook to allow performing custom business logic.

2705

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2706

# to send back to the agent (https://goo.gl/GXotJW).

2707

},

2708

"text": "A String", # Text to display alongside the action.

2709

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2710

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2711

# registered as the default handler for the URL, then this app will be

2712

# opened instead, and its icon will be used in the suggested action UI.

2713

"uri": "A String", # Required. The uri to open on the user device

2714

},

2715

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2716

# but does not dial automatically (https://goo.gl/ergbB2).

2717

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2718

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2719

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"text": "A String", # Required. Text sent and displayed to the user.

2726

},

2727

"quickReplies": { # The quick replies response message. # Displays quick replies.

2728

"title": "A String", # Optional. The title of the collection of quick replies.

2729

"quickReplies": [ # Optional. The collection of quick replies.

"A String",

],

},

"telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.

2734

# Telephony Gateway.

2735

#

2736

# Telephony Gateway takes the synthesizer settings from

2737

# `DetectIntentResponse.output_audio_config` which can either be set

2738

# at request-level or can come from the agent-level synthesizer config.

2739

"text": "A String", # The raw text to be synthesized.

2740

"ssml": "A String", # The SSML to be synthesized. For more information, see

2741

# [SSML](https://developers.google.com/actions/reference/ssml).

2742

},

2743

"card": { # The card response message. # Displays a card.

2744

"imageUri": "A String", # Optional. The public URI to an image file for the card.

2745

"title": "A String", # Optional. The title of the card.

2746

"buttons": [ # Optional. The collection of card buttons.

2747

{ # Optional. Contains information about a button.

2748

"text": "A String", # Optional. The text to show on the button.

2749

"postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to

# open.

},

],

"subtitle": "A String", # Optional. The subtitle of the card.

2754

},

2755

"basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.

2756

"title": "A String", # Optional. The title of the card.

2757

"image": { # The image response message. # Optional. The image for the card.

2758

"imageUri": "A String", # Optional. The public URI to an image file.

2759

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2760

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2761

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2762

"formattedText": "A String", # Required, unless image is present. The body text of the card.

2763

"buttons": [ # Optional. The collection of card buttons.

2764

{ # The button object that appears at the bottom of a card.

2765

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2766

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2767

},

2768

"title": "A String", # Required. The title of the button.

2769

},

2770

],

2771

"subtitle": "A String", # Optional. The subtitle of the card.

2772

},

2773

"tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.

2774

"subtitle": "A String", # Optional. Subtitle to the title.

2775

"columnProperties": [ # Optional. Display properties for the columns in this table.

2776

{ # Column properties for TableCard.

2777

"horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.

2778

"header": "A String", # Required. Column heading.

2779

},

2780

],

2781

"image": { # The image response message. # Optional. Image which should be displayed on the card.

2782

"imageUri": "A String", # Optional. The public URI to an image file.

2783

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2784

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2785

},

2786

"buttons": [ # Optional. List of buttons for the card.

2787

{ # The button object that appears at the bottom of a card.

2788

"openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.

2789

"uri": "A String", # Required. The HTTP or HTTPS scheme URI.

2790

},

2791

"title": "A String", # Required. The title of the button.

2792

},

2793

],

2794

"title": "A String", # Required. Title of the card.

2795

"rows": [ # Optional. Rows in this table of data.

2796

{ # Row of TableCard.

2797

"dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.

2798

"cells": [ # Optional. List of cells that make up this row.

2799

{ # Cell of TableCardRow.

2800

"text": "A String", # Required. Text in this cell.

},

],

},

],

},

"carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.

2807

"items": [ # Required. Carousel items.

2808

{ # An item in the carousel.

2809

"title": "A String", # Required. Title of the carousel item.

2810

"image": { # The image response message. # Optional. The image to display.

2811

"imageUri": "A String", # Optional. The public URI to an image file.

2812

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2813

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2814

},

2815

"description": "A String", # Optional. The body text of the card.

2816

"info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.

2817

# dialog.

2818

"synonyms": [ # Optional. A list of synonyms that can also be used to trigger this

# item in dialog.

"A String",

],

"key": "A String", # Required. A unique key that will be sent back to the agent if this

# response is given.

},

},

],

},

"linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # Displays a link out suggestion chip for Actions on Google.

2829

# or website associated with this agent.

2830

"destinationName": "A String", # Required. The name of the app or site this chip is linking to.

2831

"uri": "A String", # Required. The URI of the app or site to open when the user taps the

2832

# suggestion chip.

2833

},

2834

"browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.

2835

# https://developers.google.com/actions/assistant/responses#browsing_carousel

2836

"imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in

2837

# items.

2838

"items": [ # Required. List of items in the Browse Carousel Card. Minimum of two

2839

# items, maximum of ten.

2840

{ # Browsing carousel tile

2841

"title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.

2842

"image": { # The image response message. # Optional. Hero image for the carousel item.

2843

"imageUri": "A String", # Optional. The public URI to an image file.

2844

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2845

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2846

},

2847

"description": "A String", # Optional. Description of the carousel item. Maximum of four lines of

2848

# text.

2849

"openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.

2850

"urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening

2851

# the URL. Defaults to opening via web browser.

2852

"url": "A String", # Required. URL

2853

},

2854

"footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel

2855

# Card. Maximum of one line of text.

},

],

},

"simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.

2860

# This message in `QueryResult.fulfillment_messages` and

2861

# `WebhookResponse.fulfillment_messages` should contain only one

2862

# `SimpleResponse`.

2863

"simpleResponses": [ # Required. The list of simple responses.

2864

{ # The simple response message containing speech or text.

2865

"textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the

2866

# speech output. Mutually exclusive with ssml.

2867

"ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken

2868

# response to the user in the SSML format. Mutually exclusive with

2869

# text_to_speech.

2870

"displayText": "A String", # Optional. The text to display.

},

],

},

"telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.

2875

"phoneNumber": "A String", # Required. The phone number to transfer the call to

2876

# in [E.164 format](https://en.wikipedia.org/wiki/E.164).

2877

#

2878

# We currently only allow transferring to US numbers (+1xxxyyyzzzz).

2879

},

2880

"mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.

2881

"mediaObjects": [ # Required. List of media objects.

2882

{ # Response media object for media content card.

2883

"largeImage": { # The image response message. # Optional. Image to display above media content.

2884

"imageUri": "A String", # Optional. The public URI to an image file.

2885

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2886

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2887

},

2888

"name": "A String", # Required. Name of media card.

2889

"description": "A String", # Optional. Description of media card.

2890

"contentUrl": "A String", # Required. Url where the media is stored.

2891

"icon": { # The image response message. # Optional. Icon to display above media content.

2892

"imageUri": "A String", # Optional. The public URI to an image file.

2893

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2894

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

},

},

],

"mediaType": "A String", # Optional. What type of media is the content (ie "audio").

2899

},

2900

"image": { # The image response message. # Displays an image.

2901

"imageUri": "A String", # Optional. The public URI to an image file.

2902

"accessibilityText": "A String", # A text description of the image to be used for accessibility,

2903

# e.g., screen readers. Required if image_uri is set for CarouselSelect.

2904

},

2905

"payload": { # A custom platform-specific response.

2906

"a_key": "", # Properties of the object.

2907

},

2908

"rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.

2909

#

2910

# Rich cards allow you to respond to users with more vivid content, e.g.

2911

# with media and suggestions.

2912

#

2913

# For more details about RBM rich cards, please see:

2914

# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.

2915

# You can group multiple rich cards into one using RbmCarouselCard but

2916

# carousel cards will give you less control over the card layout.

2917

"thumbnailImageAlignment": "A String", # Required if orientation is horizontal.

2918

# Image preview alignment for standalone cards with horizontal layout.

2919

"cardOrientation": "A String", # Required. Orientation of the card.

2920

"cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.

2921

"description": "A String", # Optional. Description of the card (at most 2000 bytes).

2922

#

2923

# At least one of the title, description or media must be set.

2924

"media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must

2925

# be set. Media (image, GIF or a video) to include in the card.

2926

# The following media-types are currently supported:

#

# Image Types

#

# * image/jpeg

# * image/jpg'

# * image/gif

# * image/png

#

# Video Types

#

# * video/h263

# * video/m4v

# * video/mp4

# * video/mpeg

# * video/mpeg4

# * video/webm

"thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't

2944

# provide a thumbnail URI, the RBM platform displays a blank

2945

# placeholder thumbnail until the user's device downloads the file.

2946

# Depending on the user's setting, the file may not download

2947

# automatically and may require the user to tap a download button.

2948

"height": "A String", # Required for cards with vertical orientation. The height of the media

2949

# within a rich card with a vertical layout. (https://goo.gl/NeFCjz).

2950

# For a standalone card with horizontal layout, height is not

2951

# customizable, and this field is ignored.

2952

"fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform

2953

# determines the MIME type of the file from the content-type field in

2954

# the HTTP headers when the platform fetches the file. The content-type

2955

# field must be present and accurate in the HTTP response from the URL.

2956

},

2957

"suggestions": [ # Optional. List of suggestions to include in the card.

2958

{ # Rich Business Messaging (RBM) suggestion. Suggestions allow user to

2959

# easily select/click a predefined response or perform an action (like

2960

# opening a web uri).

2961

"reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing

2962

# instead of typing in their own response.

2963

"text": "A String", # Suggested reply text.

2964

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2965

# when the user taps the suggested reply. This data will be also

2966

# forwarded to webhook to allow performing custom business logic.

2967

},

2968

"action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose

2969

# can choose from the card.

2970

"postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event

2971

# when the user taps the suggested action. This data will be also

2972

# forwarded to webhook to allow performing custom business logic.

2973

"shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location

2974

# to send back to the agent (https://goo.gl/GXotJW).

2975

},

2976

"text": "A String", # Text to display alongside the action.

2977

"openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device

2978

# (https://goo.gl/6GLJD2). If the user has an app installed that is

2979

# registered as the default handler for the URL, then this app will be

2980

# opened instead, and its icon will be used in the suggested action UI.

2981

"uri": "A String", # Required. The uri to open on the user device

2982

},

2983

"dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number

2984

# but does not dial automatically (https://goo.gl/ergbB2).

2985

"phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.

2986

# This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)

2987

# format. An example of a correctly formatted phone number:

# +15556767888.

},

},

},

],

"title": "A String", # Optional. Title of the card (at most 200 bytes).

2994

#

2995

# At least one of the title, description or media must be set.

},

},

},

],

"webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the

3001

# value of the `payload` field returned in the webhook response.

3002

"a_key": "", # Properties of the object.

3003

},

3004

"action": "A String", # The action name from the matched intent.

3005

"webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the

3006

# value of the `source` field returned in the webhook response.

3007

"fulfillmentText": "A String", # The text to be pronounced to the user or shown on the screen.

3008

# Note: This is a legacy field, `fulfillment_messages` should be preferred.

3009

"parameters": { # The collection of extracted parameters.

3010

#

3011

# Depending on your protocol or client library language, this is a

3012

# map, associative array, symbol table, dictionary, or JSON object

3013

# composed of a collection of (MapKey, MapValue) pairs:

3014

#

3015

# - MapKey type: string

3016

# - MapKey value: parameter name

3017

# - MapValue type:

3018

# - If parameter's entity type is a composite entity: map

3019

# - Else: string or number, depending on parameter value type

3020

# - MapValue value:

3021

# - If parameter's entity type is a composite entity:

3022

# map from composite entity property names to property values

3023

# - Else: parameter value

3024

"a_key": "", # Properties of the object.

3025

},

3026

"knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing

3027

# `KnowledgeAnswers.match_confidence`.

3028

"answers": [ # A list of answers from Knowledge Connector.

3029

{ # An answer from Knowledge Connector.

3030

"source": "A String", # Indicates which Knowledge Document this answer was extracted from.

3031

# Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base

3032

# ID>/documents/<Document ID>`.

3033

"answer": "A String", # The piece of text from the `source` knowledge base document that answers

3034

# this conversational query.

3035

"faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ

3036

# Document, empty otherwise.

3037

"matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match

3038

# for this conversational query.

3039

# NOTE: The confidence level for a given `<query, answer>` pair may change

3040

# without notice, as it depends on models that are constantly being

3041

# improved. However, it will change less frequently than the confidence

3042

# score below, and should be preferred for referencing the quality of an

3043

# answer.

3044

"matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match

3045

# for this conversational query.

3046

# The range is from 0.0 (completely uncertain) to 1.0 (completely certain).

3047

# Note: The confidence score is likely to vary somewhat (possibly even for

3048

# identical requests), as the underlying model is under constant

3049

# improvement. It may be deprecated in the future. We recommend using

3050

# `match_confidence_level` which should be generally more stable.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3051

},

3052

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3053

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3054

"sentimentAnalysisResult": { # The result of sentiment analysis as configured by # The sentiment analysis result, which depends on the

3055

# `sentiment_analysis_request_config` specified in the request.

3056

# `sentiment_analysis_request_config`.

3057

"queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.

3058

# of analysis, such as the query text.

3059

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive

3060

# sentiment).

3061

"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute

3062

# magnitude of sentiment, regardless of score (positive or negative).

3063

},

3064

},

3065

"intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3066

# (completely uncertain) to 1.0 (completely certain).

3067

# This value is for informational purpose only and is only used to

3068

# help match the best intent within the classification threshold.

3069

# This value may change for the same end-user expression at any time due to a

3070

# model retraining or change in implementation.

3071

# If there are `multiple knowledge_answers` messages, this value is set to

3072

# the greatest `knowledgeAnswers.match_confidence` value in the list.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3073

},

3074

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3075

"responseId": "A String", # The unique identifier of the response. It can be used to

3076

# locate a response in the training example set or for reporting issues.

3077

"outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.

3078

# If this audio config is supplied in a request, it overrides all existing

3079

# text-to-speech settings applied to the agent.

3080

"audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.

3081

"synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Configuration of how speech should be synthesized.

3082

"volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the

3083

# specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of

3084

# 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)

3085

# will play at approximately half the amplitude of the normal native signal

3086

# amplitude. A value of +6.0 (dB) will play at approximately twice the

3087

# amplitude of the normal native signal amplitude. We strongly recommend not

3088

# to exceed +10 (dB) as there's usually no effective increase in loudness for

3089

# any value greater than that.

3090

"pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20

3091

# semitones from the original pitch. -20 means decrease 20 semitones from the

3092

# original pitch.

3093

"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.

3094

"name": "A String", # Optional. The name of the voice. If not set, the service will choose a

3095

# voice based on the other parameters such as language_code and

3096

# ssml_gender.

3097

"ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will

3098

# choose a voice based on the other parameters such as language_code and

3099

# name. Note that this is only a preference, not requirement. If a

3100

# voice of the appropriate gender is not available, the synthesizer should

3101

# substitute a voice with a different gender rather than failing the request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3102

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3103

"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal

3104

# native speed supported by the specific voice. 2.0 is twice as fast, and

3105

# 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any

3106

# other values < 0.25 or > 4.0 will return an error.

3107

"effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are

3108

# applied on (post synthesized) text to speech. Effects are applied on top of

3109

# each other in the order they are given.

"A String",

],

},

"sampleRateHertz": 42, # The synthesis sample rate (in hertz) for this audio. If not

3114

# provided, then the synthesizer will use the default sample rate based on

3115

# the audio encoding. If this is different from the voice's natural sample

3116

# rate, then the synthesizer will honor this request by converting to the

3117

# desired sample rate (which might result in worse audio quality).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3118

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3119

"outputAudio": "A String", # The audio data bytes encoded as specified in the request.

3120

# Note: The output audio is generated based on the values of default platform

3121

# text responses found in the `query_result.fulfillment_messages` field. If

3122

# multiple default text responses exist, they will be concatenated when

3123

# generating audio. If no default platform text responses exist, the

3124

# generated audio content will be empty.

Bu Sun Kim