Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / dialogflow_v2beta1.projects.agent.environments.users.sessions.html
blob: a7e7e618c98d0bc6e13b5db1b872af66ed7cf7c7 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.agent.html">agent</a> . <a href="dialogflow_v2beta1.projects.agent.environments.html">environments</a> . <a href="dialogflow_v2beta1.projects.agent.environments.users.html">users</a> . <a href="dialogflow_v2beta1.projects.agent.environments.users.sessions.html">sessions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="dialogflow_v2beta1.projects.agent.environments.users.sessions.contexts.html">contexts()</a></code>
79</p>
80<p class="firstline">Returns the contexts Resource.</p>
81
82<p class="toc_element">
83 <code><a href="dialogflow_v2beta1.projects.agent.environments.users.sessions.entityTypes.html">entityTypes()</a></code>
84</p>
85<p class="firstline">Returns the entityTypes Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#deleteContexts">deleteContexts(parent, x__xgafv=None)</a></code></p>
89<p class="firstline">Deletes all active contexts in the specified session.</p>
90<p class="toc_element">
Dan O'Mearadd494642020-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 Kim715bd7f2019-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<div class="method">
95 <code class="details" id="deleteContexts">deleteContexts(parent, x__xgafv=None)</code>
96 <pre>Deletes all active contexts in the specified session.
97
98Args:
99 parent: string, Required. The name of the session to delete all contexts from. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100`projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;` or `projects/&lt;Project
101ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User ID&gt;/sessions/&lt;Session
102ID&gt;`. If `Environment ID` is not specified we assume default 'draft'
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103environment. If `User ID` is not specified, we assume default '-' user. (required)
104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109Returns:
110 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 `{}`.
121 }</pre>
122</div>
123
124<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]125 <code class="details" id="detectIntent">detectIntent(session, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 <pre>Processes a natural language query and returns structured, actionable data
127as a result. This method is not idempotent, because it may cause contexts
128and session entity types to be updated, which in turn might affect
129results of future queries.
130
131Args:
132 session: string, Required. The name of the session this query is sent to. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]133`projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;`, or
134`projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
135ID&gt;/sessions/&lt;Session ID&gt;`. If `Environment ID` is not specified, we assume
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136default 'draft' environment. If `User ID` is not specified, we are using
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]137"-". It's up to the API caller to choose an appropriate `Session ID` and
138`User Id`. They can be a random number or some type of user and session
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139identifiers (preferably hashed). The length of the `Session ID` and
140`User ID` must not exceed 36 characters. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]141 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 The object takes the form of:
143
144{ # The request to detect user's intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]145 "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 # audio. If this field is not set and agent-level speech synthesizer is not
147 # configured, no output audio is generated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 # If this audio config is supplied in a request, it overrides all existing
149 # text-to-speech settings applied to the agent.
150 "sampleRateHertz": 42, # The synthesis sample rate (in hertz) for this audio. If not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 # provided, then the synthesizer will use the default sample rate based on
152 # the audio encoding. If this is different from the voice's natural sample
153 # rate, then the synthesizer will honor this request by converting to the
154 # desired sample rate (which might result in worse audio quality).
155 "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]156 "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Configuration of how speech should be synthesized.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are
158 # applied on (post synthesized) text to speech. Effects are applied on top of
159 # each other in the order they are given.
160 "A String",
161 ],
162 "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
163 "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will
164 # choose a voice based on the other parameters such as language_code and
165 # name. Note that this is only a preference, not requirement. If a
166 # voice of the appropriate gender is not available, the synthesizer should
167 # substitute a voice with a different gender rather than failing the request.
168 "name": "A String", # Optional. The name of the voice. If not set, the service will choose a
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]169 # voice based on the other parameters such as language_code and
170 # ssml_gender.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 },
172 "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal
173 # native speed supported by the specific voice. 2.0 is twice as fast, and
174 # 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]175 # other values &lt; 0.25 or &gt; 4.0 will return an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the
177 # specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of
178 # 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)
179 # will play at approximately half the amplitude of the normal native signal
180 # amplitude. A value of +6.0 (dB) will play at approximately twice the
181 # amplitude of the normal native signal amplitude. We strongly recommend not
182 # to exceed +10 (dB) as there's usually no effective increase in loudness for
183 # any value greater than that.
184 "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20
185 # semitones from the original pitch. -20 means decrease 20 semitones from the
186 # original pitch.
187 },
188 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]189 "inputAudio": "A String", # The natural language speech audio to be processed. This field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 # should be populated iff `query_input` is set to an input audio config.
191 # A single request can contain up to 1 minute of speech audio data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]192 "outputAudioConfigMask": "A String", # Mask for output_audio_config indicating which settings in this
193 # request-level config should override speech synthesizer settings defined at
194 # agent-level.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]196 # If unspecified or empty, output_audio_config replaces the agent-level
197 # config in its entirety.
198 "queryParams": { # Represents the parameters of the conversational query. # The parameters of this query.
199 "geoLocation": { # An object representing a latitude/longitude pair. This is expressed as a pair # The geo location of this conversational query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 # of doubles representing degrees latitude and degrees longitude. Unless
201 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]202 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
203 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]204 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
205 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
206 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]207 "contexts": [ # The collection of contexts to be activated before this query is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 # executed.
209 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]211 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
212 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
213 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 #
215 # The `Context ID` is always converted to lowercase, may only contain
216 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
217 #
218 # If `Environment ID` is not specified, we assume default 'draft'
219 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]220 #
221 # The following context names are reserved for internal use by Dialogflow.
222 # You should not use these contexts or create contexts with these names:
223 #
224 # * `__system_counters__`
225 # * `*_id_dialog_context`
226 # * `*_dialog_params_size`
227 "parameters": { # Optional. The collection of parameters associated with this context.
228 #
229 # Depending on your protocol or client library language, this is a
230 # map, associative array, symbol table, dictionary, or JSON object
231 # composed of a collection of (MapKey, MapValue) pairs:
232 #
233 # - MapKey type: string
234 # - MapKey value: parameter name
235 # - MapValue type:
236 # - If parameter's entity type is a composite entity: map
237 # - Else: string or number, depending on parameter value type
238 # - MapValue value:
239 # - If parameter's entity type is a composite entity:
240 # map from composite entity property names to property values
241 # - Else: parameter value
242 "a_key": "", # Properties of the object.
243 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]245 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 # immediately. Contexts expire automatically after 20 minutes if there
247 # are no matching queries.
248 },
249 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]250 "webhookHeaders": { # This field can be used to pass HTTP headers for a webhook
251 # call. These headers will be sent to webhook alone with the headers that
252 # have been configured through Dialogflow web console. The headers defined
253 # within this field will overwrite the headers configured through Dialogflow
254 # console if there is a conflict. Header names are case-insensitive.
255 # Google's specified headers are not allowed. Including: "Host",
256 # "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
257 # "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
258 "a_key": "A String",
259 },
260 "knowledgeBaseNames": [ # KnowledgeBases to get alternative results from. If not set, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261 # KnowledgeBases enabled in the agent (through UI) will be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]262 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 "A String",
264 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]265 "subAgents": [ # For mega agent query, directly specify which sub agents to query.
266 # If any specified sub agent is not linked to the mega agent, an error will
267 # be returned. If empty, Dialogflow will decide which sub agents to query.
268 # If specified for a non-mega-agent query, will be silently ignored.
269 { # Contains basic configuration for a sub-agent.
270 "project": "A String", # Required. The project of this agent.
271 # Format: `projects/&lt;Project ID&gt;`.
272 "environment": "A String", # Optional. The unique identifier (`environment name` in dialogflow console)
273 # of this sub-agent environment. Assumes draft environment if `environment`
274 # is not set.
275 },
276 ],
277 "sentimentAnalysisRequestConfig": { # Configures the types of sentiment analysis to perform. # Configures the type of sentiment analysis to perform. If not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278 # provided, sentiment analysis is not performed.
279 # Note: Sentiment Analysis is only currently available for Enterprise Edition
280 # agents.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]281 "analyzeQueryTextSentiment": True or False, # Instructs the service to perform sentiment analysis on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 # `query_text`. If not provided, sentiment analysis is not performed on
283 # `query_text`.
284 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]285 "resetContexts": True or False, # Specifies whether to delete all contexts in the current session
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]286 # before the new ones are activated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]287 "timeZone": "A String", # The time zone of this conversational query from the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 # [time zone database](https://www.iana.org/time-zones), e.g.,
289 # America/New_York, Europe/Paris. If not provided, the time zone specified in
290 # agent settings is used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]291 "payload": { # This field can be used to pass custom data to your webhook.
292 # Arbitrary JSON objects are supported.
293 # If supplied, the value is used to populate the
294 # `WebhookRequest.original_detect_intent_request.payload`
295 # field sent to your webhook.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 "a_key": "", # Properties of the object.
297 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]298 "sessionEntityTypes": [ # Additional session entity types to replace or extend developer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 # entity types with. The entity synonyms apply to all languages and persist
300 # for the session of this query.
301 { # Represents a session entity type.
302 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]303 # Extends or replaces a custom entity type at the user session level (we
304 # refer to the entity types defined at the agent level as "custom entity
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 # types").
306 #
307 # Note: session entity types apply to all queries, regardless of the language.
308 "entities": [ # Required. The collection of entities associated with this session entity
309 # type.
310 { # An **entity entry** for an associated entity type.
311 "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type
312 # is *vegetable*, and `value` is *scallions*, a synonym could be *green
313 # onions*.
314 #
315 # For `KIND_LIST` entity types:
316 #
317 # * This collection must contain exactly one synonym equal to `value`.
318 "A String",
319 ],
320 "value": "A String", # Required. The primary value associated with this entity entry.
321 # For example, if the entity type is *vegetable*, the value could be
322 # *scallions*.
323 #
324 # For `KIND_MAP` entity types:
325 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]326 # * A reference value to be used in place of synonyms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 #
328 # For `KIND_LIST` entity types:
329 #
330 # * A string that can contain references to other entity types (with or
331 # without aliases).
332 },
333 ],
334 "name": "A String", # Required. The unique identifier of this session entity type. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]335 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/entityTypes/&lt;Entity Type
336 # Display Name&gt;`, or
337 # `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
338 # ID&gt;/sessions/&lt;Session ID&gt;/entityTypes/&lt;Entity Type Display Name&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 # If `Environment ID` is not specified, we assume default 'draft'
340 # environment. If `User ID` is not specified, we assume default '-' user.
341 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]342 # `&lt;Entity Type Display Name&gt;` must be the display name of an existing entity
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343 # type in the same agent that will be overridden or supplemented.
344 "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]345 # supplement the custom entity type definition.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]346 },
347 ],
348 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]349 "queryInput": { # Represents the query input. It can contain either: # Required. The input specification. It can be set to:
350 #
351 # 1. an audio config
352 # which instructs the speech recognizer how to process the speech audio,
353 #
354 # 2. a conversational query in the form of text, or
355 #
356 # 3. an event that specifies which intent to trigger.
357 #
358 # 1. An audio config which
359 # instructs the speech recognizer how to process the speech audio.
360 #
361 # 2. A conversational query in the form of text.
362 #
363 # 3. An event that specifies which intent to trigger.
364 "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
365 "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
366 # Text length must not exceed 256 characters.
367 "languageCode": "A String", # Required. The language of this conversational query. See [Language
368 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
369 # for a list of the currently supported language codes. Note that queries in
370 # the same session do not necessarily need to specify the same language.
371 },
372 "event": { # Events allow for matching intents by event name instead of the natural # The event to be processed.
373 # language input. For instance, input `&lt;event: { name: "welcome_event",
374 # parameters: { name: "Sam" } }&gt;` can trigger a personalized welcome response.
375 # The parameter `name` may be used by the agent in the response:
376 # `"Hello #welcome_event.name! What can I do for you today?"`.
377 "languageCode": "A String", # Required. The language of this query. See [Language
378 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
379 # for a list of the currently supported language codes. Note that queries in
380 # the same session do not necessarily need to specify the same language.
381 "name": "A String", # Required. The unique identifier of the event.
382 "parameters": { # The collection of parameters associated with the event.
383 #
384 # Depending on your protocol or client library language, this is a
385 # map, associative array, symbol table, dictionary, or JSON object
386 # composed of a collection of (MapKey, MapValue) pairs:
387 #
388 # - MapKey type: string
389 # - MapKey value: parameter name
390 # - MapValue type:
391 # - If parameter's entity type is a composite entity: map
392 # - Else: string or number, depending on parameter value type
393 # - MapValue value:
394 # - If parameter's entity type is a composite entity:
395 # map from composite entity property names to property values
396 # - Else: parameter value
397 "a_key": "", # Properties of the object.
398 },
399 },
400 "audioConfig": { # Instructs the speech recognizer on how to process the audio content. # Instructs the speech recognizer how to process the speech audio.
401 "languageCode": "A String", # Required. The language of the supplied audio. Dialogflow does not do
402 # translations. See [Language
403 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
404 # for a list of the currently supported language codes. Note that queries in
405 # the same session do not necessarily need to specify the same language.
406 "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
407 "phraseHints": [ # A list of strings containing words and phrases that the speech
408 # recognizer should recognize with higher likelihood.
409 #
410 # See [the Cloud Speech
411 # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
412 # for more details.
413 #
414 # This field is deprecated. Please use [speech_contexts]() instead. If you
415 # specify both [phrase_hints]() and [speech_contexts](), Dialogflow will
416 # treat the [phrase_hints]() as a single additional [SpeechContext]().
417 "A String",
418 ],
419 "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in
420 # StreamingRecognitionResult with information about the recognized speech
421 # words, e.g. start and end time offsets. If false or unspecified, Speech
422 # doesn't return any word-level information.
423 "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query.
424 # Refer to
425 # [Cloud Speech API
426 # documentation](https://cloud.google.com/speech-to-text/docs/basics) for
427 # more details.
428 "modelVariant": "A String", # Which variant of the Speech model to use.
429 "model": "A String", # Which Speech model to select for the given request. Select the
430 # model best suited to your domain to get best results. If a model is not
431 # explicitly specified, then we auto-select a model based on the parameters
432 # in the InputAudioConfig.
433 # If enhanced speech model is enabled for the agent and an enhanced
434 # version of the specified model for the language does not exist, then the
435 # speech is recognized using the standard version of the specified model.
436 # Refer to
437 # [Cloud Speech API
438 # documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)
439 # for more details.
440 "speechContexts": [ # Context information to assist speech recognition.
441 #
442 # See [the Cloud Speech
443 # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
444 # for more details.
445 { # Hints for the speech recognizer to help with recognition in a specific
446 # conversation state.
447 "phrases": [ # Optional. A list of strings containing words and phrases that the speech
448 # recognizer should recognize with higher likelihood.
449 #
450 # This list can be used to:
451 # * improve accuracy for words and phrases you expect the user to say,
452 # e.g. typical commands for your Dialogflow agent
453 # * add additional words to the speech recognizer vocabulary
454 # * ...
455 #
456 # See the [Cloud Speech
457 # documentation](https://cloud.google.com/speech-to-text/quotas) for usage
458 # limits.
459 "A String",
460 ],
461 "boost": 3.14, # Optional. Boost for this context compared to other contexts:
462 # * If the boost is positive, Dialogflow will increase the probability that
463 # the phrases in this context are recognized over similar sounding phrases.
464 # * If the boost is unspecified or non-positive, Dialogflow will not apply
465 # any boost.
466 #
467 # Dialogflow recommends that you use boosts in the range (0, 20] and that you
468 # find a value that fits your use case with binary search.
469 },
470 ],
471 "singleUtterance": True or False, # If `false` (default), recognition does not cease until the
472 # client closes the stream.
473 # If `true`, the recognizer will detect a single spoken utterance in input
474 # audio. Recognition ceases when it detects the audio's voice has
475 # stopped or paused. In this case, once a detected intent is received, the
476 # client should close the stream and start a new request with a new stream as
477 # needed.
478 # Note: This setting is relevant only for streaming methods.
479 # Note: When specified, InputAudioConfig.single_utterance takes precedence
480 # over StreamingDetectIntentRequest.single_utterance.
481 },
482 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 }
484
485 x__xgafv: string, V1 error format.
486 Allowed values
487 1 - v1 error format
488 2 - v2 error format
489
490Returns:
491 An object of the form:
492
493 { # The message returned from the DetectIntent method.
494 "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]495 # If this audio config is supplied in a request, it overrides all existing
496 # text-to-speech settings applied to the agent.
497 "sampleRateHertz": 42, # The synthesis sample rate (in hertz) for this audio. If not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498 # provided, then the synthesizer will use the default sample rate based on
499 # the audio encoding. If this is different from the voice's natural sample
500 # rate, then the synthesizer will honor this request by converting to the
501 # desired sample rate (which might result in worse audio quality).
502 "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]503 "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Configuration of how speech should be synthesized.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]504 "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are
505 # applied on (post synthesized) text to speech. Effects are applied on top of
506 # each other in the order they are given.
507 "A String",
508 ],
509 "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
510 "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will
511 # choose a voice based on the other parameters such as language_code and
512 # name. Note that this is only a preference, not requirement. If a
513 # voice of the appropriate gender is not available, the synthesizer should
514 # substitute a voice with a different gender rather than failing the request.
515 "name": "A String", # Optional. The name of the voice. If not set, the service will choose a
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]516 # voice based on the other parameters such as language_code and
517 # ssml_gender.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]518 },
519 "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal
520 # native speed supported by the specific voice. 2.0 is twice as fast, and
521 # 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]522 # other values &lt; 0.25 or &gt; 4.0 will return an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]523 "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the
524 # specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of
525 # 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)
526 # will play at approximately half the amplitude of the normal native signal
527 # amplitude. A value of +6.0 (dB) will play at approximately twice the
528 # amplitude of the normal native signal amplitude. We strongly recommend not
529 # to exceed +10 (dB) as there's usually no effective increase in loudness for
530 # any value greater than that.
531 "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20
532 # semitones from the original pitch. -20 means decrease 20 semitones from the
533 # original pitch.
534 },
535 },
536 "queryResult": { # Represents the result of conversational query or event processing. # The selected results of the conversational query or event processing.
537 # See `alternative_query_results` for additional potential results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]538 "languageCode": "A String", # The language that was triggered during intent detection.
539 # See [Language
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]540 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]541 # for a list of the currently supported language codes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]542 "fulfillmentText": "A String", # The text to be pronounced to the user or shown on the screen.
543 # Note: This is a legacy field, `fulfillment_messages` should be preferred.
544 "webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the
545 # value of the `payload` field returned in the webhook response.
546 "a_key": "", # Properties of the object.
547 },
548 "parameters": { # The collection of extracted parameters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]549 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]550 # Depending on your protocol or client library language, this is a
551 # map, associative array, symbol table, dictionary, or JSON object
552 # composed of a collection of (MapKey, MapValue) pairs:
553 #
554 # - MapKey type: string
555 # - MapKey value: parameter name
556 # - MapValue type:
557 # - If parameter's entity type is a composite entity: map
558 # - Else: string or number, depending on parameter value type
559 # - MapValue value:
560 # - If parameter's entity type is a composite entity:
561 # map from composite entity property names to property values
562 # - Else: parameter value
563 "a_key": "", # Properties of the object.
564 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]565 "fulfillmentMessages": [ # The collection of rich messages to present to the user.
566 { # Corresponds to the `Response` field in the Dialogflow console.
567 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
568 # This message in `QueryResult.fulfillment_messages` and
569 # `WebhookResponse.fulfillment_messages` should contain only one
570 # `SimpleResponse`.
571 "simpleResponses": [ # Required. The list of simple responses.
572 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
574 # response to the user in the SSML format. Mutually exclusive with
575 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]576 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
577 # speech output. Mutually exclusive with ssml.
578 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]579 },
580 ],
581 },
582 "quickReplies": { # The quick replies response message. # Displays quick replies.
583 "quickReplies": [ # Optional. The collection of quick replies.
584 "A String",
585 ],
586 "title": "A String", # Optional. The title of the collection of quick replies.
587 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]588 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
589 #
590 # RBM allows businesses to send enriched and branded versions of SMS. See
591 # https://jibe.google.com/business-messaging.
592 "text": "A String", # Required. Text sent and displayed to the user.
593 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
594 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
595 # easily select/click a predefined response or perform an action (like
596 # opening a web uri).
597 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
598 # can choose from the card.
599 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
600 # to send back to the agent (https://goo.gl/GXotJW).
601 },
602 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
603 # (https://goo.gl/6GLJD2). If the user has an app installed that is
604 # registered as the default handler for the URL, then this app will be
605 # opened instead, and its icon will be used in the suggested action UI.
606 "uri": "A String", # Required. The uri to open on the user device
607 },
608 "text": "A String", # Text to display alongside the action.
609 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
610 # but does not dial automatically (https://goo.gl/ergbB2).
611 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
612 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
613 # format. An example of a correctly formatted phone number:
614 # +15556767888.
615 },
616 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
617 # when the user taps the suggested action. This data will be also
618 # forwarded to webhook to allow performing custom business logic.
619 },
620 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
621 # instead of typing in their own response.
622 "text": "A String", # Suggested reply text.
623 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
624 # when the user taps the suggested reply. This data will be also
625 # forwarded to webhook to allow performing custom business logic.
626 },
627 },
628 ],
629 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]630 "platform": "A String", # Optional. The platform that this message is intended for.
631 "text": { # The text response message. # Returns a text response.
632 "text": [ # Optional. The collection of the agent's responses.
633 "A String",
634 ],
635 },
636 "image": { # The image response message. # Displays an image.
637 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
638 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
639 "imageUri": "A String", # Optional. The public URI to an image file.
640 },
641 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
642 # Telephony Gateway.
643 #
644 # Telephony Gateway takes the synthesizer settings from
645 # `DetectIntentResponse.output_audio_config` which can either be set
646 # at request-level or can come from the agent-level synthesizer config.
647 "ssml": "A String", # The SSML to be synthesized. For more information, see
648 # [SSML](https://developers.google.com/actions/reference/ssml).
649 "text": "A String", # The raw text to be synthesized.
650 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]651 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
652 #
653 # Rich cards allow you to respond to users with more vivid content, e.g.
654 # with media and suggestions.
655 #
656 # For more details about RBM rich cards, please see:
657 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
658 # If you want to show a single card with more control over the layout,
659 # please use RbmStandaloneCard instead.
660 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
661 # 2 cards and at most 10.
662 { # Rich Business Messaging (RBM) Card content
663 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
664 # be set. Media (image, GIF or a video) to include in the card.
665 # The following media-types are currently supported:
666 #
667 # Image Types
668 #
669 # * image/jpeg
670 # * image/jpg'
671 # * image/gif
672 # * image/png
673 #
674 # Video Types
675 #
676 # * video/h263
677 # * video/m4v
678 # * video/mp4
679 # * video/mpeg
680 # * video/mpeg4
681 # * video/webm
682 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
683 # determines the MIME type of the file from the content-type field in
684 # the HTTP headers when the platform fetches the file. The content-type
685 # field must be present and accurate in the HTTP response from the URL.
686 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
687 # provide a thumbnail URI, the RBM platform displays a blank
688 # placeholder thumbnail until the user's device downloads the file.
689 # Depending on the user's setting, the file may not download
690 # automatically and may require the user to tap a download button.
691 "height": "A String", # Required for cards with vertical orientation. The height of the media
692 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
693 # For a standalone card with horizontal layout, height is not
694 # customizable, and this field is ignored.
695 },
696 "suggestions": [ # Optional. List of suggestions to include in the card.
697 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
698 # easily select/click a predefined response or perform an action (like
699 # opening a web uri).
700 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
701 # can choose from the card.
702 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
703 # to send back to the agent (https://goo.gl/GXotJW).
704 },
705 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
706 # (https://goo.gl/6GLJD2). If the user has an app installed that is
707 # registered as the default handler for the URL, then this app will be
708 # opened instead, and its icon will be used in the suggested action UI.
709 "uri": "A String", # Required. The uri to open on the user device
710 },
711 "text": "A String", # Text to display alongside the action.
712 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
713 # but does not dial automatically (https://goo.gl/ergbB2).
714 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
715 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
716 # format. An example of a correctly formatted phone number:
717 # +15556767888.
718 },
719 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
720 # when the user taps the suggested action. This data will be also
721 # forwarded to webhook to allow performing custom business logic.
722 },
723 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
724 # instead of typing in their own response.
725 "text": "A String", # Suggested reply text.
726 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
727 # when the user taps the suggested reply. This data will be also
728 # forwarded to webhook to allow performing custom business logic.
729 },
730 },
731 ],
732 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
733 #
734 # At least one of the title, description or media must be set.
735 "title": "A String", # Optional. Title of the card (at most 200 bytes).
736 #
737 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]738 },
739 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]740 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]741 },
742 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
743 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
744 # play, e.g., "gs://bucket/object". The object must contain a single
745 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
746 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]747 # This object must be readable by the `service-&lt;Project
748 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
749 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]750 # (usually the same as the Dialogflow agent project). If the Google Cloud
751 # Storage bucket is in the Telephony Gateway project, this permission is
752 # added by default when enabling the Dialogflow V2 API.
753 #
754 # For audio from other sources, consider using the
755 # `TelephonySynthesizeSpeech` message with SSML.
756 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]757 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
758 #
759 # Rich cards allow you to respond to users with more vivid content, e.g.
760 # with media and suggestions.
761 #
762 # For more details about RBM rich cards, please see:
763 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
764 # You can group multiple rich cards into one using RbmCarouselCard but
765 # carousel cards will give you less control over the card layout.
766 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
767 # Image preview alignment for standalone cards with horizontal layout.
768 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
769 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
770 # be set. Media (image, GIF or a video) to include in the card.
771 # The following media-types are currently supported:
772 #
773 # Image Types
774 #
775 # * image/jpeg
776 # * image/jpg'
777 # * image/gif
778 # * image/png
779 #
780 # Video Types
781 #
782 # * video/h263
783 # * video/m4v
784 # * video/mp4
785 # * video/mpeg
786 # * video/mpeg4
787 # * video/webm
788 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
789 # determines the MIME type of the file from the content-type field in
790 # the HTTP headers when the platform fetches the file. The content-type
791 # field must be present and accurate in the HTTP response from the URL.
792 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
793 # provide a thumbnail URI, the RBM platform displays a blank
794 # placeholder thumbnail until the user's device downloads the file.
795 # Depending on the user's setting, the file may not download
796 # automatically and may require the user to tap a download button.
797 "height": "A String", # Required for cards with vertical orientation. The height of the media
798 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
799 # For a standalone card with horizontal layout, height is not
800 # customizable, and this field is ignored.
801 },
802 "suggestions": [ # Optional. List of suggestions to include in the card.
803 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
804 # easily select/click a predefined response or perform an action (like
805 # opening a web uri).
806 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
807 # can choose from the card.
808 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
809 # to send back to the agent (https://goo.gl/GXotJW).
810 },
811 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
812 # (https://goo.gl/6GLJD2). If the user has an app installed that is
813 # registered as the default handler for the URL, then this app will be
814 # opened instead, and its icon will be used in the suggested action UI.
815 "uri": "A String", # Required. The uri to open on the user device
816 },
817 "text": "A String", # Text to display alongside the action.
818 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
819 # but does not dial automatically (https://goo.gl/ergbB2).
820 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
821 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
822 # format. An example of a correctly formatted phone number:
823 # +15556767888.
824 },
825 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
826 # when the user taps the suggested action. This data will be also
827 # forwarded to webhook to allow performing custom business logic.
828 },
829 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
830 # instead of typing in their own response.
831 "text": "A String", # Suggested reply text.
832 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
833 # when the user taps the suggested reply. This data will be also
834 # forwarded to webhook to allow performing custom business logic.
835 },
836 },
837 ],
838 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
839 #
840 # At least one of the title, description or media must be set.
841 "title": "A String", # Optional. Title of the card (at most 200 bytes).
842 #
843 # At least one of the title, description or media must be set.
844 },
845 "cardOrientation": "A String", # Required. Orientation of the card.
846 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]847 "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.
848 # or website associated with this agent.
849 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
850 # suggestion chip.
851 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
852 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]853 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
854 # https://developers.google.com/actions/assistant/responses#browsing_carousel
855 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
856 # items, maximum of ten.
857 { # Browsing carousel tile
858 "image": { # The image response message. # Optional. Hero image for the carousel item.
859 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
860 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
861 "imageUri": "A String", # Optional. The public URI to an image file.
862 },
863 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
864 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
865 # text.
866 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
867 "url": "A String", # Required. URL
868 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
869 # the URL. Defaults to opening via web browser.
870 },
871 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
872 # Card. Maximum of one line of text.
873 },
874 ],
875 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
876 # items.
877 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]878 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
879 "buttons": [ # Optional. The collection of card buttons.
880 { # The button object that appears at the bottom of a card.
881 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
882 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
883 },
884 "title": "A String", # Required. The title of the button.
885 },
886 ],
887 "formattedText": "A String", # Required, unless image is present. The body text of the card.
888 "image": { # The image response message. # Optional. The image for the card.
889 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
890 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
891 "imageUri": "A String", # Optional. The public URI to an image file.
892 },
893 "subtitle": "A String", # Optional. The subtitle of the card.
894 "title": "A String", # Optional. The title of the card.
895 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]896 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
897 "mediaObjects": [ # Required. List of media objects.
898 { # Response media object for media content card.
899 "contentUrl": "A String", # Required. Url where the media is stored.
900 "description": "A String", # Optional. Description of media card.
901 "name": "A String", # Required. Name of media card.
902 "largeImage": { # The image response message. # Optional. Image to display above media content.
903 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
904 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
905 "imageUri": "A String", # Optional. The public URI to an image file.
906 },
907 "icon": { # The image response message. # Optional. Icon to display above media content.
908 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
909 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
910 "imageUri": "A String", # Optional. The public URI to an image file.
911 },
912 },
913 ],
914 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
915 },
916 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
917 "rows": [ # Optional. Rows in this table of data.
918 { # Row of TableCard.
919 "cells": [ # Optional. List of cells that make up this row.
920 { # Cell of TableCardRow.
921 "text": "A String", # Required. Text in this cell.
922 },
923 ],
924 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
925 },
926 ],
927 "subtitle": "A String", # Optional. Subtitle to the title.
928 "title": "A String", # Required. Title of the card.
929 "image": { # The image response message. # Optional. Image which should be displayed on the card.
930 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
931 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
932 "imageUri": "A String", # Optional. The public URI to an image file.
933 },
934 "columnProperties": [ # Optional. Display properties for the columns in this table.
935 { # Column properties for TableCard.
936 "header": "A String", # Required. Column heading.
937 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
938 },
939 ],
940 "buttons": [ # Optional. List of buttons for the card.
941 { # The button object that appears at the bottom of a card.
942 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
943 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
944 },
945 "title": "A String", # Required. The title of the button.
946 },
947 ],
948 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]949 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
950 "items": [ # Required. Carousel items.
951 { # An item in the carousel.
952 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
953 # dialog.
954 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
955 # item in dialog.
956 "A String",
957 ],
958 "key": "A String", # Required. A unique key that will be sent back to the agent if this
959 # response is given.
960 },
961 "image": { # The image response message. # Optional. The image to display.
962 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
963 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
964 "imageUri": "A String", # Optional. The public URI to an image file.
965 },
966 "description": "A String", # Optional. The body text of the card.
967 "title": "A String", # Required. Title of the carousel item.
968 },
969 ],
970 },
971 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
972 "items": [ # Required. List items.
973 { # An item in the list.
974 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
975 # dialog.
976 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
977 # item in dialog.
978 "A String",
979 ],
980 "key": "A String", # Required. A unique key that will be sent back to the agent if this
981 # response is given.
982 },
983 "image": { # The image response message. # Optional. The image to display.
984 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
985 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
986 "imageUri": "A String", # Optional. The public URI to an image file.
987 },
988 "description": "A String", # Optional. The main text describing the item.
989 "title": "A String", # Required. The title of the list item.
990 },
991 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]992 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]993 "title": "A String", # Optional. The overall title of the list.
994 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]995 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
996 "suggestions": [ # Required. The list of suggested replies.
997 { # The suggestion chip message that the user can tap to quickly post a reply
998 # to the conversation.
999 "title": "A String", # Required. The text shown the in the suggestion chip.
1000 },
1001 ],
1002 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1003 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
1004 "phoneNumber": "A String", # Required. The phone number to transfer the call to
1005 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
1006 #
1007 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
1008 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1009 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1010 "a_key": "", # Properties of the object.
1011 },
1012 "card": { # The card response message. # Displays a card.
1013 "buttons": [ # Optional. The collection of card buttons.
1014 { # Optional. Contains information about a button.
1015 "text": "A String", # Optional. The text to show on the button.
1016 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1017 # open.
1018 },
1019 ],
1020 "title": "A String", # Optional. The title of the card.
1021 "subtitle": "A String", # Optional. The subtitle of the card.
1022 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1023 },
1024 },
1025 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1026 "speechRecognitionConfidence": 3.14, # The Speech recognition confidence between 0.0 and 1.0. A higher number
1027 # indicates an estimated greater likelihood that the recognized words are
1028 # correct. The default of 0.0 is a sentinel value indicating that confidence
1029 # was not set.
1030 #
1031 # This field is not guaranteed to be accurate or set. In particular this
1032 # field isn't set for StreamingDetectIntent since the streaming endpoint has
1033 # separate confidence estimates per portion of the audio in
1034 # StreamingRecognitionResult.
1035 "webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the
1036 # value of the `source` field returned in the webhook response.
1037 "queryText": "A String", # The original conversational query text:
1038 #
1039 # - If natural language text was provided as input, `query_text` contains
1040 # a copy of the input.
1041 # - If natural language speech audio was provided as input, `query_text`
1042 # contains the speech recognition result. If speech recognizer produced
1043 # multiple alternatives, a particular one is picked.
1044 # - If automatic spell correction is enabled, `query_text` will contain the
1045 # corrected user input.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1046 "intent": { # Represents an intent. # The intent that matched the conversational query. Some, not
1047 # all fields are filled in this message, including but not limited to:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1048 # `name`, `display_name`, `end_interaction` and `is_fallback`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1049 # Intents convert a number of user expressions or patterns into an action. An
1050 # action is an extraction of a user command or sentence semantics.
1051 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
1052 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
1053 # Note: If `ml_disabled` setting is set to true, then this intent is not
1054 # taken into account during inference in `ML ONLY` match mode. Also,
1055 # auto-markup in the UI is turned off.
1056 "displayName": "A String", # Required. The name of this intent.
1057 "name": "A String", # The unique identifier of this intent.
1058 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
1059 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1060 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1061 "parameters": [ # Optional. The collection of parameters associated with the intent.
1062 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1063 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1064 "name": "A String", # The unique identifier of this parameter.
1065 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
1066 # result.
1067 # Default values can be extracted from contexts by using the following
1068 # syntax: `#context_name.parameter_name`.
1069 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
1070 # describes values of the parameter. If the parameter is
1071 # required, this must be provided.
1072 "value": "A String", # Optional. The definition of the parameter value. It can be:
1073 # - a constant string,
1074 # - a parameter value defined as `$parameter_name`,
1075 # - an original parameter value defined as `$parameter_name.original`,
1076 # - a parameter value from some context defined as
1077 # `#context_name.parameter_name`.
1078 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1079 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1080 "A String",
1081 ],
1082 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1083 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
1084 # whether the intent cannot be completed without collecting the parameter
1085 # value.
1086 },
1087 ],
1088 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
1089 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
1090 # to close interaction with an end user. Default is false.
1091 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
1092 # a direct or indirect parent. We populate this field only in the output.
1093 { # Represents a single followup intent in the chain.
1094 "followupIntentName": "A String", # The unique identifier of the followup intent.
1095 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
1096 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
1097 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
1098 },
1099 ],
1100 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
1101 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
1102 # chain of followup intents. You can set this field when creating an intent,
1103 # for example with CreateIntent or
1104 # BatchUpdateIntents, in order to make this
1105 # intent a followup intent.
1106 #
1107 # It identifies the parent followup intent.
1108 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
1109 "messages": [ # Optional. The collection of rich messages corresponding to the
1110 # `Response` field in the Dialogflow console.
1111 { # Corresponds to the `Response` field in the Dialogflow console.
1112 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
1113 # This message in `QueryResult.fulfillment_messages` and
1114 # `WebhookResponse.fulfillment_messages` should contain only one
1115 # `SimpleResponse`.
1116 "simpleResponses": [ # Required. The list of simple responses.
1117 { # The simple response message containing speech or text.
1118 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
1119 # response to the user in the SSML format. Mutually exclusive with
1120 # text_to_speech.
1121 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
1122 # speech output. Mutually exclusive with ssml.
1123 "displayText": "A String", # Optional. The text to display.
1124 },
1125 ],
1126 },
1127 "quickReplies": { # The quick replies response message. # Displays quick replies.
1128 "quickReplies": [ # Optional. The collection of quick replies.
1129 "A String",
1130 ],
1131 "title": "A String", # Optional. The title of the collection of quick replies.
1132 },
1133 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
1134 #
1135 # RBM allows businesses to send enriched and branded versions of SMS. See
1136 # https://jibe.google.com/business-messaging.
1137 "text": "A String", # Required. Text sent and displayed to the user.
1138 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
1139 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1140 # easily select/click a predefined response or perform an action (like
1141 # opening a web uri).
1142 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1143 # can choose from the card.
1144 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1145 # to send back to the agent (https://goo.gl/GXotJW).
1146 },
1147 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1148 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1149 # registered as the default handler for the URL, then this app will be
1150 # opened instead, and its icon will be used in the suggested action UI.
1151 "uri": "A String", # Required. The uri to open on the user device
1152 },
1153 "text": "A String", # Text to display alongside the action.
1154 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1155 # but does not dial automatically (https://goo.gl/ergbB2).
1156 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1157 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1158 # format. An example of a correctly formatted phone number:
1159 # +15556767888.
1160 },
1161 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1162 # when the user taps the suggested action. This data will be also
1163 # forwarded to webhook to allow performing custom business logic.
1164 },
1165 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1166 # instead of typing in their own response.
1167 "text": "A String", # Suggested reply text.
1168 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1169 # when the user taps the suggested reply. This data will be also
1170 # forwarded to webhook to allow performing custom business logic.
1171 },
1172 },
1173 ],
1174 },
1175 "platform": "A String", # Optional. The platform that this message is intended for.
1176 "text": { # The text response message. # Returns a text response.
1177 "text": [ # Optional. The collection of the agent's responses.
1178 "A String",
1179 ],
1180 },
1181 "image": { # The image response message. # Displays an image.
1182 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1183 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1184 "imageUri": "A String", # Optional. The public URI to an image file.
1185 },
1186 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
1187 # Telephony Gateway.
1188 #
1189 # Telephony Gateway takes the synthesizer settings from
1190 # `DetectIntentResponse.output_audio_config` which can either be set
1191 # at request-level or can come from the agent-level synthesizer config.
1192 "ssml": "A String", # The SSML to be synthesized. For more information, see
1193 # [SSML](https://developers.google.com/actions/reference/ssml).
1194 "text": "A String", # The raw text to be synthesized.
1195 },
1196 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
1197 #
1198 # Rich cards allow you to respond to users with more vivid content, e.g.
1199 # with media and suggestions.
1200 #
1201 # For more details about RBM rich cards, please see:
1202 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
1203 # If you want to show a single card with more control over the layout,
1204 # please use RbmStandaloneCard instead.
1205 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
1206 # 2 cards and at most 10.
1207 { # Rich Business Messaging (RBM) Card content
1208 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
1209 # be set. Media (image, GIF or a video) to include in the card.
1210 # The following media-types are currently supported:
1211 #
1212 # Image Types
1213 #
1214 # * image/jpeg
1215 # * image/jpg'
1216 # * image/gif
1217 # * image/png
1218 #
1219 # Video Types
1220 #
1221 # * video/h263
1222 # * video/m4v
1223 # * video/mp4
1224 # * video/mpeg
1225 # * video/mpeg4
1226 # * video/webm
1227 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
1228 # determines the MIME type of the file from the content-type field in
1229 # the HTTP headers when the platform fetches the file. The content-type
1230 # field must be present and accurate in the HTTP response from the URL.
1231 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
1232 # provide a thumbnail URI, the RBM platform displays a blank
1233 # placeholder thumbnail until the user's device downloads the file.
1234 # Depending on the user's setting, the file may not download
1235 # automatically and may require the user to tap a download button.
1236 "height": "A String", # Required for cards with vertical orientation. The height of the media
1237 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
1238 # For a standalone card with horizontal layout, height is not
1239 # customizable, and this field is ignored.
1240 },
1241 "suggestions": [ # Optional. List of suggestions to include in the card.
1242 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1243 # easily select/click a predefined response or perform an action (like
1244 # opening a web uri).
1245 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1246 # can choose from the card.
1247 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1248 # to send back to the agent (https://goo.gl/GXotJW).
1249 },
1250 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1251 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1252 # registered as the default handler for the URL, then this app will be
1253 # opened instead, and its icon will be used in the suggested action UI.
1254 "uri": "A String", # Required. The uri to open on the user device
1255 },
1256 "text": "A String", # Text to display alongside the action.
1257 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1258 # but does not dial automatically (https://goo.gl/ergbB2).
1259 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1260 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1261 # format. An example of a correctly formatted phone number:
1262 # +15556767888.
1263 },
1264 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1265 # when the user taps the suggested action. This data will be also
1266 # forwarded to webhook to allow performing custom business logic.
1267 },
1268 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1269 # instead of typing in their own response.
1270 "text": "A String", # Suggested reply text.
1271 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1272 # when the user taps the suggested reply. This data will be also
1273 # forwarded to webhook to allow performing custom business logic.
1274 },
1275 },
1276 ],
1277 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
1278 #
1279 # At least one of the title, description or media must be set.
1280 "title": "A String", # Optional. Title of the card (at most 200 bytes).
1281 #
1282 # At least one of the title, description or media must be set.
1283 },
1284 ],
1285 "cardWidth": "A String", # Required. The width of the cards in the carousel.
1286 },
1287 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
1288 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
1289 # play, e.g., "gs://bucket/object". The object must contain a single
1290 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
1291 #
1292 # This object must be readable by the `service-&lt;Project
1293 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
1294 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
1295 # (usually the same as the Dialogflow agent project). If the Google Cloud
1296 # Storage bucket is in the Telephony Gateway project, this permission is
1297 # added by default when enabling the Dialogflow V2 API.
1298 #
1299 # For audio from other sources, consider using the
1300 # `TelephonySynthesizeSpeech` message with SSML.
1301 },
1302 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
1303 #
1304 # Rich cards allow you to respond to users with more vivid content, e.g.
1305 # with media and suggestions.
1306 #
1307 # For more details about RBM rich cards, please see:
1308 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
1309 # You can group multiple rich cards into one using RbmCarouselCard but
1310 # carousel cards will give you less control over the card layout.
1311 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
1312 # Image preview alignment for standalone cards with horizontal layout.
1313 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
1314 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
1315 # be set. Media (image, GIF or a video) to include in the card.
1316 # The following media-types are currently supported:
1317 #
1318 # Image Types
1319 #
1320 # * image/jpeg
1321 # * image/jpg'
1322 # * image/gif
1323 # * image/png
1324 #
1325 # Video Types
1326 #
1327 # * video/h263
1328 # * video/m4v
1329 # * video/mp4
1330 # * video/mpeg
1331 # * video/mpeg4
1332 # * video/webm
1333 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
1334 # determines the MIME type of the file from the content-type field in
1335 # the HTTP headers when the platform fetches the file. The content-type
1336 # field must be present and accurate in the HTTP response from the URL.
1337 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
1338 # provide a thumbnail URI, the RBM platform displays a blank
1339 # placeholder thumbnail until the user's device downloads the file.
1340 # Depending on the user's setting, the file may not download
1341 # automatically and may require the user to tap a download button.
1342 "height": "A String", # Required for cards with vertical orientation. The height of the media
1343 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
1344 # For a standalone card with horizontal layout, height is not
1345 # customizable, and this field is ignored.
1346 },
1347 "suggestions": [ # Optional. List of suggestions to include in the card.
1348 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1349 # easily select/click a predefined response or perform an action (like
1350 # opening a web uri).
1351 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1352 # can choose from the card.
1353 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1354 # to send back to the agent (https://goo.gl/GXotJW).
1355 },
1356 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1357 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1358 # registered as the default handler for the URL, then this app will be
1359 # opened instead, and its icon will be used in the suggested action UI.
1360 "uri": "A String", # Required. The uri to open on the user device
1361 },
1362 "text": "A String", # Text to display alongside the action.
1363 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1364 # but does not dial automatically (https://goo.gl/ergbB2).
1365 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1366 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1367 # format. An example of a correctly formatted phone number:
1368 # +15556767888.
1369 },
1370 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1371 # when the user taps the suggested action. This data will be also
1372 # forwarded to webhook to allow performing custom business logic.
1373 },
1374 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1375 # instead of typing in their own response.
1376 "text": "A String", # Suggested reply text.
1377 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1378 # when the user taps the suggested reply. This data will be also
1379 # forwarded to webhook to allow performing custom business logic.
1380 },
1381 },
1382 ],
1383 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
1384 #
1385 # At least one of the title, description or media must be set.
1386 "title": "A String", # Optional. Title of the card (at most 200 bytes).
1387 #
1388 # At least one of the title, description or media must be set.
1389 },
1390 "cardOrientation": "A String", # Required. Orientation of the card.
1391 },
1392 "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.
1393 # or website associated with this agent.
1394 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
1395 # suggestion chip.
1396 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
1397 },
1398 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
1399 # https://developers.google.com/actions/assistant/responses#browsing_carousel
1400 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
1401 # items, maximum of ten.
1402 { # Browsing carousel tile
1403 "image": { # The image response message. # Optional. Hero image for the carousel item.
1404 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1405 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1406 "imageUri": "A String", # Optional. The public URI to an image file.
1407 },
1408 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
1409 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
1410 # text.
1411 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
1412 "url": "A String", # Required. URL
1413 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
1414 # the URL. Defaults to opening via web browser.
1415 },
1416 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
1417 # Card. Maximum of one line of text.
1418 },
1419 ],
1420 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
1421 # items.
1422 },
1423 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
1424 "buttons": [ # Optional. The collection of card buttons.
1425 { # The button object that appears at the bottom of a card.
1426 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1427 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1428 },
1429 "title": "A String", # Required. The title of the button.
1430 },
1431 ],
1432 "formattedText": "A String", # Required, unless image is present. The body text of the card.
1433 "image": { # The image response message. # Optional. The image for the card.
1434 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1435 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1436 "imageUri": "A String", # Optional. The public URI to an image file.
1437 },
1438 "subtitle": "A String", # Optional. The subtitle of the card.
1439 "title": "A String", # Optional. The title of the card.
1440 },
1441 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
1442 "mediaObjects": [ # Required. List of media objects.
1443 { # Response media object for media content card.
1444 "contentUrl": "A String", # Required. Url where the media is stored.
1445 "description": "A String", # Optional. Description of media card.
1446 "name": "A String", # Required. Name of media card.
1447 "largeImage": { # The image response message. # Optional. Image to display above media content.
1448 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1449 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1450 "imageUri": "A String", # Optional. The public URI to an image file.
1451 },
1452 "icon": { # The image response message. # Optional. Icon to display above media content.
1453 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1454 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1455 "imageUri": "A String", # Optional. The public URI to an image file.
1456 },
1457 },
1458 ],
1459 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
1460 },
1461 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
1462 "rows": [ # Optional. Rows in this table of data.
1463 { # Row of TableCard.
1464 "cells": [ # Optional. List of cells that make up this row.
1465 { # Cell of TableCardRow.
1466 "text": "A String", # Required. Text in this cell.
1467 },
1468 ],
1469 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
1470 },
1471 ],
1472 "subtitle": "A String", # Optional. Subtitle to the title.
1473 "title": "A String", # Required. Title of the card.
1474 "image": { # The image response message. # Optional. Image which should be displayed on the card.
1475 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1476 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1477 "imageUri": "A String", # Optional. The public URI to an image file.
1478 },
1479 "columnProperties": [ # Optional. Display properties for the columns in this table.
1480 { # Column properties for TableCard.
1481 "header": "A String", # Required. Column heading.
1482 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
1483 },
1484 ],
1485 "buttons": [ # Optional. List of buttons for the card.
1486 { # The button object that appears at the bottom of a card.
1487 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1488 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1489 },
1490 "title": "A String", # Required. The title of the button.
1491 },
1492 ],
1493 },
1494 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
1495 "items": [ # Required. Carousel items.
1496 { # An item in the carousel.
1497 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
1498 # dialog.
1499 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1500 # item in dialog.
1501 "A String",
1502 ],
1503 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1504 # response is given.
1505 },
1506 "image": { # The image response message. # Optional. The image to display.
1507 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1508 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1509 "imageUri": "A String", # Optional. The public URI to an image file.
1510 },
1511 "description": "A String", # Optional. The body text of the card.
1512 "title": "A String", # Required. Title of the carousel item.
1513 },
1514 ],
1515 },
1516 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
1517 "items": [ # Required. List items.
1518 { # An item in the list.
1519 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
1520 # dialog.
1521 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1522 # item in dialog.
1523 "A String",
1524 ],
1525 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1526 # response is given.
1527 },
1528 "image": { # The image response message. # Optional. The image to display.
1529 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1530 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1531 "imageUri": "A String", # Optional. The public URI to an image file.
1532 },
1533 "description": "A String", # Optional. The main text describing the item.
1534 "title": "A String", # Required. The title of the list item.
1535 },
1536 ],
1537 "subtitle": "A String", # Optional. Subtitle of the list.
1538 "title": "A String", # Optional. The overall title of the list.
1539 },
1540 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
1541 "suggestions": [ # Required. The list of suggested replies.
1542 { # The suggestion chip message that the user can tap to quickly post a reply
1543 # to the conversation.
1544 "title": "A String", # Required. The text shown the in the suggestion chip.
1545 },
1546 ],
1547 },
1548 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
1549 "phoneNumber": "A String", # Required. The phone number to transfer the call to
1550 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
1551 #
1552 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
1553 },
1554 "payload": { # A custom platform-specific response.
1555 "a_key": "", # Properties of the object.
1556 },
1557 "card": { # The card response message. # Displays a card.
1558 "buttons": [ # Optional. The collection of card buttons.
1559 { # Optional. Contains information about a button.
1560 "text": "A String", # Optional. The text to show on the button.
1561 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1562 # open.
1563 },
1564 ],
1565 "title": "A String", # Optional. The title of the card.
1566 "subtitle": "A String", # Optional. The subtitle of the card.
1567 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1568 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1569 },
1570 ],
1571 "trainingPhrases": [ # Optional. The collection of examples that the agent is
1572 # trained on.
1573 { # Represents an example that the agent is trained on.
1574 "parts": [ # Required. The ordered list of training phrase parts.
1575 # The parts are concatenated in order to form the training phrase.
1576 #
1577 # Note: The API does not automatically annotate training phrases like the
1578 # Dialogflow Console does.
1579 #
1580 # Note: Do not forget to include whitespace at part boundaries,
1581 # so the training phrase is well formatted when the parts are concatenated.
1582 #
1583 # If the training phrase does not need to be annotated with parameters,
1584 # you just need a single part with only the Part.text field set.
1585 #
1586 # If you want to annotate the training phrase, you must create multiple
1587 # parts, where the fields of each part are populated in one of two ways:
1588 #
1589 # - `Part.text` is set to a part of the phrase that has no parameters.
1590 # - `Part.text` is set to a part of the phrase that you want to annotate,
1591 # and the `entity_type`, `alias`, and `user_defined` fields are all
1592 # set.
1593 { # Represents a part of a training phrase.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1594 "alias": "A String", # Optional. The parameter name for the value extracted from the
1595 # annotated part of the example.
1596 # This field is required for annotated parts of the training phrase.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1597 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
1598 # This field is required for annotated parts of the training phrase.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1599 "text": "A String", # Required. The text for this part.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1600 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
1601 # This field is set to true when the Dialogflow Console is used to
1602 # manually annotate the part. When creating an annotated part with the
1603 # API, you must set this to true.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1604 },
1605 ],
1606 "type": "A String", # Required. The type of the training phrase.
1607 "name": "A String", # Output only. The unique identifier of this training phrase.
1608 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
1609 # the intent. Each time a developer adds an existing sample by editing an
1610 # intent or training, this counter is increased.
1611 },
1612 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1613 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
1614 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
1615 "A String",
1616 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1617 "priority": 42, # The priority of this intent. Higher numbers represent higher
1618 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1619 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1620 # - If the supplied value is unspecified or 0, the service
1621 # translates the value to 500,000, which corresponds to the
1622 # `Normal` priority in the console.
1623 # - If the supplied value is negative, the intent is ignored
1624 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1625 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
1626 # followup intents. It identifies the correct followup intents chain for
1627 # this intent. We populate this field only in the output.
1628 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1629 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
1630 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
1631 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1632 "inputContextNames": [ # Optional. The list of context names required for this intent to be
1633 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1634 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1635 "A String",
1636 ],
1637 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
1638 # Note: If `ml_enabled` setting is set to false, then this intent is not
1639 # taken into account during inference in `ML ONLY` match mode. Also,
1640 # auto-markup in the UI is turned off.
1641 # DEPRECATED! Please use `ml_disabled` field instead.
1642 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
1643 # then the default value is determined as follows:
1644 # - Before April 15th, 2018 the default is:
1645 # ml_enabled = false / ml_disabled = true.
1646 # - After April 15th, 2018 the default is:
1647 # ml_enabled = true / ml_disabled = false.
1648 "action": "A String", # Optional. The name of the action associated with the intent.
1649 # Note: The action name must not contain whitespaces.
1650 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
1651 # is matched. Context messages in this collection should not set the
1652 # parameters field. Setting the `lifespan_count` to 0 will reset the context
1653 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1654 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1655 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1656 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1657 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
1658 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
1659 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1660 #
1661 # The `Context ID` is always converted to lowercase, may only contain
1662 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
1663 #
1664 # If `Environment ID` is not specified, we assume default 'draft'
1665 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1666 #
1667 # The following context names are reserved for internal use by Dialogflow.
1668 # You should not use these contexts or create contexts with these names:
1669 #
1670 # * `__system_counters__`
1671 # * `*_id_dialog_context`
1672 # * `*_dialog_params_size`
1673 "parameters": { # Optional. The collection of parameters associated with this context.
1674 #
1675 # Depending on your protocol or client library language, this is a
1676 # map, associative array, symbol table, dictionary, or JSON object
1677 # composed of a collection of (MapKey, MapValue) pairs:
1678 #
1679 # - MapKey type: string
1680 # - MapKey value: parameter name
1681 # - MapValue type:
1682 # - If parameter's entity type is a composite entity: map
1683 # - Else: string or number, depending on parameter value type
1684 # - MapValue value:
1685 # - If parameter's entity type is a composite entity:
1686 # map from composite entity property names to property values
1687 # - Else: parameter value
1688 "a_key": "", # Properties of the object.
1689 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1690 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1691 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1692 # immediately. Contexts expire automatically after 20 minutes if there
1693 # are no matching queries.
1694 },
1695 ],
1696 "events": [ # Optional. The collection of event names that trigger the intent.
1697 # If the collection of input contexts is not empty, all of the contexts must
1698 # be present in the active user session for an event to trigger this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1699 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1700 "A String",
1701 ],
1702 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1703 "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0
1704 # (completely uncertain) to 1.0 (completely certain).
1705 # This value is for informational purpose only and is only used to
1706 # help match the best intent within the classification threshold.
1707 # This value may change for the same end-user expression at any time due to a
1708 # model retraining or change in implementation.
1709 # If there are `multiple knowledge_answers` messages, this value is set to
1710 # the greatest `knowledgeAnswers.match_confidence` value in the list.
1711 "diagnosticInfo": { # Free-form diagnostic information for the associated detect intent request.
1712 # The fields of this data can change without notice, so you should not write
1713 # code that depends on its structure.
1714 # The data may contain:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1715 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1716 # - webhook call latency
1717 # - webhook errors
1718 "a_key": "", # Properties of the object.
1719 },
1720 "action": "A String", # The action name from the matched intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1721 "outputContexts": [ # The collection of output contexts. If applicable,
1722 # `output_contexts.parameters` contains entries with name
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1723 # `&lt;parameter name&gt;.original` containing the original parameter values
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1724 # before the query.
1725 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1726 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1727 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
1728 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
1729 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1730 #
1731 # The `Context ID` is always converted to lowercase, may only contain
1732 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
1733 #
1734 # If `Environment ID` is not specified, we assume default 'draft'
1735 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1736 #
1737 # The following context names are reserved for internal use by Dialogflow.
1738 # You should not use these contexts or create contexts with these names:
1739 #
1740 # * `__system_counters__`
1741 # * `*_id_dialog_context`
1742 # * `*_dialog_params_size`
1743 "parameters": { # Optional. The collection of parameters associated with this context.
1744 #
1745 # Depending on your protocol or client library language, this is a
1746 # map, associative array, symbol table, dictionary, or JSON object
1747 # composed of a collection of (MapKey, MapValue) pairs:
1748 #
1749 # - MapKey type: string
1750 # - MapKey value: parameter name
1751 # - MapValue type:
1752 # - If parameter's entity type is a composite entity: map
1753 # - Else: string or number, depending on parameter value type
1754 # - MapValue value:
1755 # - If parameter's entity type is a composite entity:
1756 # map from composite entity property names to property values
1757 # - Else: parameter value
1758 "a_key": "", # Properties of the object.
1759 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1760 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1761 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1762 # immediately. Contexts expire automatically after 20 minutes if there
1763 # are no matching queries.
1764 },
1765 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1766 "allRequiredParamsPresent": True or False, # This field is set to:
1767 #
1768 # - `false` if the matched intent has required parameters and not all of
1769 # the required parameter values have been collected.
1770 # - `true` if all required parameter values have been collected, or if the
1771 # matched intent doesn't contain any required parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1772 "sentimentAnalysisResult": { # The result of sentiment analysis as configured by # The sentiment analysis result, which depends on the
1773 # `sentiment_analysis_request_config` specified in the request.
1774 # `sentiment_analysis_request_config`.
1775 "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.
1776 # of analysis, such as the query text.
1777 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
1778 # sentiment).
1779 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute
1780 # magnitude of sentiment, regardless of score (positive or negative).
1781 },
1782 },
1783 "knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing
1784 # `KnowledgeAnswers.match_confidence`.
1785 "answers": [ # A list of answers from Knowledge Connector.
1786 { # An answer from Knowledge Connector.
1787 "matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match
1788 # for this conversational query.
1789 # The range is from 0.0 (completely uncertain) to 1.0 (completely certain).
1790 # Note: The confidence score is likely to vary somewhat (possibly even for
1791 # identical requests), as the underlying model is under constant
1792 # improvement. It may be deprecated in the future. We recommend using
1793 # `match_confidence_level` which should be generally more stable.
1794 "source": "A String", # Indicates which Knowledge Document this answer was extracted from.
1795 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
1796 # ID&gt;/documents/&lt;Document ID&gt;`.
1797 "matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match
1798 # for this conversational query.
1799 # NOTE: The confidence level for a given `&lt;query, answer&gt;` pair may change
1800 # without notice, as it depends on models that are constantly being
1801 # improved. However, it will change less frequently than the confidence
1802 # score below, and should be preferred for referencing the quality of an
1803 # answer.
1804 "answer": "A String", # The piece of text from the `source` knowledge base document that answers
1805 # this conversational query.
1806 "faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ
1807 # Document, empty otherwise.
1808 },
1809 ],
1810 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1811 },
1812 "responseId": "A String", # The unique identifier of the response. It can be used to
1813 # locate a response in the training example set or for reporting issues.
1814 "outputAudio": "A String", # The audio data bytes encoded as specified in the request.
1815 # Note: The output audio is generated based on the values of default platform
1816 # text responses found in the `query_result.fulfillment_messages` field. If
1817 # multiple default text responses exist, they will be concatenated when
1818 # generating audio. If no default platform text responses exist, the
1819 # generated audio content will be empty.
1820 "alternativeQueryResults": [ # If Knowledge Connectors are enabled, there could be more than one result
1821 # returned for a given query or event, and this field will contain all
1822 # results except for the top one, which is captured in query_result. The
1823 # alternative results are ordered by decreasing
1824 # `QueryResult.intent_detection_confidence`. If Knowledge Connectors are
1825 # disabled, this field will be empty until multiple responses for regular
1826 # intents are supported, at which point those additional results will be
1827 # surfaced here.
1828 { # Represents the result of conversational query or event processing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1829 "languageCode": "A String", # The language that was triggered during intent detection.
1830 # See [Language
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1831 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1832 # for a list of the currently supported language codes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1833 "fulfillmentText": "A String", # The text to be pronounced to the user or shown on the screen.
1834 # Note: This is a legacy field, `fulfillment_messages` should be preferred.
1835 "webhookPayload": { # If the query was fulfilled by a webhook call, this field is set to the
1836 # value of the `payload` field returned in the webhook response.
1837 "a_key": "", # Properties of the object.
1838 },
1839 "parameters": { # The collection of extracted parameters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1840 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1841 # Depending on your protocol or client library language, this is a
1842 # map, associative array, symbol table, dictionary, or JSON object
1843 # composed of a collection of (MapKey, MapValue) pairs:
1844 #
1845 # - MapKey type: string
1846 # - MapKey value: parameter name
1847 # - MapValue type:
1848 # - If parameter's entity type is a composite entity: map
1849 # - Else: string or number, depending on parameter value type
1850 # - MapValue value:
1851 # - If parameter's entity type is a composite entity:
1852 # map from composite entity property names to property values
1853 # - Else: parameter value
1854 "a_key": "", # Properties of the object.
1855 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1856 "fulfillmentMessages": [ # The collection of rich messages to present to the user.
1857 { # Corresponds to the `Response` field in the Dialogflow console.
1858 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
1859 # This message in `QueryResult.fulfillment_messages` and
1860 # `WebhookResponse.fulfillment_messages` should contain only one
1861 # `SimpleResponse`.
1862 "simpleResponses": [ # Required. The list of simple responses.
1863 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1864 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
1865 # response to the user in the SSML format. Mutually exclusive with
1866 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1867 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
1868 # speech output. Mutually exclusive with ssml.
1869 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1870 },
1871 ],
1872 },
1873 "quickReplies": { # The quick replies response message. # Displays quick replies.
1874 "quickReplies": [ # Optional. The collection of quick replies.
1875 "A String",
1876 ],
1877 "title": "A String", # Optional. The title of the collection of quick replies.
1878 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1879 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
1880 #
1881 # RBM allows businesses to send enriched and branded versions of SMS. See
1882 # https://jibe.google.com/business-messaging.
1883 "text": "A String", # Required. Text sent and displayed to the user.
1884 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
1885 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1886 # easily select/click a predefined response or perform an action (like
1887 # opening a web uri).
1888 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1889 # can choose from the card.
1890 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1891 # to send back to the agent (https://goo.gl/GXotJW).
1892 },
1893 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1894 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1895 # registered as the default handler for the URL, then this app will be
1896 # opened instead, and its icon will be used in the suggested action UI.
1897 "uri": "A String", # Required. The uri to open on the user device
1898 },
1899 "text": "A String", # Text to display alongside the action.
1900 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1901 # but does not dial automatically (https://goo.gl/ergbB2).
1902 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1903 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1904 # format. An example of a correctly formatted phone number:
1905 # +15556767888.
1906 },
1907 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1908 # when the user taps the suggested action. This data will be also
1909 # forwarded to webhook to allow performing custom business logic.
1910 },
1911 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1912 # instead of typing in their own response.
1913 "text": "A String", # Suggested reply text.
1914 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1915 # when the user taps the suggested reply. This data will be also
1916 # forwarded to webhook to allow performing custom business logic.
1917 },
1918 },
1919 ],
1920 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1921 "platform": "A String", # Optional. The platform that this message is intended for.
1922 "text": { # The text response message. # Returns a text response.
1923 "text": [ # Optional. The collection of the agent's responses.
1924 "A String",
1925 ],
1926 },
1927 "image": { # The image response message. # Displays an image.
1928 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1929 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1930 "imageUri": "A String", # Optional. The public URI to an image file.
1931 },
1932 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
1933 # Telephony Gateway.
1934 #
1935 # Telephony Gateway takes the synthesizer settings from
1936 # `DetectIntentResponse.output_audio_config` which can either be set
1937 # at request-level or can come from the agent-level synthesizer config.
1938 "ssml": "A String", # The SSML to be synthesized. For more information, see
1939 # [SSML](https://developers.google.com/actions/reference/ssml).
1940 "text": "A String", # The raw text to be synthesized.
1941 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1942 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
1943 #
1944 # Rich cards allow you to respond to users with more vivid content, e.g.
1945 # with media and suggestions.
1946 #
1947 # For more details about RBM rich cards, please see:
1948 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
1949 # If you want to show a single card with more control over the layout,
1950 # please use RbmStandaloneCard instead.
1951 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
1952 # 2 cards and at most 10.
1953 { # Rich Business Messaging (RBM) Card content
1954 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
1955 # be set. Media (image, GIF or a video) to include in the card.
1956 # The following media-types are currently supported:
1957 #
1958 # Image Types
1959 #
1960 # * image/jpeg
1961 # * image/jpg'
1962 # * image/gif
1963 # * image/png
1964 #
1965 # Video Types
1966 #
1967 # * video/h263
1968 # * video/m4v
1969 # * video/mp4
1970 # * video/mpeg
1971 # * video/mpeg4
1972 # * video/webm
1973 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
1974 # determines the MIME type of the file from the content-type field in
1975 # the HTTP headers when the platform fetches the file. The content-type
1976 # field must be present and accurate in the HTTP response from the URL.
1977 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
1978 # provide a thumbnail URI, the RBM platform displays a blank
1979 # placeholder thumbnail until the user's device downloads the file.
1980 # Depending on the user's setting, the file may not download
1981 # automatically and may require the user to tap a download button.
1982 "height": "A String", # Required for cards with vertical orientation. The height of the media
1983 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
1984 # For a standalone card with horizontal layout, height is not
1985 # customizable, and this field is ignored.
1986 },
1987 "suggestions": [ # Optional. List of suggestions to include in the card.
1988 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1989 # easily select/click a predefined response or perform an action (like
1990 # opening a web uri).
1991 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1992 # can choose from the card.
1993 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1994 # to send back to the agent (https://goo.gl/GXotJW).
1995 },
1996 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1997 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1998 # registered as the default handler for the URL, then this app will be
1999 # opened instead, and its icon will be used in the suggested action UI.
2000 "uri": "A String", # Required. The uri to open on the user device
2001 },
2002 "text": "A String", # Text to display alongside the action.
2003 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
2004 # but does not dial automatically (https://goo.gl/ergbB2).
2005 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
2006 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
2007 # format. An example of a correctly formatted phone number:
2008 # +15556767888.
2009 },
2010 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2011 # when the user taps the suggested action. This data will be also
2012 # forwarded to webhook to allow performing custom business logic.
2013 },
2014 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
2015 # instead of typing in their own response.
2016 "text": "A String", # Suggested reply text.
2017 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2018 # when the user taps the suggested reply. This data will be also
2019 # forwarded to webhook to allow performing custom business logic.
2020 },
2021 },
2022 ],
2023 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
2024 #
2025 # At least one of the title, description or media must be set.
2026 "title": "A String", # Optional. Title of the card (at most 200 bytes).
2027 #
2028 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2029 },
2030 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2031 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2032 },
2033 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
2034 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
2035 # play, e.g., "gs://bucket/object". The object must contain a single
2036 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
2037 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2038 # This object must be readable by the `service-&lt;Project
2039 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
2040 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2041 # (usually the same as the Dialogflow agent project). If the Google Cloud
2042 # Storage bucket is in the Telephony Gateway project, this permission is
2043 # added by default when enabling the Dialogflow V2 API.
2044 #
2045 # For audio from other sources, consider using the
2046 # `TelephonySynthesizeSpeech` message with SSML.
2047 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2048 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
2049 #
2050 # Rich cards allow you to respond to users with more vivid content, e.g.
2051 # with media and suggestions.
2052 #
2053 # For more details about RBM rich cards, please see:
2054 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
2055 # You can group multiple rich cards into one using RbmCarouselCard but
2056 # carousel cards will give you less control over the card layout.
2057 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
2058 # Image preview alignment for standalone cards with horizontal layout.
2059 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
2060 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
2061 # be set. Media (image, GIF or a video) to include in the card.
2062 # The following media-types are currently supported:
2063 #
2064 # Image Types
2065 #
2066 # * image/jpeg
2067 # * image/jpg'
2068 # * image/gif
2069 # * image/png
2070 #
2071 # Video Types
2072 #
2073 # * video/h263
2074 # * video/m4v
2075 # * video/mp4
2076 # * video/mpeg
2077 # * video/mpeg4
2078 # * video/webm
2079 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
2080 # determines the MIME type of the file from the content-type field in
2081 # the HTTP headers when the platform fetches the file. The content-type
2082 # field must be present and accurate in the HTTP response from the URL.
2083 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
2084 # provide a thumbnail URI, the RBM platform displays a blank
2085 # placeholder thumbnail until the user's device downloads the file.
2086 # Depending on the user's setting, the file may not download
2087 # automatically and may require the user to tap a download button.
2088 "height": "A String", # Required for cards with vertical orientation. The height of the media
2089 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
2090 # For a standalone card with horizontal layout, height is not
2091 # customizable, and this field is ignored.
2092 },
2093 "suggestions": [ # Optional. List of suggestions to include in the card.
2094 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
2095 # easily select/click a predefined response or perform an action (like
2096 # opening a web uri).
2097 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
2098 # can choose from the card.
2099 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
2100 # to send back to the agent (https://goo.gl/GXotJW).
2101 },
2102 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
2103 # (https://goo.gl/6GLJD2). If the user has an app installed that is
2104 # registered as the default handler for the URL, then this app will be
2105 # opened instead, and its icon will be used in the suggested action UI.
2106 "uri": "A String", # Required. The uri to open on the user device
2107 },
2108 "text": "A String", # Text to display alongside the action.
2109 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
2110 # but does not dial automatically (https://goo.gl/ergbB2).
2111 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
2112 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
2113 # format. An example of a correctly formatted phone number:
2114 # +15556767888.
2115 },
2116 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2117 # when the user taps the suggested action. This data will be also
2118 # forwarded to webhook to allow performing custom business logic.
2119 },
2120 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
2121 # instead of typing in their own response.
2122 "text": "A String", # Suggested reply text.
2123 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2124 # when the user taps the suggested reply. This data will be also
2125 # forwarded to webhook to allow performing custom business logic.
2126 },
2127 },
2128 ],
2129 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
2130 #
2131 # At least one of the title, description or media must be set.
2132 "title": "A String", # Optional. Title of the card (at most 200 bytes).
2133 #
2134 # At least one of the title, description or media must be set.
2135 },
2136 "cardOrientation": "A String", # Required. Orientation of the card.
2137 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2138 "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.
2139 # or website associated with this agent.
2140 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
2141 # suggestion chip.
2142 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
2143 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2144 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
2145 # https://developers.google.com/actions/assistant/responses#browsing_carousel
2146 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
2147 # items, maximum of ten.
2148 { # Browsing carousel tile
2149 "image": { # The image response message. # Optional. Hero image for the carousel item.
2150 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2151 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2152 "imageUri": "A String", # Optional. The public URI to an image file.
2153 },
2154 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
2155 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
2156 # text.
2157 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
2158 "url": "A String", # Required. URL
2159 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
2160 # the URL. Defaults to opening via web browser.
2161 },
2162 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
2163 # Card. Maximum of one line of text.
2164 },
2165 ],
2166 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
2167 # items.
2168 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2169 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
2170 "buttons": [ # Optional. The collection of card buttons.
2171 { # The button object that appears at the bottom of a card.
2172 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2173 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2174 },
2175 "title": "A String", # Required. The title of the button.
2176 },
2177 ],
2178 "formattedText": "A String", # Required, unless image is present. The body text of the card.
2179 "image": { # The image response message. # Optional. The image for the card.
2180 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2181 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2182 "imageUri": "A String", # Optional. The public URI to an image file.
2183 },
2184 "subtitle": "A String", # Optional. The subtitle of the card.
2185 "title": "A String", # Optional. The title of the card.
2186 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2187 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
2188 "mediaObjects": [ # Required. List of media objects.
2189 { # Response media object for media content card.
2190 "contentUrl": "A String", # Required. Url where the media is stored.
2191 "description": "A String", # Optional. Description of media card.
2192 "name": "A String", # Required. Name of media card.
2193 "largeImage": { # The image response message. # Optional. Image to display above media content.
2194 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2195 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2196 "imageUri": "A String", # Optional. The public URI to an image file.
2197 },
2198 "icon": { # The image response message. # Optional. Icon to display above media content.
2199 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2200 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2201 "imageUri": "A String", # Optional. The public URI to an image file.
2202 },
2203 },
2204 ],
2205 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
2206 },
2207 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
2208 "rows": [ # Optional. Rows in this table of data.
2209 { # Row of TableCard.
2210 "cells": [ # Optional. List of cells that make up this row.
2211 { # Cell of TableCardRow.
2212 "text": "A String", # Required. Text in this cell.
2213 },
2214 ],
2215 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
2216 },
2217 ],
2218 "subtitle": "A String", # Optional. Subtitle to the title.
2219 "title": "A String", # Required. Title of the card.
2220 "image": { # The image response message. # Optional. Image which should be displayed on the card.
2221 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2222 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2223 "imageUri": "A String", # Optional. The public URI to an image file.
2224 },
2225 "columnProperties": [ # Optional. Display properties for the columns in this table.
2226 { # Column properties for TableCard.
2227 "header": "A String", # Required. Column heading.
2228 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
2229 },
2230 ],
2231 "buttons": [ # Optional. List of buttons for the card.
2232 { # The button object that appears at the bottom of a card.
2233 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2234 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2235 },
2236 "title": "A String", # Required. The title of the button.
2237 },
2238 ],
2239 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2240 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
2241 "items": [ # Required. Carousel items.
2242 { # An item in the carousel.
2243 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2244 # dialog.
2245 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2246 # item in dialog.
2247 "A String",
2248 ],
2249 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2250 # response is given.
2251 },
2252 "image": { # The image response message. # Optional. The image to display.
2253 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2254 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2255 "imageUri": "A String", # Optional. The public URI to an image file.
2256 },
2257 "description": "A String", # Optional. The body text of the card.
2258 "title": "A String", # Required. Title of the carousel item.
2259 },
2260 ],
2261 },
2262 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
2263 "items": [ # Required. List items.
2264 { # An item in the list.
2265 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
2266 # dialog.
2267 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2268 # item in dialog.
2269 "A String",
2270 ],
2271 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2272 # response is given.
2273 },
2274 "image": { # The image response message. # Optional. The image to display.
2275 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2276 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2277 "imageUri": "A String", # Optional. The public URI to an image file.
2278 },
2279 "description": "A String", # Optional. The main text describing the item.
2280 "title": "A String", # Required. The title of the list item.
2281 },
2282 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2283 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2284 "title": "A String", # Optional. The overall title of the list.
2285 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2286 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
2287 "suggestions": [ # Required. The list of suggested replies.
2288 { # The suggestion chip message that the user can tap to quickly post a reply
2289 # to the conversation.
2290 "title": "A String", # Required. The text shown the in the suggestion chip.
2291 },
2292 ],
2293 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2294 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
2295 "phoneNumber": "A String", # Required. The phone number to transfer the call to
2296 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
2297 #
2298 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
2299 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2300 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2301 "a_key": "", # Properties of the object.
2302 },
2303 "card": { # The card response message. # Displays a card.
2304 "buttons": [ # Optional. The collection of card buttons.
2305 { # Optional. Contains information about a button.
2306 "text": "A String", # Optional. The text to show on the button.
2307 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
2308 # open.
2309 },
2310 ],
2311 "title": "A String", # Optional. The title of the card.
2312 "subtitle": "A String", # Optional. The subtitle of the card.
2313 "imageUri": "A String", # Optional. The public URI to an image file for the card.
2314 },
2315 },
2316 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2317 "speechRecognitionConfidence": 3.14, # The Speech recognition confidence between 0.0 and 1.0. A higher number
2318 # indicates an estimated greater likelihood that the recognized words are
2319 # correct. The default of 0.0 is a sentinel value indicating that confidence
2320 # was not set.
2321 #
2322 # This field is not guaranteed to be accurate or set. In particular this
2323 # field isn't set for StreamingDetectIntent since the streaming endpoint has
2324 # separate confidence estimates per portion of the audio in
2325 # StreamingRecognitionResult.
2326 "webhookSource": "A String", # If the query was fulfilled by a webhook call, this field is set to the
2327 # value of the `source` field returned in the webhook response.
2328 "queryText": "A String", # The original conversational query text:
2329 #
2330 # - If natural language text was provided as input, `query_text` contains
2331 # a copy of the input.
2332 # - If natural language speech audio was provided as input, `query_text`
2333 # contains the speech recognition result. If speech recognizer produced
2334 # multiple alternatives, a particular one is picked.
2335 # - If automatic spell correction is enabled, `query_text` will contain the
2336 # corrected user input.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2337 "intent": { # Represents an intent. # The intent that matched the conversational query. Some, not
2338 # all fields are filled in this message, including but not limited to:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2339 # `name`, `display_name`, `end_interaction` and `is_fallback`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2340 # Intents convert a number of user expressions or patterns into an action. An
2341 # action is an extraction of a user command or sentence semantics.
2342 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
2343 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
2344 # Note: If `ml_disabled` setting is set to true, then this intent is not
2345 # taken into account during inference in `ML ONLY` match mode. Also,
2346 # auto-markup in the UI is turned off.
2347 "displayName": "A String", # Required. The name of this intent.
2348 "name": "A String", # The unique identifier of this intent.
2349 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2350 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2351 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2352 "parameters": [ # Optional. The collection of parameters associated with the intent.
2353 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2354 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2355 "name": "A String", # The unique identifier of this parameter.
2356 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
2357 # result.
2358 # Default values can be extracted from contexts by using the following
2359 # syntax: `#context_name.parameter_name`.
2360 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
2361 # describes values of the parameter. If the parameter is
2362 # required, this must be provided.
2363 "value": "A String", # Optional. The definition of the parameter value. It can be:
2364 # - a constant string,
2365 # - a parameter value defined as `$parameter_name`,
2366 # - an original parameter value defined as `$parameter_name.original`,
2367 # - a parameter value from some context defined as
2368 # `#context_name.parameter_name`.
2369 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2370 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2371 "A String",
2372 ],
2373 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2374 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
2375 # whether the intent cannot be completed without collecting the parameter
2376 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2377 },
2378 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2379 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
2380 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
2381 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2382 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
2383 # a direct or indirect parent. We populate this field only in the output.
2384 { # Represents a single followup intent in the chain.
2385 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2386 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2387 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2388 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2389 },
2390 ],
2391 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2392 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
2393 # chain of followup intents. You can set this field when creating an intent,
2394 # for example with CreateIntent or
2395 # BatchUpdateIntents, in order to make this
2396 # intent a followup intent.
2397 #
2398 # It identifies the parent followup intent.
2399 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2400 "messages": [ # Optional. The collection of rich messages corresponding to the
2401 # `Response` field in the Dialogflow console.
2402 { # Corresponds to the `Response` field in the Dialogflow console.
2403 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
2404 # This message in `QueryResult.fulfillment_messages` and
2405 # `WebhookResponse.fulfillment_messages` should contain only one
2406 # `SimpleResponse`.
2407 "simpleResponses": [ # Required. The list of simple responses.
2408 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2409 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
2410 # response to the user in the SSML format. Mutually exclusive with
2411 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2412 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
2413 # speech output. Mutually exclusive with ssml.
2414 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2415 },
2416 ],
2417 },
2418 "quickReplies": { # The quick replies response message. # Displays quick replies.
2419 "quickReplies": [ # Optional. The collection of quick replies.
2420 "A String",
2421 ],
2422 "title": "A String", # Optional. The title of the collection of quick replies.
2423 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2424 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
2425 #
2426 # RBM allows businesses to send enriched and branded versions of SMS. See
2427 # https://jibe.google.com/business-messaging.
2428 "text": "A String", # Required. Text sent and displayed to the user.
2429 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
2430 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
2431 # easily select/click a predefined response or perform an action (like
2432 # opening a web uri).
2433 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
2434 # can choose from the card.
2435 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
2436 # to send back to the agent (https://goo.gl/GXotJW).
2437 },
2438 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
2439 # (https://goo.gl/6GLJD2). If the user has an app installed that is
2440 # registered as the default handler for the URL, then this app will be
2441 # opened instead, and its icon will be used in the suggested action UI.
2442 "uri": "A String", # Required. The uri to open on the user device
2443 },
2444 "text": "A String", # Text to display alongside the action.
2445 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
2446 # but does not dial automatically (https://goo.gl/ergbB2).
2447 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
2448 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
2449 # format. An example of a correctly formatted phone number:
2450 # +15556767888.
2451 },
2452 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2453 # when the user taps the suggested action. This data will be also
2454 # forwarded to webhook to allow performing custom business logic.
2455 },
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 },
2464 ],
2465 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2466 "platform": "A String", # Optional. The platform that this message is intended for.
2467 "text": { # The text response message. # Returns a text response.
2468 "text": [ # Optional. The collection of the agent's responses.
2469 "A String",
2470 ],
2471 },
2472 "image": { # The image response message. # Displays an image.
2473 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2474 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2475 "imageUri": "A String", # Optional. The public URI to an image file.
2476 },
2477 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
2478 # Telephony Gateway.
2479 #
2480 # Telephony Gateway takes the synthesizer settings from
2481 # `DetectIntentResponse.output_audio_config` which can either be set
2482 # at request-level or can come from the agent-level synthesizer config.
2483 "ssml": "A String", # The SSML to be synthesized. For more information, see
2484 # [SSML](https://developers.google.com/actions/reference/ssml).
2485 "text": "A String", # The raw text to be synthesized.
2486 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2487 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
2488 #
2489 # Rich cards allow you to respond to users with more vivid content, e.g.
2490 # with media and suggestions.
2491 #
2492 # For more details about RBM rich cards, please see:
2493 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
2494 # If you want to show a single card with more control over the layout,
2495 # please use RbmStandaloneCard instead.
2496 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
2497 # 2 cards and at most 10.
2498 { # Rich Business Messaging (RBM) Card content
2499 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
2500 # be set. Media (image, GIF or a video) to include in the card.
2501 # The following media-types are currently supported:
2502 #
2503 # Image Types
2504 #
2505 # * image/jpeg
2506 # * image/jpg'
2507 # * image/gif
2508 # * image/png
2509 #
2510 # Video Types
2511 #
2512 # * video/h263
2513 # * video/m4v
2514 # * video/mp4
2515 # * video/mpeg
2516 # * video/mpeg4
2517 # * video/webm
2518 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
2519 # determines the MIME type of the file from the content-type field in
2520 # the HTTP headers when the platform fetches the file. The content-type
2521 # field must be present and accurate in the HTTP response from the URL.
2522 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
2523 # provide a thumbnail URI, the RBM platform displays a blank
2524 # placeholder thumbnail until the user's device downloads the file.
2525 # Depending on the user's setting, the file may not download
2526 # automatically and may require the user to tap a download button.
2527 "height": "A String", # Required for cards with vertical orientation. The height of the media
2528 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
2529 # For a standalone card with horizontal layout, height is not
2530 # customizable, and this field is ignored.
2531 },
2532 "suggestions": [ # Optional. List of suggestions to include in the card.
2533 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
2534 # easily select/click a predefined response or perform an action (like
2535 # opening a web uri).
2536 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
2537 # can choose from the card.
2538 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
2539 # to send back to the agent (https://goo.gl/GXotJW).
2540 },
2541 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
2542 # (https://goo.gl/6GLJD2). If the user has an app installed that is
2543 # registered as the default handler for the URL, then this app will be
2544 # opened instead, and its icon will be used in the suggested action UI.
2545 "uri": "A String", # Required. The uri to open on the user device
2546 },
2547 "text": "A String", # Text to display alongside the action.
2548 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
2549 # but does not dial automatically (https://goo.gl/ergbB2).
2550 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
2551 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
2552 # format. An example of a correctly formatted phone number:
2553 # +15556767888.
2554 },
2555 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2556 # when the user taps the suggested action. This data will be also
2557 # forwarded to webhook to allow performing custom business logic.
2558 },
2559 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
2560 # instead of typing in their own response.
2561 "text": "A String", # Suggested reply text.
2562 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2563 # when the user taps the suggested reply. This data will be also
2564 # forwarded to webhook to allow performing custom business logic.
2565 },
2566 },
2567 ],
2568 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
2569 #
2570 # At least one of the title, description or media must be set.
2571 "title": "A String", # Optional. Title of the card (at most 200 bytes).
2572 #
2573 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2574 },
2575 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2576 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2577 },
2578 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
2579 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
2580 # play, e.g., "gs://bucket/object". The object must contain a single
2581 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
2582 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2583 # This object must be readable by the `service-&lt;Project
2584 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
2585 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2586 # (usually the same as the Dialogflow agent project). If the Google Cloud
2587 # Storage bucket is in the Telephony Gateway project, this permission is
2588 # added by default when enabling the Dialogflow V2 API.
2589 #
2590 # For audio from other sources, consider using the
2591 # `TelephonySynthesizeSpeech` message with SSML.
2592 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2593 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
2594 #
2595 # Rich cards allow you to respond to users with more vivid content, e.g.
2596 # with media and suggestions.
2597 #
2598 # For more details about RBM rich cards, please see:
2599 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
2600 # You can group multiple rich cards into one using RbmCarouselCard but
2601 # carousel cards will give you less control over the card layout.
2602 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
2603 # Image preview alignment for standalone cards with horizontal layout.
2604 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
2605 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
2606 # be set. Media (image, GIF or a video) to include in the card.
2607 # The following media-types are currently supported:
2608 #
2609 # Image Types
2610 #
2611 # * image/jpeg
2612 # * image/jpg'
2613 # * image/gif
2614 # * image/png
2615 #
2616 # Video Types
2617 #
2618 # * video/h263
2619 # * video/m4v
2620 # * video/mp4
2621 # * video/mpeg
2622 # * video/mpeg4
2623 # * video/webm
2624 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
2625 # determines the MIME type of the file from the content-type field in
2626 # the HTTP headers when the platform fetches the file. The content-type
2627 # field must be present and accurate in the HTTP response from the URL.
2628 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
2629 # provide a thumbnail URI, the RBM platform displays a blank
2630 # placeholder thumbnail until the user's device downloads the file.
2631 # Depending on the user's setting, the file may not download
2632 # automatically and may require the user to tap a download button.
2633 "height": "A String", # Required for cards with vertical orientation. The height of the media
2634 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
2635 # For a standalone card with horizontal layout, height is not
2636 # customizable, and this field is ignored.
2637 },
2638 "suggestions": [ # Optional. List of suggestions to include in the card.
2639 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
2640 # easily select/click a predefined response or perform an action (like
2641 # opening a web uri).
2642 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
2643 # can choose from the card.
2644 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
2645 # to send back to the agent (https://goo.gl/GXotJW).
2646 },
2647 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
2648 # (https://goo.gl/6GLJD2). If the user has an app installed that is
2649 # registered as the default handler for the URL, then this app will be
2650 # opened instead, and its icon will be used in the suggested action UI.
2651 "uri": "A String", # Required. The uri to open on the user device
2652 },
2653 "text": "A String", # Text to display alongside the action.
2654 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
2655 # but does not dial automatically (https://goo.gl/ergbB2).
2656 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
2657 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
2658 # format. An example of a correctly formatted phone number:
2659 # +15556767888.
2660 },
2661 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2662 # when the user taps the suggested action. This data will be also
2663 # forwarded to webhook to allow performing custom business logic.
2664 },
2665 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
2666 # instead of typing in their own response.
2667 "text": "A String", # Suggested reply text.
2668 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2669 # when the user taps the suggested reply. This data will be also
2670 # forwarded to webhook to allow performing custom business logic.
2671 },
2672 },
2673 ],
2674 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
2675 #
2676 # At least one of the title, description or media must be set.
2677 "title": "A String", # Optional. Title of the card (at most 200 bytes).
2678 #
2679 # At least one of the title, description or media must be set.
2680 },
2681 "cardOrientation": "A String", # Required. Orientation of the card.
2682 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2683 "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.
2684 # or website associated with this agent.
2685 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
2686 # suggestion chip.
2687 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
2688 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2689 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
2690 # https://developers.google.com/actions/assistant/responses#browsing_carousel
2691 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
2692 # items, maximum of ten.
2693 { # Browsing carousel tile
2694 "image": { # The image response message. # Optional. Hero image for the carousel item.
2695 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2696 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2697 "imageUri": "A String", # Optional. The public URI to an image file.
2698 },
2699 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
2700 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
2701 # text.
2702 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
2703 "url": "A String", # Required. URL
2704 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
2705 # the URL. Defaults to opening via web browser.
2706 },
2707 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
2708 # Card. Maximum of one line of text.
2709 },
2710 ],
2711 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
2712 # items.
2713 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2714 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
2715 "buttons": [ # Optional. The collection of card buttons.
2716 { # The button object that appears at the bottom of a card.
2717 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2718 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2719 },
2720 "title": "A String", # Required. The title of the button.
2721 },
2722 ],
2723 "formattedText": "A String", # Required, unless image is present. The body text of the card.
2724 "image": { # The image response message. # Optional. The image for the card.
2725 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2726 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2727 "imageUri": "A String", # Optional. The public URI to an image file.
2728 },
2729 "subtitle": "A String", # Optional. The subtitle of the card.
2730 "title": "A String", # Optional. The title of the card.
2731 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2732 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
2733 "mediaObjects": [ # Required. List of media objects.
2734 { # Response media object for media content card.
2735 "contentUrl": "A String", # Required. Url where the media is stored.
2736 "description": "A String", # Optional. Description of media card.
2737 "name": "A String", # Required. Name of media card.
2738 "largeImage": { # The image response message. # Optional. Image to display above media content.
2739 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2740 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2741 "imageUri": "A String", # Optional. The public URI to an image file.
2742 },
2743 "icon": { # The image response message. # Optional. Icon to display above media content.
2744 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2745 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2746 "imageUri": "A String", # Optional. The public URI to an image file.
2747 },
2748 },
2749 ],
2750 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
2751 },
2752 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
2753 "rows": [ # Optional. Rows in this table of data.
2754 { # Row of TableCard.
2755 "cells": [ # Optional. List of cells that make up this row.
2756 { # Cell of TableCardRow.
2757 "text": "A String", # Required. Text in this cell.
2758 },
2759 ],
2760 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
2761 },
2762 ],
2763 "subtitle": "A String", # Optional. Subtitle to the title.
2764 "title": "A String", # Required. Title of the card.
2765 "image": { # The image response message. # Optional. Image which should be displayed on the card.
2766 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2767 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2768 "imageUri": "A String", # Optional. The public URI to an image file.
2769 },
2770 "columnProperties": [ # Optional. Display properties for the columns in this table.
2771 { # Column properties for TableCard.
2772 "header": "A String", # Required. Column heading.
2773 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
2774 },
2775 ],
2776 "buttons": [ # Optional. List of buttons for the card.
2777 { # The button object that appears at the bottom of a card.
2778 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2779 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2780 },
2781 "title": "A String", # Required. The title of the button.
2782 },
2783 ],
2784 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2785 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
2786 "items": [ # Required. Carousel items.
2787 { # An item in the carousel.
2788 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2789 # dialog.
2790 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2791 # item in dialog.
2792 "A String",
2793 ],
2794 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2795 # response is given.
2796 },
2797 "image": { # The image response message. # Optional. The image to display.
2798 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2799 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2800 "imageUri": "A String", # Optional. The public URI to an image file.
2801 },
2802 "description": "A String", # Optional. The body text of the card.
2803 "title": "A String", # Required. Title of the carousel item.
2804 },
2805 ],
2806 },
2807 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
2808 "items": [ # Required. List items.
2809 { # An item in the list.
2810 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
2811 # dialog.
2812 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2813 # item in dialog.
2814 "A String",
2815 ],
2816 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2817 # response is given.
2818 },
2819 "image": { # The image response message. # Optional. The image to display.
2820 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2821 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2822 "imageUri": "A String", # Optional. The public URI to an image file.
2823 },
2824 "description": "A String", # Optional. The main text describing the item.
2825 "title": "A String", # Required. The title of the list item.
2826 },
2827 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2828 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2829 "title": "A String", # Optional. The overall title of the list.
2830 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2831 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
2832 "suggestions": [ # Required. The list of suggested replies.
2833 { # The suggestion chip message that the user can tap to quickly post a reply
2834 # to the conversation.
2835 "title": "A String", # Required. The text shown the in the suggestion chip.
2836 },
2837 ],
2838 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2839 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
2840 "phoneNumber": "A String", # Required. The phone number to transfer the call to
2841 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
2842 #
2843 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
2844 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2845 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2846 "a_key": "", # Properties of the object.
2847 },
2848 "card": { # The card response message. # Displays a card.
2849 "buttons": [ # Optional. The collection of card buttons.
2850 { # Optional. Contains information about a button.
2851 "text": "A String", # Optional. The text to show on the button.
2852 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
2853 # open.
2854 },
2855 ],
2856 "title": "A String", # Optional. The title of the card.
2857 "subtitle": "A String", # Optional. The subtitle of the card.
2858 "imageUri": "A String", # Optional. The public URI to an image file for the card.
2859 },
2860 },
2861 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2862 "trainingPhrases": [ # Optional. The collection of examples that the agent is
2863 # trained on.
2864 { # Represents an example that the agent is trained on.
2865 "parts": [ # Required. The ordered list of training phrase parts.
2866 # The parts are concatenated in order to form the training phrase.
2867 #
2868 # Note: The API does not automatically annotate training phrases like the
2869 # Dialogflow Console does.
2870 #
2871 # Note: Do not forget to include whitespace at part boundaries,
2872 # so the training phrase is well formatted when the parts are concatenated.
2873 #
2874 # If the training phrase does not need to be annotated with parameters,
2875 # you just need a single part with only the Part.text field set.
2876 #
2877 # If you want to annotate the training phrase, you must create multiple
2878 # parts, where the fields of each part are populated in one of two ways:
2879 #
2880 # - `Part.text` is set to a part of the phrase that has no parameters.
2881 # - `Part.text` is set to a part of the phrase that you want to annotate,
2882 # and the `entity_type`, `alias`, and `user_defined` fields are all
2883 # set.
2884 { # Represents a part of a training phrase.
2885 "alias": "A String", # Optional. The parameter name for the value extracted from the
2886 # annotated part of the example.
2887 # This field is required for annotated parts of the training phrase.
2888 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
2889 # This field is required for annotated parts of the training phrase.
2890 "text": "A String", # Required. The text for this part.
2891 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
2892 # This field is set to true when the Dialogflow Console is used to
2893 # manually annotate the part. When creating an annotated part with the
2894 # API, you must set this to true.
2895 },
2896 ],
2897 "type": "A String", # Required. The type of the training phrase.
2898 "name": "A String", # Output only. The unique identifier of this training phrase.
2899 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
2900 # the intent. Each time a developer adds an existing sample by editing an
2901 # intent or training, this counter is increased.
2902 },
2903 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2904 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
2905 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
2906 "A String",
2907 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2908 "priority": 42, # The priority of this intent. Higher numbers represent higher
2909 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2910 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2911 # - If the supplied value is unspecified or 0, the service
2912 # translates the value to 500,000, which corresponds to the
2913 # `Normal` priority in the console.
2914 # - If the supplied value is negative, the intent is ignored
2915 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2916 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
2917 # followup intents. It identifies the correct followup intents chain for
2918 # this intent. We populate this field only in the output.
2919 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2920 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
2921 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
2922 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2923 "inputContextNames": [ # Optional. The list of context names required for this intent to be
2924 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2925 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2926 "A String",
2927 ],
2928 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
2929 # Note: If `ml_enabled` setting is set to false, then this intent is not
2930 # taken into account during inference in `ML ONLY` match mode. Also,
2931 # auto-markup in the UI is turned off.
2932 # DEPRECATED! Please use `ml_disabled` field instead.
2933 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
2934 # then the default value is determined as follows:
2935 # - Before April 15th, 2018 the default is:
2936 # ml_enabled = false / ml_disabled = true.
2937 # - After April 15th, 2018 the default is:
2938 # ml_enabled = true / ml_disabled = false.
2939 "action": "A String", # Optional. The name of the action associated with the intent.
2940 # Note: The action name must not contain whitespaces.
2941 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
2942 # is matched. Context messages in this collection should not set the
2943 # parameters field. Setting the `lifespan_count` to 0 will reset the context
2944 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2945 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2946 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2947 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2948 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
2949 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
2950 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2951 #
2952 # The `Context ID` is always converted to lowercase, may only contain
2953 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
2954 #
2955 # If `Environment ID` is not specified, we assume default 'draft'
2956 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2957 #
2958 # The following context names are reserved for internal use by Dialogflow.
2959 # You should not use these contexts or create contexts with these names:
2960 #
2961 # * `__system_counters__`
2962 # * `*_id_dialog_context`
2963 # * `*_dialog_params_size`
2964 "parameters": { # Optional. The collection of parameters associated with this context.
2965 #
2966 # Depending on your protocol or client library language, this is a
2967 # map, associative array, symbol table, dictionary, or JSON object
2968 # composed of a collection of (MapKey, MapValue) pairs:
2969 #
2970 # - MapKey type: string
2971 # - MapKey value: parameter name
2972 # - MapValue type:
2973 # - If parameter's entity type is a composite entity: map
2974 # - Else: string or number, depending on parameter value type
2975 # - MapValue value:
2976 # - If parameter's entity type is a composite entity:
2977 # map from composite entity property names to property values
2978 # - Else: parameter value
2979 "a_key": "", # Properties of the object.
2980 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2981 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2982 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2983 # immediately. Contexts expire automatically after 20 minutes if there
2984 # are no matching queries.
2985 },
2986 ],
2987 "events": [ # Optional. The collection of event names that trigger the intent.
2988 # If the collection of input contexts is not empty, all of the contexts must
2989 # be present in the active user session for an event to trigger this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2990 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2991 "A String",
2992 ],
2993 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2994 "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0
2995 # (completely uncertain) to 1.0 (completely certain).
2996 # This value is for informational purpose only and is only used to
2997 # help match the best intent within the classification threshold.
2998 # This value may change for the same end-user expression at any time due to a
2999 # model retraining or change in implementation.
3000 # If there are `multiple knowledge_answers` messages, this value is set to
3001 # the greatest `knowledgeAnswers.match_confidence` value in the list.
3002 "diagnosticInfo": { # Free-form diagnostic information for the associated detect intent request.
3003 # The fields of this data can change without notice, so you should not write
3004 # code that depends on its structure.
3005 # The data may contain:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3006 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3007 # - webhook call latency
3008 # - webhook errors
3009 "a_key": "", # Properties of the object.
3010 },
3011 "action": "A String", # The action name from the matched intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3012 "outputContexts": [ # The collection of output contexts. If applicable,
3013 # `output_contexts.parameters` contains entries with name
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3014 # `&lt;parameter name&gt;.original` containing the original parameter values
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3015 # before the query.
3016 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3017 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3018 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
3019 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
3020 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3021 #
3022 # The `Context ID` is always converted to lowercase, may only contain
3023 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
3024 #
3025 # If `Environment ID` is not specified, we assume default 'draft'
3026 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3027 #
3028 # The following context names are reserved for internal use by Dialogflow.
3029 # You should not use these contexts or create contexts with these names:
3030 #
3031 # * `__system_counters__`
3032 # * `*_id_dialog_context`
3033 # * `*_dialog_params_size`
3034 "parameters": { # Optional. The collection of parameters associated with this context.
3035 #
3036 # Depending on your protocol or client library language, this is a
3037 # map, associative array, symbol table, dictionary, or JSON object
3038 # composed of a collection of (MapKey, MapValue) pairs:
3039 #
3040 # - MapKey type: string
3041 # - MapKey value: parameter name
3042 # - MapValue type:
3043 # - If parameter's entity type is a composite entity: map
3044 # - Else: string or number, depending on parameter value type
3045 # - MapValue value:
3046 # - If parameter's entity type is a composite entity:
3047 # map from composite entity property names to property values
3048 # - Else: parameter value
3049 "a_key": "", # Properties of the object.
3050 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3051 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3052 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3053 # immediately. Contexts expire automatically after 20 minutes if there
3054 # are no matching queries.
3055 },
3056 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3057 "allRequiredParamsPresent": True or False, # This field is set to:
3058 #
3059 # - `false` if the matched intent has required parameters and not all of
3060 # the required parameter values have been collected.
3061 # - `true` if all required parameter values have been collected, or if the
3062 # matched intent doesn't contain any required parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3063 "sentimentAnalysisResult": { # The result of sentiment analysis as configured by # The sentiment analysis result, which depends on the
3064 # `sentiment_analysis_request_config` specified in the request.
3065 # `sentiment_analysis_request_config`.
3066 "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit # The sentiment analysis result for `query_text`.
3067 # of analysis, such as the query text.
3068 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
3069 # sentiment).
3070 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute
3071 # magnitude of sentiment, regardless of score (positive or negative).
3072 },
3073 },
3074 "knowledgeAnswers": { # Represents the result of querying a Knowledge base. # The result from Knowledge Connector (if any), ordered by decreasing
3075 # `KnowledgeAnswers.match_confidence`.
3076 "answers": [ # A list of answers from Knowledge Connector.
3077 { # An answer from Knowledge Connector.
3078 "matchConfidence": 3.14, # The system's confidence score that this Knowledge answer is a good match
3079 # for this conversational query.
3080 # The range is from 0.0 (completely uncertain) to 1.0 (completely certain).
3081 # Note: The confidence score is likely to vary somewhat (possibly even for
3082 # identical requests), as the underlying model is under constant
3083 # improvement. It may be deprecated in the future. We recommend using
3084 # `match_confidence_level` which should be generally more stable.
3085 "source": "A String", # Indicates which Knowledge Document this answer was extracted from.
3086 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
3087 # ID&gt;/documents/&lt;Document ID&gt;`.
3088 "matchConfidenceLevel": "A String", # The system's confidence level that this knowledge answer is a good match
3089 # for this conversational query.
3090 # NOTE: The confidence level for a given `&lt;query, answer&gt;` pair may change
3091 # without notice, as it depends on models that are constantly being
3092 # improved. However, it will change less frequently than the confidence
3093 # score below, and should be preferred for referencing the quality of an
3094 # answer.
3095 "answer": "A String", # The piece of text from the `source` knowledge base document that answers
3096 # this conversational query.
3097 "faqQuestion": "A String", # The corresponding FAQ question if the answer was extracted from a FAQ
3098 # Document, empty otherwise.
3099 },
3100 ],
3101 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3102 },
3103 ],
3104 "webhookStatus": { # The `Status` type defines a logical error model that is suitable for # Specifies the status of the webhook request.
3105 # different programming environments, including REST APIs and RPC APIs. It is
3106 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3107 # three pieces of data: error code, error message, and error details.
3108 #
3109 # You can find out more about this error model and how to work with it in the
3110 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3111 "message": "A String", # A developer-facing error message, which should be in English. Any
3112 # user-facing error message should be localized and sent in the
3113 # google.rpc.Status.details field, or localized by the client.
3114 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
3115 "details": [ # A list of messages that carry the error details. There is a common set of
3116 # message types for APIs to use.
3117 {
3118 "a_key": "", # Properties of the object. Contains field @type with type URL.
3119 },
3120 ],
3121 },
3122 }</pre>
3123</div>
3124
3125</body></html>