Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dialogflow_v2beta1.projects.agent.intents.html
blob: 934b3fbd3eed03d08ee23568c747a6ad57c7ee9e [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.intents.html">intents</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Deletes intents in the specified agent.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Updates/Creates multiple intents in the specified agent.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Creates an intent in the specified agent.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Deletes the specified intent and its direct or indirect followup intents.</p>
89<p class="toc_element">
90 <code><a href="#get">get(name, languageCode=None, intentView=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Retrieves the specified intent.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#list">list(parent, languageCode=None, pageSize=None, intentView=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Returns the list of all intents in the specified agent.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#patch">patch(name, body=None, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Updates the specified intent.</p>
101<h3>Method Details</h3>
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 <pre>Deletes intents in the specified agent.
105
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]106Operation &lt;response: google.protobuf.Empty&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107
108Args:
109 parent: string, Required. The name of the agent to delete all entities types for. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110`projects/&lt;Project ID&gt;/agent`. (required)
111 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 The object takes the form of:
113
114{ # The request message for Intents.BatchDeleteIntents.
115 "intents": [ # Required. The collection of intents to delete. Only intent `name` must be
116 # filled in.
117 { # Represents an intent.
118 # Intents convert a number of user expressions or patterns into an action. An
119 # action is an extraction of a user command or sentence semantics.
120 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
121 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
122 # Note: If `ml_disabled` setting is set to true, then this intent is not
123 # taken into account during inference in `ML ONLY` match mode. Also,
124 # auto-markup in the UI is turned off.
125 "displayName": "A String", # Required. The name of this intent.
126 "name": "A String", # The unique identifier of this intent.
127 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
128 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 "parameters": [ # Optional. The collection of parameters associated with the intent.
131 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 "name": "A String", # The unique identifier of this parameter.
134 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
135 # result.
136 # Default values can be extracted from contexts by using the following
137 # syntax: `#context_name.parameter_name`.
138 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
139 # describes values of the parameter. If the parameter is
140 # required, this must be provided.
141 "value": "A String", # Optional. The definition of the parameter value. It can be:
142 # - a constant string,
143 # - a parameter value defined as `$parameter_name`,
144 # - an original parameter value defined as `$parameter_name.original`,
145 # - a parameter value from some context defined as
146 # `#context_name.parameter_name`.
147 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 "A String",
150 ],
151 "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^]152 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
153 # whether the intent cannot be completed without collecting the parameter
154 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 },
156 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
158 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
159 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
161 # a direct or indirect parent. We populate this field only in the output.
162 { # Represents a single followup intent in the chain.
163 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]164 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]166 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 },
168 ],
169 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]170 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
171 # chain of followup intents. You can set this field when creating an intent,
172 # for example with CreateIntent or
173 # BatchUpdateIntents, in order to make this
174 # intent a followup intent.
175 #
176 # It identifies the parent followup intent.
177 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 "messages": [ # Optional. The collection of rich messages corresponding to the
179 # `Response` field in the Dialogflow console.
180 { # Corresponds to the `Response` field in the Dialogflow console.
181 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
182 # This message in `QueryResult.fulfillment_messages` and
183 # `WebhookResponse.fulfillment_messages` should contain only one
184 # `SimpleResponse`.
185 "simpleResponses": [ # Required. The list of simple responses.
186 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
188 # response to the user in the SSML format. Mutually exclusive with
189 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]190 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
191 # speech output. Mutually exclusive with ssml.
192 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 },
194 ],
195 },
196 "quickReplies": { # The quick replies response message. # Displays quick replies.
197 "quickReplies": [ # Optional. The collection of quick replies.
198 "A String",
199 ],
200 "title": "A String", # Optional. The title of the collection of quick replies.
201 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]202 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
203 #
204 # RBM allows businesses to send enriched and branded versions of SMS. See
205 # https://jibe.google.com/business-messaging.
206 "text": "A String", # Required. Text sent and displayed to the user.
207 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
208 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
209 # easily select/click a predefined response or perform an action (like
210 # opening a web uri).
211 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
212 # can choose from the card.
213 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
214 # to send back to the agent (https://goo.gl/GXotJW).
215 },
216 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
217 # (https://goo.gl/6GLJD2). If the user has an app installed that is
218 # registered as the default handler for the URL, then this app will be
219 # opened instead, and its icon will be used in the suggested action UI.
220 "uri": "A String", # Required. The uri to open on the user device
221 },
222 "text": "A String", # Text to display alongside the action.
223 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
224 # but does not dial automatically (https://goo.gl/ergbB2).
225 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
226 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
227 # format. An example of a correctly formatted phone number:
228 # +15556767888.
229 },
230 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
231 # when the user taps the suggested action. This data will be also
232 # forwarded to webhook to allow performing custom business logic.
233 },
234 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
235 # instead of typing in their own response.
236 "text": "A String", # Suggested reply text.
237 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
238 # when the user taps the suggested reply. This data will be also
239 # forwarded to webhook to allow performing custom business logic.
240 },
241 },
242 ],
243 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 "platform": "A String", # Optional. The platform that this message is intended for.
245 "text": { # The text response message. # Returns a text response.
246 "text": [ # Optional. The collection of the agent's responses.
247 "A String",
248 ],
249 },
250 "image": { # The image response message. # Displays an image.
251 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
252 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
253 "imageUri": "A String", # Optional. The public URI to an image file.
254 },
255 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
256 # Telephony Gateway.
257 #
258 # Telephony Gateway takes the synthesizer settings from
259 # `DetectIntentResponse.output_audio_config` which can either be set
260 # at request-level or can come from the agent-level synthesizer config.
261 "ssml": "A String", # The SSML to be synthesized. For more information, see
262 # [SSML](https://developers.google.com/actions/reference/ssml).
263 "text": "A String", # The raw text to be synthesized.
264 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]265 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
266 #
267 # Rich cards allow you to respond to users with more vivid content, e.g.
268 # with media and suggestions.
269 #
270 # For more details about RBM rich cards, please see:
271 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
272 # If you want to show a single card with more control over the layout,
273 # please use RbmStandaloneCard instead.
274 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
275 # 2 cards and at most 10.
276 { # Rich Business Messaging (RBM) Card content
277 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
278 # be set. Media (image, GIF or a video) to include in the card.
279 # The following media-types are currently supported:
280 #
281 # Image Types
282 #
283 # * image/jpeg
284 # * image/jpg'
285 # * image/gif
286 # * image/png
287 #
288 # Video Types
289 #
290 # * video/h263
291 # * video/m4v
292 # * video/mp4
293 # * video/mpeg
294 # * video/mpeg4
295 # * video/webm
296 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
297 # determines the MIME type of the file from the content-type field in
298 # the HTTP headers when the platform fetches the file. The content-type
299 # field must be present and accurate in the HTTP response from the URL.
300 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
301 # provide a thumbnail URI, the RBM platform displays a blank
302 # placeholder thumbnail until the user's device downloads the file.
303 # Depending on the user's setting, the file may not download
304 # automatically and may require the user to tap a download button.
305 "height": "A String", # Required for cards with vertical orientation. The height of the media
306 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
307 # For a standalone card with horizontal layout, height is not
308 # customizable, and this field is ignored.
309 },
310 "suggestions": [ # Optional. List of suggestions to include in the card.
311 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
312 # easily select/click a predefined response or perform an action (like
313 # opening a web uri).
314 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
315 # can choose from the card.
316 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
317 # to send back to the agent (https://goo.gl/GXotJW).
318 },
319 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
320 # (https://goo.gl/6GLJD2). If the user has an app installed that is
321 # registered as the default handler for the URL, then this app will be
322 # opened instead, and its icon will be used in the suggested action UI.
323 "uri": "A String", # Required. The uri to open on the user device
324 },
325 "text": "A String", # Text to display alongside the action.
326 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
327 # but does not dial automatically (https://goo.gl/ergbB2).
328 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
329 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
330 # format. An example of a correctly formatted phone number:
331 # +15556767888.
332 },
333 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
334 # when the user taps the suggested action. This data will be also
335 # forwarded to webhook to allow performing custom business logic.
336 },
337 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
338 # instead of typing in their own response.
339 "text": "A String", # Suggested reply text.
340 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
341 # when the user taps the suggested reply. This data will be also
342 # forwarded to webhook to allow performing custom business logic.
343 },
344 },
345 ],
346 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
347 #
348 # At least one of the title, description or media must be set.
349 "title": "A String", # Optional. Title of the card (at most 200 bytes).
350 #
351 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]352 },
353 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 },
356 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
357 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
358 # play, e.g., "gs://bucket/object". The object must contain a single
359 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
360 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]361 # This object must be readable by the `service-&lt;Project
362 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
363 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364 # (usually the same as the Dialogflow agent project). If the Google Cloud
365 # Storage bucket is in the Telephony Gateway project, this permission is
366 # added by default when enabling the Dialogflow V2 API.
367 #
368 # For audio from other sources, consider using the
369 # `TelephonySynthesizeSpeech` message with SSML.
370 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]371 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
372 #
373 # Rich cards allow you to respond to users with more vivid content, e.g.
374 # with media and suggestions.
375 #
376 # For more details about RBM rich cards, please see:
377 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
378 # You can group multiple rich cards into one using RbmCarouselCard but
379 # carousel cards will give you less control over the card layout.
380 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
381 # Image preview alignment for standalone cards with horizontal layout.
382 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
383 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
384 # be set. Media (image, GIF or a video) to include in the card.
385 # The following media-types are currently supported:
386 #
387 # Image Types
388 #
389 # * image/jpeg
390 # * image/jpg'
391 # * image/gif
392 # * image/png
393 #
394 # Video Types
395 #
396 # * video/h263
397 # * video/m4v
398 # * video/mp4
399 # * video/mpeg
400 # * video/mpeg4
401 # * video/webm
402 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
403 # determines the MIME type of the file from the content-type field in
404 # the HTTP headers when the platform fetches the file. The content-type
405 # field must be present and accurate in the HTTP response from the URL.
406 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
407 # provide a thumbnail URI, the RBM platform displays a blank
408 # placeholder thumbnail until the user's device downloads the file.
409 # Depending on the user's setting, the file may not download
410 # automatically and may require the user to tap a download button.
411 "height": "A String", # Required for cards with vertical orientation. The height of the media
412 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
413 # For a standalone card with horizontal layout, height is not
414 # customizable, and this field is ignored.
415 },
416 "suggestions": [ # Optional. List of suggestions to include in the card.
417 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
418 # easily select/click a predefined response or perform an action (like
419 # opening a web uri).
420 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
421 # can choose from the card.
422 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
423 # to send back to the agent (https://goo.gl/GXotJW).
424 },
425 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
426 # (https://goo.gl/6GLJD2). If the user has an app installed that is
427 # registered as the default handler for the URL, then this app will be
428 # opened instead, and its icon will be used in the suggested action UI.
429 "uri": "A String", # Required. The uri to open on the user device
430 },
431 "text": "A String", # Text to display alongside the action.
432 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
433 # but does not dial automatically (https://goo.gl/ergbB2).
434 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
435 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
436 # format. An example of a correctly formatted phone number:
437 # +15556767888.
438 },
439 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
440 # when the user taps the suggested action. This data will be also
441 # forwarded to webhook to allow performing custom business logic.
442 },
443 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
444 # instead of typing in their own response.
445 "text": "A String", # Suggested reply text.
446 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
447 # when the user taps the suggested reply. This data will be also
448 # forwarded to webhook to allow performing custom business logic.
449 },
450 },
451 ],
452 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
453 #
454 # At least one of the title, description or media must be set.
455 "title": "A String", # Optional. Title of the card (at most 200 bytes).
456 #
457 # At least one of the title, description or media must be set.
458 },
459 "cardOrientation": "A String", # Required. Orientation of the card.
460 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]461 "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.
462 # or website associated with this agent.
463 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
464 # suggestion chip.
465 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
466 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]467 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
468 # https://developers.google.com/actions/assistant/responses#browsing_carousel
469 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
470 # items, maximum of ten.
471 { # Browsing carousel tile
472 "image": { # The image response message. # Optional. Hero image for the carousel item.
473 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
474 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
475 "imageUri": "A String", # Optional. The public URI to an image file.
476 },
477 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
478 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
479 # text.
480 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
481 "url": "A String", # Required. URL
482 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
483 # the URL. Defaults to opening via web browser.
484 },
485 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
486 # Card. Maximum of one line of text.
487 },
488 ],
489 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
490 # items.
491 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
493 "buttons": [ # Optional. The collection of card buttons.
494 { # The button object that appears at the bottom of a card.
495 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
496 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
497 },
498 "title": "A String", # Required. The title of the button.
499 },
500 ],
501 "formattedText": "A String", # Required, unless image is present. The body text of the card.
502 "image": { # The image response message. # Optional. The image for the card.
503 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
504 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
505 "imageUri": "A String", # Optional. The public URI to an image file.
506 },
507 "subtitle": "A String", # Optional. The subtitle of the card.
508 "title": "A String", # Optional. The title of the card.
509 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]510 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
511 "mediaObjects": [ # Required. List of media objects.
512 { # Response media object for media content card.
513 "contentUrl": "A String", # Required. Url where the media is stored.
514 "description": "A String", # Optional. Description of media card.
515 "name": "A String", # Required. Name of media card.
516 "largeImage": { # The image response message. # Optional. Image to display above media content.
517 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
518 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
519 "imageUri": "A String", # Optional. The public URI to an image file.
520 },
521 "icon": { # The image response message. # Optional. Icon to display above media content.
522 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
523 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
524 "imageUri": "A String", # Optional. The public URI to an image file.
525 },
526 },
527 ],
528 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
529 },
530 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
531 "rows": [ # Optional. Rows in this table of data.
532 { # Row of TableCard.
533 "cells": [ # Optional. List of cells that make up this row.
534 { # Cell of TableCardRow.
535 "text": "A String", # Required. Text in this cell.
536 },
537 ],
538 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
539 },
540 ],
541 "subtitle": "A String", # Optional. Subtitle to the title.
542 "title": "A String", # Required. Title of the card.
543 "image": { # The image response message. # Optional. Image which should be displayed on the card.
544 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
545 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
546 "imageUri": "A String", # Optional. The public URI to an image file.
547 },
548 "columnProperties": [ # Optional. Display properties for the columns in this table.
549 { # Column properties for TableCard.
550 "header": "A String", # Required. Column heading.
551 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
552 },
553 ],
554 "buttons": [ # Optional. List of buttons for the card.
555 { # The button object that appears at the bottom of a card.
556 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
557 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
558 },
559 "title": "A String", # Required. The title of the button.
560 },
561 ],
562 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]563 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
564 "items": [ # Required. Carousel items.
565 { # An item in the carousel.
566 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
567 # dialog.
568 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
569 # item in dialog.
570 "A String",
571 ],
572 "key": "A String", # Required. A unique key that will be sent back to the agent if this
573 # response is given.
574 },
575 "image": { # The image response message. # Optional. The image to display.
576 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
577 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
578 "imageUri": "A String", # Optional. The public URI to an image file.
579 },
580 "description": "A String", # Optional. The body text of the card.
581 "title": "A String", # Required. Title of the carousel item.
582 },
583 ],
584 },
585 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
586 "items": [ # Required. List items.
587 { # An item in the list.
588 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
589 # dialog.
590 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
591 # item in dialog.
592 "A String",
593 ],
594 "key": "A String", # Required. A unique key that will be sent back to the agent if this
595 # response is given.
596 },
597 "image": { # The image response message. # Optional. The image to display.
598 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
599 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
600 "imageUri": "A String", # Optional. The public URI to an image file.
601 },
602 "description": "A String", # Optional. The main text describing the item.
603 "title": "A String", # Required. The title of the list item.
604 },
605 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]606 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]607 "title": "A String", # Optional. The overall title of the list.
608 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]609 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
610 "suggestions": [ # Required. The list of suggested replies.
611 { # The suggestion chip message that the user can tap to quickly post a reply
612 # to the conversation.
613 "title": "A String", # Required. The text shown the in the suggestion chip.
614 },
615 ],
616 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]617 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
618 "phoneNumber": "A String", # Required. The phone number to transfer the call to
619 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
620 #
621 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
622 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]623 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]624 "a_key": "", # Properties of the object.
625 },
626 "card": { # The card response message. # Displays a card.
627 "buttons": [ # Optional. The collection of card buttons.
628 { # Optional. Contains information about a button.
629 "text": "A String", # Optional. The text to show on the button.
630 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
631 # open.
632 },
633 ],
634 "title": "A String", # Optional. The title of the card.
635 "subtitle": "A String", # Optional. The subtitle of the card.
636 "imageUri": "A String", # Optional. The public URI to an image file for the card.
637 },
638 },
639 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]640 "trainingPhrases": [ # Optional. The collection of examples that the agent is
641 # trained on.
642 { # Represents an example that the agent is trained on.
643 "parts": [ # Required. The ordered list of training phrase parts.
644 # The parts are concatenated in order to form the training phrase.
645 #
646 # Note: The API does not automatically annotate training phrases like the
647 # Dialogflow Console does.
648 #
649 # Note: Do not forget to include whitespace at part boundaries,
650 # so the training phrase is well formatted when the parts are concatenated.
651 #
652 # If the training phrase does not need to be annotated with parameters,
653 # you just need a single part with only the Part.text field set.
654 #
655 # If you want to annotate the training phrase, you must create multiple
656 # parts, where the fields of each part are populated in one of two ways:
657 #
658 # - `Part.text` is set to a part of the phrase that has no parameters.
659 # - `Part.text` is set to a part of the phrase that you want to annotate,
660 # and the `entity_type`, `alias`, and `user_defined` fields are all
661 # set.
662 { # Represents a part of a training phrase.
663 "alias": "A String", # Optional. The parameter name for the value extracted from the
664 # annotated part of the example.
665 # This field is required for annotated parts of the training phrase.
666 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
667 # This field is required for annotated parts of the training phrase.
668 "text": "A String", # Required. The text for this part.
669 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
670 # This field is set to true when the Dialogflow Console is used to
671 # manually annotate the part. When creating an annotated part with the
672 # API, you must set this to true.
673 },
674 ],
675 "type": "A String", # Required. The type of the training phrase.
676 "name": "A String", # Output only. The unique identifier of this training phrase.
677 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
678 # the intent. Each time a developer adds an existing sample by editing an
679 # intent or training, this counter is increased.
680 },
681 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]682 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
683 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
684 "A String",
685 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]686 "priority": 42, # The priority of this intent. Higher numbers represent higher
687 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]688 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]689 # - If the supplied value is unspecified or 0, the service
690 # translates the value to 500,000, which corresponds to the
691 # `Normal` priority in the console.
692 # - If the supplied value is negative, the intent is ignored
693 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]694 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
695 # followup intents. It identifies the correct followup intents chain for
696 # this intent. We populate this field only in the output.
697 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]698 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
699 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
700 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]701 "inputContextNames": [ # Optional. The list of context names required for this intent to be
702 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]703 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]704 "A String",
705 ],
706 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
707 # Note: If `ml_enabled` setting is set to false, then this intent is not
708 # taken into account during inference in `ML ONLY` match mode. Also,
709 # auto-markup in the UI is turned off.
710 # DEPRECATED! Please use `ml_disabled` field instead.
711 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
712 # then the default value is determined as follows:
713 # - Before April 15th, 2018 the default is:
714 # ml_enabled = false / ml_disabled = true.
715 # - After April 15th, 2018 the default is:
716 # ml_enabled = true / ml_disabled = false.
717 "action": "A String", # Optional. The name of the action associated with the intent.
718 # Note: The action name must not contain whitespaces.
719 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
720 # is matched. Context messages in this collection should not set the
721 # parameters field. Setting the `lifespan_count` to 0 will reset the context
722 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]723 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]724 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]725 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]726 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
727 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
728 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]729 #
730 # The `Context ID` is always converted to lowercase, may only contain
731 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
732 #
733 # If `Environment ID` is not specified, we assume default 'draft'
734 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]735 #
736 # The following context names are reserved for internal use by Dialogflow.
737 # You should not use these contexts or create contexts with these names:
738 #
739 # * `__system_counters__`
740 # * `*_id_dialog_context`
741 # * `*_dialog_params_size`
742 "parameters": { # Optional. The collection of parameters associated with this context.
743 #
744 # Depending on your protocol or client library language, this is a
745 # map, associative array, symbol table, dictionary, or JSON object
746 # composed of a collection of (MapKey, MapValue) pairs:
747 #
748 # - MapKey type: string
749 # - MapKey value: parameter name
750 # - MapValue type:
751 # - If parameter's entity type is a composite entity: map
752 # - Else: string or number, depending on parameter value type
753 # - MapValue value:
754 # - If parameter's entity type is a composite entity:
755 # map from composite entity property names to property values
756 # - Else: parameter value
757 "a_key": "", # Properties of the object.
758 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]759 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]760 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]761 # immediately. Contexts expire automatically after 20 minutes if there
762 # are no matching queries.
763 },
764 ],
765 "events": [ # Optional. The collection of event names that trigger the intent.
766 # If the collection of input contexts is not empty, all of the contexts must
767 # 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^]768 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]769 "A String",
770 ],
771 },
772 ],
773 }
774
775 x__xgafv: string, V1 error format.
776 Allowed values
777 1 - v1 error format
778 2 - v2 error format
779
780Returns:
781 An object of the form:
782
783 { # This resource represents a long-running operation that is the result of a
784 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]785 "response": { # The normal response of the operation in case of success. If the original
786 # method returns no data on success, such as `Delete`, the response is
787 # `google.protobuf.Empty`. If the original method is standard
788 # `Get`/`Create`/`Update`, the response should be the resource. For other
789 # methods, the response should have the type `XxxResponse`, where `Xxx`
790 # is the original method name. For example, if the original method name
791 # is `TakeSnapshot()`, the inferred response type is
792 # `TakeSnapshotResponse`.
793 "a_key": "", # Properties of the object. Contains field @type with type URL.
794 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]795 "metadata": { # Service-specific metadata associated with the operation. It typically
796 # contains progress information and common metadata such as create time.
797 # Some services might not provide such metadata. Any method that returns a
798 # long-running operation should document the metadata type, if any.
799 "a_key": "", # Properties of the object. Contains field @type with type URL.
800 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]801 "done": True or False, # If the value is `false`, it means the operation is still in progress.
802 # If `true`, the operation is completed, and either `error` or `response` is
803 # available.
804 "name": "A String", # The server-assigned name, which is only unique within the same service that
805 # originally returns it. If you use the default HTTP mapping, the
806 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]807 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
808 # different programming environments, including REST APIs and RPC APIs. It is
809 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
810 # three pieces of data: error code, error message, and error details.
811 #
812 # You can find out more about this error model and how to work with it in the
813 # [API Design Guide](https://cloud.google.com/apis/design/errors).
814 "message": "A String", # A developer-facing error message, which should be in English. Any
815 # user-facing error message should be localized and sent in the
816 # google.rpc.Status.details field, or localized by the client.
817 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
818 "details": [ # A list of messages that carry the error details. There is a common set of
819 # message types for APIs to use.
820 {
821 "a_key": "", # Properties of the object. Contains field @type with type URL.
822 },
823 ],
824 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]825 }</pre>
826</div>
827
828<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]829 <code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]830 <pre>Updates/Creates multiple intents in the specified agent.
831
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]832Operation &lt;response: BatchUpdateIntentsResponse&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]833
834Args:
835 parent: string, Required. The name of the agent to update or create intents in.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]836Format: `projects/&lt;Project ID&gt;/agent`. (required)
837 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]838 The object takes the form of:
839
840{ # The request message for Intents.BatchUpdateIntents.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]841 "languageCode": "A String", # Optional. The language used to access language-specific data.
842 # If not specified, the agent's default language is used.
843 # For more information, see
844 # [Multilingual intent and entity
845 # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]846 "intentBatchUri": "A String", # The URI to a Google Cloud Storage file containing intents to update or
847 # create. The file format can either be a serialized proto (of IntentBatch
848 # type) or JSON object. Note: The URI must start with "gs://".
849 "intentBatchInline": { # This message is a wrapper around a collection of intents. # The collection of intents to update or create.
850 "intents": [ # A collection of intents.
851 { # Represents an intent.
852 # Intents convert a number of user expressions or patterns into an action. An
853 # action is an extraction of a user command or sentence semantics.
854 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
855 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
856 # Note: If `ml_disabled` setting is set to true, then this intent is not
857 # taken into account during inference in `ML ONLY` match mode. Also,
858 # auto-markup in the UI is turned off.
859 "displayName": "A String", # Required. The name of this intent.
860 "name": "A String", # The unique identifier of this intent.
861 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
862 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]863 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]864 "parameters": [ # Optional. The collection of parameters associated with the intent.
865 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]866 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]867 "name": "A String", # The unique identifier of this parameter.
868 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
869 # result.
870 # Default values can be extracted from contexts by using the following
871 # syntax: `#context_name.parameter_name`.
872 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
873 # describes values of the parameter. If the parameter is
874 # required, this must be provided.
875 "value": "A String", # Optional. The definition of the parameter value. It can be:
876 # - a constant string,
877 # - a parameter value defined as `$parameter_name`,
878 # - an original parameter value defined as `$parameter_name.original`,
879 # - a parameter value from some context defined as
880 # `#context_name.parameter_name`.
881 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]882 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]883 "A String",
884 ],
885 "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^]886 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
887 # whether the intent cannot be completed without collecting the parameter
888 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]889 },
890 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]891 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
892 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
893 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]894 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
895 # a direct or indirect parent. We populate this field only in the output.
896 { # Represents a single followup intent in the chain.
897 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]898 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]899 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]900 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]901 },
902 ],
903 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]904 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
905 # chain of followup intents. You can set this field when creating an intent,
906 # for example with CreateIntent or
907 # BatchUpdateIntents, in order to make this
908 # intent a followup intent.
909 #
910 # It identifies the parent followup intent.
911 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]912 "messages": [ # Optional. The collection of rich messages corresponding to the
913 # `Response` field in the Dialogflow console.
914 { # Corresponds to the `Response` field in the Dialogflow console.
915 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
916 # This message in `QueryResult.fulfillment_messages` and
917 # `WebhookResponse.fulfillment_messages` should contain only one
918 # `SimpleResponse`.
919 "simpleResponses": [ # Required. The list of simple responses.
920 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]921 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
922 # response to the user in the SSML format. Mutually exclusive with
923 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]924 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
925 # speech output. Mutually exclusive with ssml.
926 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]927 },
928 ],
929 },
930 "quickReplies": { # The quick replies response message. # Displays quick replies.
931 "quickReplies": [ # Optional. The collection of quick replies.
932 "A String",
933 ],
934 "title": "A String", # Optional. The title of the collection of quick replies.
935 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]936 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
937 #
938 # RBM allows businesses to send enriched and branded versions of SMS. See
939 # https://jibe.google.com/business-messaging.
940 "text": "A String", # Required. Text sent and displayed to the user.
941 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
942 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
943 # easily select/click a predefined response or perform an action (like
944 # opening a web uri).
945 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
946 # can choose from the card.
947 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
948 # to send back to the agent (https://goo.gl/GXotJW).
949 },
950 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
951 # (https://goo.gl/6GLJD2). If the user has an app installed that is
952 # registered as the default handler for the URL, then this app will be
953 # opened instead, and its icon will be used in the suggested action UI.
954 "uri": "A String", # Required. The uri to open on the user device
955 },
956 "text": "A String", # Text to display alongside the action.
957 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
958 # but does not dial automatically (https://goo.gl/ergbB2).
959 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
960 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
961 # format. An example of a correctly formatted phone number:
962 # +15556767888.
963 },
964 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
965 # when the user taps the suggested action. This data will be also
966 # forwarded to webhook to allow performing custom business logic.
967 },
968 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
969 # instead of typing in their own response.
970 "text": "A String", # Suggested reply text.
971 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
972 # when the user taps the suggested reply. This data will be also
973 # forwarded to webhook to allow performing custom business logic.
974 },
975 },
976 ],
977 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]978 "platform": "A String", # Optional. The platform that this message is intended for.
979 "text": { # The text response message. # Returns a text response.
980 "text": [ # Optional. The collection of the agent's responses.
981 "A String",
982 ],
983 },
984 "image": { # The image response message. # Displays an image.
985 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
986 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
987 "imageUri": "A String", # Optional. The public URI to an image file.
988 },
989 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
990 # Telephony Gateway.
991 #
992 # Telephony Gateway takes the synthesizer settings from
993 # `DetectIntentResponse.output_audio_config` which can either be set
994 # at request-level or can come from the agent-level synthesizer config.
995 "ssml": "A String", # The SSML to be synthesized. For more information, see
996 # [SSML](https://developers.google.com/actions/reference/ssml).
997 "text": "A String", # The raw text to be synthesized.
998 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]999 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
1000 #
1001 # Rich cards allow you to respond to users with more vivid content, e.g.
1002 # with media and suggestions.
1003 #
1004 # For more details about RBM rich cards, please see:
1005 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
1006 # If you want to show a single card with more control over the layout,
1007 # please use RbmStandaloneCard instead.
1008 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
1009 # 2 cards and at most 10.
1010 { # Rich Business Messaging (RBM) Card content
1011 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
1012 # be set. Media (image, GIF or a video) to include in the card.
1013 # The following media-types are currently supported:
1014 #
1015 # Image Types
1016 #
1017 # * image/jpeg
1018 # * image/jpg'
1019 # * image/gif
1020 # * image/png
1021 #
1022 # Video Types
1023 #
1024 # * video/h263
1025 # * video/m4v
1026 # * video/mp4
1027 # * video/mpeg
1028 # * video/mpeg4
1029 # * video/webm
1030 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
1031 # determines the MIME type of the file from the content-type field in
1032 # the HTTP headers when the platform fetches the file. The content-type
1033 # field must be present and accurate in the HTTP response from the URL.
1034 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
1035 # provide a thumbnail URI, the RBM platform displays a blank
1036 # placeholder thumbnail until the user's device downloads the file.
1037 # Depending on the user's setting, the file may not download
1038 # automatically and may require the user to tap a download button.
1039 "height": "A String", # Required for cards with vertical orientation. The height of the media
1040 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
1041 # For a standalone card with horizontal layout, height is not
1042 # customizable, and this field is ignored.
1043 },
1044 "suggestions": [ # Optional. List of suggestions to include in the card.
1045 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1046 # easily select/click a predefined response or perform an action (like
1047 # opening a web uri).
1048 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1049 # can choose from the card.
1050 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1051 # to send back to the agent (https://goo.gl/GXotJW).
1052 },
1053 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1054 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1055 # registered as the default handler for the URL, then this app will be
1056 # opened instead, and its icon will be used in the suggested action UI.
1057 "uri": "A String", # Required. The uri to open on the user device
1058 },
1059 "text": "A String", # Text to display alongside the action.
1060 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1061 # but does not dial automatically (https://goo.gl/ergbB2).
1062 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1063 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1064 # format. An example of a correctly formatted phone number:
1065 # +15556767888.
1066 },
1067 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1068 # when the user taps the suggested action. This data will be also
1069 # forwarded to webhook to allow performing custom business logic.
1070 },
1071 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1072 # instead of typing in their own response.
1073 "text": "A String", # Suggested reply text.
1074 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1075 # when the user taps the suggested reply. This data will be also
1076 # forwarded to webhook to allow performing custom business logic.
1077 },
1078 },
1079 ],
1080 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
1081 #
1082 # At least one of the title, description or media must be set.
1083 "title": "A String", # Optional. Title of the card (at most 200 bytes).
1084 #
1085 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1086 },
1087 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1088 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1089 },
1090 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
1091 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
1092 # play, e.g., "gs://bucket/object". The object must contain a single
1093 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
1094 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1095 # This object must be readable by the `service-&lt;Project
1096 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
1097 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1098 # (usually the same as the Dialogflow agent project). If the Google Cloud
1099 # Storage bucket is in the Telephony Gateway project, this permission is
1100 # added by default when enabling the Dialogflow V2 API.
1101 #
1102 # For audio from other sources, consider using the
1103 # `TelephonySynthesizeSpeech` message with SSML.
1104 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1105 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
1106 #
1107 # Rich cards allow you to respond to users with more vivid content, e.g.
1108 # with media and suggestions.
1109 #
1110 # For more details about RBM rich cards, please see:
1111 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
1112 # You can group multiple rich cards into one using RbmCarouselCard but
1113 # carousel cards will give you less control over the card layout.
1114 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
1115 # Image preview alignment for standalone cards with horizontal layout.
1116 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
1117 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
1118 # be set. Media (image, GIF or a video) to include in the card.
1119 # The following media-types are currently supported:
1120 #
1121 # Image Types
1122 #
1123 # * image/jpeg
1124 # * image/jpg'
1125 # * image/gif
1126 # * image/png
1127 #
1128 # Video Types
1129 #
1130 # * video/h263
1131 # * video/m4v
1132 # * video/mp4
1133 # * video/mpeg
1134 # * video/mpeg4
1135 # * video/webm
1136 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
1137 # determines the MIME type of the file from the content-type field in
1138 # the HTTP headers when the platform fetches the file. The content-type
1139 # field must be present and accurate in the HTTP response from the URL.
1140 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
1141 # provide a thumbnail URI, the RBM platform displays a blank
1142 # placeholder thumbnail until the user's device downloads the file.
1143 # Depending on the user's setting, the file may not download
1144 # automatically and may require the user to tap a download button.
1145 "height": "A String", # Required for cards with vertical orientation. The height of the media
1146 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
1147 # For a standalone card with horizontal layout, height is not
1148 # customizable, and this field is ignored.
1149 },
1150 "suggestions": [ # Optional. List of suggestions to include in the card.
1151 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1152 # easily select/click a predefined response or perform an action (like
1153 # opening a web uri).
1154 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1155 # can choose from the card.
1156 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1157 # to send back to the agent (https://goo.gl/GXotJW).
1158 },
1159 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1160 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1161 # registered as the default handler for the URL, then this app will be
1162 # opened instead, and its icon will be used in the suggested action UI.
1163 "uri": "A String", # Required. The uri to open on the user device
1164 },
1165 "text": "A String", # Text to display alongside the action.
1166 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1167 # but does not dial automatically (https://goo.gl/ergbB2).
1168 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1169 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1170 # format. An example of a correctly formatted phone number:
1171 # +15556767888.
1172 },
1173 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1174 # when the user taps the suggested action. This data will be also
1175 # forwarded to webhook to allow performing custom business logic.
1176 },
1177 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1178 # instead of typing in their own response.
1179 "text": "A String", # Suggested reply text.
1180 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1181 # when the user taps the suggested reply. This data will be also
1182 # forwarded to webhook to allow performing custom business logic.
1183 },
1184 },
1185 ],
1186 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
1187 #
1188 # At least one of the title, description or media must be set.
1189 "title": "A String", # Optional. Title of the card (at most 200 bytes).
1190 #
1191 # At least one of the title, description or media must be set.
1192 },
1193 "cardOrientation": "A String", # Required. Orientation of the card.
1194 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1195 "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.
1196 # or website associated with this agent.
1197 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
1198 # suggestion chip.
1199 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
1200 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1201 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
1202 # https://developers.google.com/actions/assistant/responses#browsing_carousel
1203 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
1204 # items, maximum of ten.
1205 { # Browsing carousel tile
1206 "image": { # The image response message. # Optional. Hero image for the carousel item.
1207 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1208 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1209 "imageUri": "A String", # Optional. The public URI to an image file.
1210 },
1211 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
1212 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
1213 # text.
1214 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
1215 "url": "A String", # Required. URL
1216 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
1217 # the URL. Defaults to opening via web browser.
1218 },
1219 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
1220 # Card. Maximum of one line of text.
1221 },
1222 ],
1223 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
1224 # items.
1225 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1226 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
1227 "buttons": [ # Optional. The collection of card buttons.
1228 { # The button object that appears at the bottom of a card.
1229 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1230 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1231 },
1232 "title": "A String", # Required. The title of the button.
1233 },
1234 ],
1235 "formattedText": "A String", # Required, unless image is present. The body text of the card.
1236 "image": { # The image response message. # Optional. The image for the card.
1237 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1238 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1239 "imageUri": "A String", # Optional. The public URI to an image file.
1240 },
1241 "subtitle": "A String", # Optional. The subtitle of the card.
1242 "title": "A String", # Optional. The title of the card.
1243 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1244 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
1245 "mediaObjects": [ # Required. List of media objects.
1246 { # Response media object for media content card.
1247 "contentUrl": "A String", # Required. Url where the media is stored.
1248 "description": "A String", # Optional. Description of media card.
1249 "name": "A String", # Required. Name of media card.
1250 "largeImage": { # The image response message. # Optional. Image to display above media content.
1251 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1252 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1253 "imageUri": "A String", # Optional. The public URI to an image file.
1254 },
1255 "icon": { # The image response message. # Optional. Icon to display above media content.
1256 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1257 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1258 "imageUri": "A String", # Optional. The public URI to an image file.
1259 },
1260 },
1261 ],
1262 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
1263 },
1264 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
1265 "rows": [ # Optional. Rows in this table of data.
1266 { # Row of TableCard.
1267 "cells": [ # Optional. List of cells that make up this row.
1268 { # Cell of TableCardRow.
1269 "text": "A String", # Required. Text in this cell.
1270 },
1271 ],
1272 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
1273 },
1274 ],
1275 "subtitle": "A String", # Optional. Subtitle to the title.
1276 "title": "A String", # Required. Title of the card.
1277 "image": { # The image response message. # Optional. Image which should be displayed on the card.
1278 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1279 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1280 "imageUri": "A String", # Optional. The public URI to an image file.
1281 },
1282 "columnProperties": [ # Optional. Display properties for the columns in this table.
1283 { # Column properties for TableCard.
1284 "header": "A String", # Required. Column heading.
1285 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
1286 },
1287 ],
1288 "buttons": [ # Optional. List of buttons for the card.
1289 { # The button object that appears at the bottom of a card.
1290 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1291 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1292 },
1293 "title": "A String", # Required. The title of the button.
1294 },
1295 ],
1296 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1297 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
1298 "items": [ # Required. Carousel items.
1299 { # An item in the carousel.
1300 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
1301 # dialog.
1302 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1303 # item in dialog.
1304 "A String",
1305 ],
1306 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1307 # response is given.
1308 },
1309 "image": { # The image response message. # Optional. The image to display.
1310 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1311 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1312 "imageUri": "A String", # Optional. The public URI to an image file.
1313 },
1314 "description": "A String", # Optional. The body text of the card.
1315 "title": "A String", # Required. Title of the carousel item.
1316 },
1317 ],
1318 },
1319 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
1320 "items": [ # Required. List items.
1321 { # An item in the list.
1322 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
1323 # dialog.
1324 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1325 # item in dialog.
1326 "A String",
1327 ],
1328 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1329 # response is given.
1330 },
1331 "image": { # The image response message. # Optional. The image to display.
1332 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1333 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1334 "imageUri": "A String", # Optional. The public URI to an image file.
1335 },
1336 "description": "A String", # Optional. The main text describing the item.
1337 "title": "A String", # Required. The title of the list item.
1338 },
1339 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1340 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1341 "title": "A String", # Optional. The overall title of the list.
1342 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1343 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
1344 "suggestions": [ # Required. The list of suggested replies.
1345 { # The suggestion chip message that the user can tap to quickly post a reply
1346 # to the conversation.
1347 "title": "A String", # Required. The text shown the in the suggestion chip.
1348 },
1349 ],
1350 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1351 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
1352 "phoneNumber": "A String", # Required. The phone number to transfer the call to
1353 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
1354 #
1355 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
1356 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1357 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1358 "a_key": "", # Properties of the object.
1359 },
1360 "card": { # The card response message. # Displays a card.
1361 "buttons": [ # Optional. The collection of card buttons.
1362 { # Optional. Contains information about a button.
1363 "text": "A String", # Optional. The text to show on the button.
1364 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1365 # open.
1366 },
1367 ],
1368 "title": "A String", # Optional. The title of the card.
1369 "subtitle": "A String", # Optional. The subtitle of the card.
1370 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1371 },
1372 },
1373 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1374 "trainingPhrases": [ # Optional. The collection of examples that the agent is
1375 # trained on.
1376 { # Represents an example that the agent is trained on.
1377 "parts": [ # Required. The ordered list of training phrase parts.
1378 # The parts are concatenated in order to form the training phrase.
1379 #
1380 # Note: The API does not automatically annotate training phrases like the
1381 # Dialogflow Console does.
1382 #
1383 # Note: Do not forget to include whitespace at part boundaries,
1384 # so the training phrase is well formatted when the parts are concatenated.
1385 #
1386 # If the training phrase does not need to be annotated with parameters,
1387 # you just need a single part with only the Part.text field set.
1388 #
1389 # If you want to annotate the training phrase, you must create multiple
1390 # parts, where the fields of each part are populated in one of two ways:
1391 #
1392 # - `Part.text` is set to a part of the phrase that has no parameters.
1393 # - `Part.text` is set to a part of the phrase that you want to annotate,
1394 # and the `entity_type`, `alias`, and `user_defined` fields are all
1395 # set.
1396 { # Represents a part of a training phrase.
1397 "alias": "A String", # Optional. The parameter name for the value extracted from the
1398 # annotated part of the example.
1399 # This field is required for annotated parts of the training phrase.
1400 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
1401 # This field is required for annotated parts of the training phrase.
1402 "text": "A String", # Required. The text for this part.
1403 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
1404 # This field is set to true when the Dialogflow Console is used to
1405 # manually annotate the part. When creating an annotated part with the
1406 # API, you must set this to true.
1407 },
1408 ],
1409 "type": "A String", # Required. The type of the training phrase.
1410 "name": "A String", # Output only. The unique identifier of this training phrase.
1411 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
1412 # the intent. Each time a developer adds an existing sample by editing an
1413 # intent or training, this counter is increased.
1414 },
1415 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1416 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
1417 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
1418 "A String",
1419 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1420 "priority": 42, # The priority of this intent. Higher numbers represent higher
1421 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1422 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1423 # - If the supplied value is unspecified or 0, the service
1424 # translates the value to 500,000, which corresponds to the
1425 # `Normal` priority in the console.
1426 # - If the supplied value is negative, the intent is ignored
1427 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1428 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
1429 # followup intents. It identifies the correct followup intents chain for
1430 # this intent. We populate this field only in the output.
1431 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1432 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
1433 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
1434 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1435 "inputContextNames": [ # Optional. The list of context names required for this intent to be
1436 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1437 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1438 "A String",
1439 ],
1440 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
1441 # Note: If `ml_enabled` setting is set to false, then this intent is not
1442 # taken into account during inference in `ML ONLY` match mode. Also,
1443 # auto-markup in the UI is turned off.
1444 # DEPRECATED! Please use `ml_disabled` field instead.
1445 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
1446 # then the default value is determined as follows:
1447 # - Before April 15th, 2018 the default is:
1448 # ml_enabled = false / ml_disabled = true.
1449 # - After April 15th, 2018 the default is:
1450 # ml_enabled = true / ml_disabled = false.
1451 "action": "A String", # Optional. The name of the action associated with the intent.
1452 # Note: The action name must not contain whitespaces.
1453 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
1454 # is matched. Context messages in this collection should not set the
1455 # parameters field. Setting the `lifespan_count` to 0 will reset the context
1456 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1457 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1458 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1459 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1460 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
1461 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
1462 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1463 #
1464 # The `Context ID` is always converted to lowercase, may only contain
1465 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
1466 #
1467 # If `Environment ID` is not specified, we assume default 'draft'
1468 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1469 #
1470 # The following context names are reserved for internal use by Dialogflow.
1471 # You should not use these contexts or create contexts with these names:
1472 #
1473 # * `__system_counters__`
1474 # * `*_id_dialog_context`
1475 # * `*_dialog_params_size`
1476 "parameters": { # Optional. The collection of parameters associated with this context.
1477 #
1478 # Depending on your protocol or client library language, this is a
1479 # map, associative array, symbol table, dictionary, or JSON object
1480 # composed of a collection of (MapKey, MapValue) pairs:
1481 #
1482 # - MapKey type: string
1483 # - MapKey value: parameter name
1484 # - MapValue type:
1485 # - If parameter's entity type is a composite entity: map
1486 # - Else: string or number, depending on parameter value type
1487 # - MapValue value:
1488 # - If parameter's entity type is a composite entity:
1489 # map from composite entity property names to property values
1490 # - Else: parameter value
1491 "a_key": "", # Properties of the object.
1492 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1493 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1494 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1495 # immediately. Contexts expire automatically after 20 minutes if there
1496 # are no matching queries.
1497 },
1498 ],
1499 "events": [ # Optional. The collection of event names that trigger the intent.
1500 # If the collection of input contexts is not empty, all of the contexts must
1501 # 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^]1502 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1503 "A String",
1504 ],
1505 },
1506 ],
1507 },
1508 "updateMask": "A String", # Optional. The mask to control which fields get updated.
1509 "intentView": "A String", # Optional. The resource view to apply to the returned intent.
1510 }
1511
1512 x__xgafv: string, V1 error format.
1513 Allowed values
1514 1 - v1 error format
1515 2 - v2 error format
1516
1517Returns:
1518 An object of the form:
1519
1520 { # This resource represents a long-running operation that is the result of a
1521 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1522 "response": { # The normal response of the operation in case of success. If the original
1523 # method returns no data on success, such as `Delete`, the response is
1524 # `google.protobuf.Empty`. If the original method is standard
1525 # `Get`/`Create`/`Update`, the response should be the resource. For other
1526 # methods, the response should have the type `XxxResponse`, where `Xxx`
1527 # is the original method name. For example, if the original method name
1528 # is `TakeSnapshot()`, the inferred response type is
1529 # `TakeSnapshotResponse`.
1530 "a_key": "", # Properties of the object. Contains field @type with type URL.
1531 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1532 "metadata": { # Service-specific metadata associated with the operation. It typically
1533 # contains progress information and common metadata such as create time.
1534 # Some services might not provide such metadata. Any method that returns a
1535 # long-running operation should document the metadata type, if any.
1536 "a_key": "", # Properties of the object. Contains field @type with type URL.
1537 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1538 "done": True or False, # If the value is `false`, it means the operation is still in progress.
1539 # If `true`, the operation is completed, and either `error` or `response` is
1540 # available.
1541 "name": "A String", # The server-assigned name, which is only unique within the same service that
1542 # originally returns it. If you use the default HTTP mapping, the
1543 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1544 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
1545 # different programming environments, including REST APIs and RPC APIs. It is
1546 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1547 # three pieces of data: error code, error message, and error details.
1548 #
1549 # You can find out more about this error model and how to work with it in the
1550 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1551 "message": "A String", # A developer-facing error message, which should be in English. Any
1552 # user-facing error message should be localized and sent in the
1553 # google.rpc.Status.details field, or localized by the client.
1554 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1555 "details": [ # A list of messages that carry the error details. There is a common set of
1556 # message types for APIs to use.
1557 {
1558 "a_key": "", # Properties of the object. Contains field @type with type URL.
1559 },
1560 ],
1561 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1562 }</pre>
1563</div>
1564
1565<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1566 <code class="details" id="create">create(parent, body=None, languageCode=None, intentView=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1567 <pre>Creates an intent in the specified agent.
1568
1569Args:
1570 parent: string, Required. The agent to create a intent for.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1571Format: `projects/&lt;Project ID&gt;/agent`. (required)
1572 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1573 The object takes the form of:
1574
1575{ # Represents an intent.
1576 # Intents convert a number of user expressions or patterns into an action. An
1577 # action is an extraction of a user command or sentence semantics.
1578 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
1579 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
1580 # Note: If `ml_disabled` setting is set to true, then this intent is not
1581 # taken into account during inference in `ML ONLY` match mode. Also,
1582 # auto-markup in the UI is turned off.
1583 "displayName": "A String", # Required. The name of this intent.
1584 "name": "A String", # The unique identifier of this intent.
1585 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
1586 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1587 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1588 "parameters": [ # Optional. The collection of parameters associated with the intent.
1589 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1590 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1591 "name": "A String", # The unique identifier of this parameter.
1592 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
1593 # result.
1594 # Default values can be extracted from contexts by using the following
1595 # syntax: `#context_name.parameter_name`.
1596 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
1597 # describes values of the parameter. If the parameter is
1598 # required, this must be provided.
1599 "value": "A String", # Optional. The definition of the parameter value. It can be:
1600 # - a constant string,
1601 # - a parameter value defined as `$parameter_name`,
1602 # - an original parameter value defined as `$parameter_name.original`,
1603 # - a parameter value from some context defined as
1604 # `#context_name.parameter_name`.
1605 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1606 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1607 "A String",
1608 ],
1609 "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^]1610 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
1611 # whether the intent cannot be completed without collecting the parameter
1612 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1613 },
1614 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1615 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
1616 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
1617 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1618 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
1619 # a direct or indirect parent. We populate this field only in the output.
1620 { # Represents a single followup intent in the chain.
1621 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1622 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1623 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1624 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1625 },
1626 ],
1627 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1628 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
1629 # chain of followup intents. You can set this field when creating an intent,
1630 # for example with CreateIntent or
1631 # BatchUpdateIntents, in order to make this
1632 # intent a followup intent.
1633 #
1634 # It identifies the parent followup intent.
1635 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1636 "messages": [ # Optional. The collection of rich messages corresponding to the
1637 # `Response` field in the Dialogflow console.
1638 { # Corresponds to the `Response` field in the Dialogflow console.
1639 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
1640 # This message in `QueryResult.fulfillment_messages` and
1641 # `WebhookResponse.fulfillment_messages` should contain only one
1642 # `SimpleResponse`.
1643 "simpleResponses": [ # Required. The list of simple responses.
1644 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1645 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
1646 # response to the user in the SSML format. Mutually exclusive with
1647 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1648 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
1649 # speech output. Mutually exclusive with ssml.
1650 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1651 },
1652 ],
1653 },
1654 "quickReplies": { # The quick replies response message. # Displays quick replies.
1655 "quickReplies": [ # Optional. The collection of quick replies.
1656 "A String",
1657 ],
1658 "title": "A String", # Optional. The title of the collection of quick replies.
1659 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1660 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
1661 #
1662 # RBM allows businesses to send enriched and branded versions of SMS. See
1663 # https://jibe.google.com/business-messaging.
1664 "text": "A String", # Required. Text sent and displayed to the user.
1665 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
1666 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1667 # easily select/click a predefined response or perform an action (like
1668 # opening a web uri).
1669 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1670 # can choose from the card.
1671 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1672 # to send back to the agent (https://goo.gl/GXotJW).
1673 },
1674 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1675 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1676 # registered as the default handler for the URL, then this app will be
1677 # opened instead, and its icon will be used in the suggested action UI.
1678 "uri": "A String", # Required. The uri to open on the user device
1679 },
1680 "text": "A String", # Text to display alongside the action.
1681 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1682 # but does not dial automatically (https://goo.gl/ergbB2).
1683 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1684 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1685 # format. An example of a correctly formatted phone number:
1686 # +15556767888.
1687 },
1688 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1689 # when the user taps the suggested action. This data will be also
1690 # forwarded to webhook to allow performing custom business logic.
1691 },
1692 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1693 # instead of typing in their own response.
1694 "text": "A String", # Suggested reply text.
1695 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1696 # when the user taps the suggested reply. This data will be also
1697 # forwarded to webhook to allow performing custom business logic.
1698 },
1699 },
1700 ],
1701 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1702 "platform": "A String", # Optional. The platform that this message is intended for.
1703 "text": { # The text response message. # Returns a text response.
1704 "text": [ # Optional. The collection of the agent's responses.
1705 "A String",
1706 ],
1707 },
1708 "image": { # The image response message. # Displays an image.
1709 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1710 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1711 "imageUri": "A String", # Optional. The public URI to an image file.
1712 },
1713 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
1714 # Telephony Gateway.
1715 #
1716 # Telephony Gateway takes the synthesizer settings from
1717 # `DetectIntentResponse.output_audio_config` which can either be set
1718 # at request-level or can come from the agent-level synthesizer config.
1719 "ssml": "A String", # The SSML to be synthesized. For more information, see
1720 # [SSML](https://developers.google.com/actions/reference/ssml).
1721 "text": "A String", # The raw text to be synthesized.
1722 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1723 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
1724 #
1725 # Rich cards allow you to respond to users with more vivid content, e.g.
1726 # with media and suggestions.
1727 #
1728 # For more details about RBM rich cards, please see:
1729 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
1730 # If you want to show a single card with more control over the layout,
1731 # please use RbmStandaloneCard instead.
1732 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
1733 # 2 cards and at most 10.
1734 { # Rich Business Messaging (RBM) Card content
1735 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
1736 # be set. Media (image, GIF or a video) to include in the card.
1737 # The following media-types are currently supported:
1738 #
1739 # Image Types
1740 #
1741 # * image/jpeg
1742 # * image/jpg'
1743 # * image/gif
1744 # * image/png
1745 #
1746 # Video Types
1747 #
1748 # * video/h263
1749 # * video/m4v
1750 # * video/mp4
1751 # * video/mpeg
1752 # * video/mpeg4
1753 # * video/webm
1754 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
1755 # determines the MIME type of the file from the content-type field in
1756 # the HTTP headers when the platform fetches the file. The content-type
1757 # field must be present and accurate in the HTTP response from the URL.
1758 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
1759 # provide a thumbnail URI, the RBM platform displays a blank
1760 # placeholder thumbnail until the user's device downloads the file.
1761 # Depending on the user's setting, the file may not download
1762 # automatically and may require the user to tap a download button.
1763 "height": "A String", # Required for cards with vertical orientation. The height of the media
1764 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
1765 # For a standalone card with horizontal layout, height is not
1766 # customizable, and this field is ignored.
1767 },
1768 "suggestions": [ # Optional. List of suggestions to include in the card.
1769 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1770 # easily select/click a predefined response or perform an action (like
1771 # opening a web uri).
1772 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1773 # can choose from the card.
1774 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1775 # to send back to the agent (https://goo.gl/GXotJW).
1776 },
1777 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1778 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1779 # registered as the default handler for the URL, then this app will be
1780 # opened instead, and its icon will be used in the suggested action UI.
1781 "uri": "A String", # Required. The uri to open on the user device
1782 },
1783 "text": "A String", # Text to display alongside the action.
1784 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1785 # but does not dial automatically (https://goo.gl/ergbB2).
1786 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1787 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1788 # format. An example of a correctly formatted phone number:
1789 # +15556767888.
1790 },
1791 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1792 # when the user taps the suggested action. This data will be also
1793 # forwarded to webhook to allow performing custom business logic.
1794 },
1795 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1796 # instead of typing in their own response.
1797 "text": "A String", # Suggested reply text.
1798 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1799 # when the user taps the suggested reply. This data will be also
1800 # forwarded to webhook to allow performing custom business logic.
1801 },
1802 },
1803 ],
1804 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
1805 #
1806 # At least one of the title, description or media must be set.
1807 "title": "A String", # Optional. Title of the card (at most 200 bytes).
1808 #
1809 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1810 },
1811 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1812 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1813 },
1814 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
1815 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
1816 # play, e.g., "gs://bucket/object". The object must contain a single
1817 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
1818 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1819 # This object must be readable by the `service-&lt;Project
1820 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
1821 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1822 # (usually the same as the Dialogflow agent project). If the Google Cloud
1823 # Storage bucket is in the Telephony Gateway project, this permission is
1824 # added by default when enabling the Dialogflow V2 API.
1825 #
1826 # For audio from other sources, consider using the
1827 # `TelephonySynthesizeSpeech` message with SSML.
1828 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1829 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
1830 #
1831 # Rich cards allow you to respond to users with more vivid content, e.g.
1832 # with media and suggestions.
1833 #
1834 # For more details about RBM rich cards, please see:
1835 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
1836 # You can group multiple rich cards into one using RbmCarouselCard but
1837 # carousel cards will give you less control over the card layout.
1838 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
1839 # Image preview alignment for standalone cards with horizontal layout.
1840 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
1841 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
1842 # be set. Media (image, GIF or a video) to include in the card.
1843 # The following media-types are currently supported:
1844 #
1845 # Image Types
1846 #
1847 # * image/jpeg
1848 # * image/jpg'
1849 # * image/gif
1850 # * image/png
1851 #
1852 # Video Types
1853 #
1854 # * video/h263
1855 # * video/m4v
1856 # * video/mp4
1857 # * video/mpeg
1858 # * video/mpeg4
1859 # * video/webm
1860 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
1861 # determines the MIME type of the file from the content-type field in
1862 # the HTTP headers when the platform fetches the file. The content-type
1863 # field must be present and accurate in the HTTP response from the URL.
1864 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
1865 # provide a thumbnail URI, the RBM platform displays a blank
1866 # placeholder thumbnail until the user's device downloads the file.
1867 # Depending on the user's setting, the file may not download
1868 # automatically and may require the user to tap a download button.
1869 "height": "A String", # Required for cards with vertical orientation. The height of the media
1870 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
1871 # For a standalone card with horizontal layout, height is not
1872 # customizable, and this field is ignored.
1873 },
1874 "suggestions": [ # Optional. List of suggestions to include in the card.
1875 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
1876 # easily select/click a predefined response or perform an action (like
1877 # opening a web uri).
1878 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
1879 # can choose from the card.
1880 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
1881 # to send back to the agent (https://goo.gl/GXotJW).
1882 },
1883 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
1884 # (https://goo.gl/6GLJD2). If the user has an app installed that is
1885 # registered as the default handler for the URL, then this app will be
1886 # opened instead, and its icon will be used in the suggested action UI.
1887 "uri": "A String", # Required. The uri to open on the user device
1888 },
1889 "text": "A String", # Text to display alongside the action.
1890 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
1891 # but does not dial automatically (https://goo.gl/ergbB2).
1892 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
1893 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
1894 # format. An example of a correctly formatted phone number:
1895 # +15556767888.
1896 },
1897 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1898 # when the user taps the suggested action. This data will be also
1899 # forwarded to webhook to allow performing custom business logic.
1900 },
1901 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
1902 # instead of typing in their own response.
1903 "text": "A String", # Suggested reply text.
1904 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
1905 # when the user taps the suggested reply. This data will be also
1906 # forwarded to webhook to allow performing custom business logic.
1907 },
1908 },
1909 ],
1910 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
1911 #
1912 # At least one of the title, description or media must be set.
1913 "title": "A String", # Optional. Title of the card (at most 200 bytes).
1914 #
1915 # At least one of the title, description or media must be set.
1916 },
1917 "cardOrientation": "A String", # Required. Orientation of the card.
1918 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1919 "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.
1920 # or website associated with this agent.
1921 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
1922 # suggestion chip.
1923 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
1924 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1925 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
1926 # https://developers.google.com/actions/assistant/responses#browsing_carousel
1927 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
1928 # items, maximum of ten.
1929 { # Browsing carousel tile
1930 "image": { # The image response message. # Optional. Hero image for the carousel item.
1931 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1932 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1933 "imageUri": "A String", # Optional. The public URI to an image file.
1934 },
1935 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
1936 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
1937 # text.
1938 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
1939 "url": "A String", # Required. URL
1940 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
1941 # the URL. Defaults to opening via web browser.
1942 },
1943 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
1944 # Card. Maximum of one line of text.
1945 },
1946 ],
1947 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
1948 # items.
1949 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1950 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
1951 "buttons": [ # Optional. The collection of card buttons.
1952 { # The button object that appears at the bottom of a card.
1953 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1954 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1955 },
1956 "title": "A String", # Required. The title of the button.
1957 },
1958 ],
1959 "formattedText": "A String", # Required, unless image is present. The body text of the card.
1960 "image": { # The image response message. # Optional. The image for the card.
1961 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1962 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1963 "imageUri": "A String", # Optional. The public URI to an image file.
1964 },
1965 "subtitle": "A String", # Optional. The subtitle of the card.
1966 "title": "A String", # Optional. The title of the card.
1967 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1968 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
1969 "mediaObjects": [ # Required. List of media objects.
1970 { # Response media object for media content card.
1971 "contentUrl": "A String", # Required. Url where the media is stored.
1972 "description": "A String", # Optional. Description of media card.
1973 "name": "A String", # Required. Name of media card.
1974 "largeImage": { # The image response message. # Optional. Image to display above media content.
1975 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1976 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1977 "imageUri": "A String", # Optional. The public URI to an image file.
1978 },
1979 "icon": { # The image response message. # Optional. Icon to display above media content.
1980 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
1981 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
1982 "imageUri": "A String", # Optional. The public URI to an image file.
1983 },
1984 },
1985 ],
1986 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
1987 },
1988 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
1989 "rows": [ # Optional. Rows in this table of data.
1990 { # Row of TableCard.
1991 "cells": [ # Optional. List of cells that make up this row.
1992 { # Cell of TableCardRow.
1993 "text": "A String", # Required. Text in this cell.
1994 },
1995 ],
1996 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
1997 },
1998 ],
1999 "subtitle": "A String", # Optional. Subtitle to the title.
2000 "title": "A String", # Required. Title of the card.
2001 "image": { # The image response message. # Optional. Image which should be displayed on the card.
2002 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2003 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2004 "imageUri": "A String", # Optional. The public URI to an image file.
2005 },
2006 "columnProperties": [ # Optional. Display properties for the columns in this table.
2007 { # Column properties for TableCard.
2008 "header": "A String", # Required. Column heading.
2009 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
2010 },
2011 ],
2012 "buttons": [ # Optional. List of buttons for the card.
2013 { # The button object that appears at the bottom of a card.
2014 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2015 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2016 },
2017 "title": "A String", # Required. The title of the button.
2018 },
2019 ],
2020 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2021 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
2022 "items": [ # Required. Carousel items.
2023 { # An item in the carousel.
2024 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2025 # dialog.
2026 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2027 # item in dialog.
2028 "A String",
2029 ],
2030 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2031 # response is given.
2032 },
2033 "image": { # The image response message. # Optional. The image to display.
2034 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2035 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2036 "imageUri": "A String", # Optional. The public URI to an image file.
2037 },
2038 "description": "A String", # Optional. The body text of the card.
2039 "title": "A String", # Required. Title of the carousel item.
2040 },
2041 ],
2042 },
2043 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
2044 "items": [ # Required. List items.
2045 { # An item in the list.
2046 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
2047 # dialog.
2048 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2049 # item in dialog.
2050 "A String",
2051 ],
2052 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2053 # response is given.
2054 },
2055 "image": { # The image response message. # Optional. The image to display.
2056 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2057 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2058 "imageUri": "A String", # Optional. The public URI to an image file.
2059 },
2060 "description": "A String", # Optional. The main text describing the item.
2061 "title": "A String", # Required. The title of the list item.
2062 },
2063 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2064 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2065 "title": "A String", # Optional. The overall title of the list.
2066 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2067 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
2068 "suggestions": [ # Required. The list of suggested replies.
2069 { # The suggestion chip message that the user can tap to quickly post a reply
2070 # to the conversation.
2071 "title": "A String", # Required. The text shown the in the suggestion chip.
2072 },
2073 ],
2074 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2075 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
2076 "phoneNumber": "A String", # Required. The phone number to transfer the call to
2077 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
2078 #
2079 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
2080 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2081 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2082 "a_key": "", # Properties of the object.
2083 },
2084 "card": { # The card response message. # Displays a card.
2085 "buttons": [ # Optional. The collection of card buttons.
2086 { # Optional. Contains information about a button.
2087 "text": "A String", # Optional. The text to show on the button.
2088 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
2089 # open.
2090 },
2091 ],
2092 "title": "A String", # Optional. The title of the card.
2093 "subtitle": "A String", # Optional. The subtitle of the card.
2094 "imageUri": "A String", # Optional. The public URI to an image file for the card.
2095 },
2096 },
2097 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2098 "trainingPhrases": [ # Optional. The collection of examples that the agent is
2099 # trained on.
2100 { # Represents an example that the agent is trained on.
2101 "parts": [ # Required. The ordered list of training phrase parts.
2102 # The parts are concatenated in order to form the training phrase.
2103 #
2104 # Note: The API does not automatically annotate training phrases like the
2105 # Dialogflow Console does.
2106 #
2107 # Note: Do not forget to include whitespace at part boundaries,
2108 # so the training phrase is well formatted when the parts are concatenated.
2109 #
2110 # If the training phrase does not need to be annotated with parameters,
2111 # you just need a single part with only the Part.text field set.
2112 #
2113 # If you want to annotate the training phrase, you must create multiple
2114 # parts, where the fields of each part are populated in one of two ways:
2115 #
2116 # - `Part.text` is set to a part of the phrase that has no parameters.
2117 # - `Part.text` is set to a part of the phrase that you want to annotate,
2118 # and the `entity_type`, `alias`, and `user_defined` fields are all
2119 # set.
2120 { # Represents a part of a training phrase.
2121 "alias": "A String", # Optional. The parameter name for the value extracted from the
2122 # annotated part of the example.
2123 # This field is required for annotated parts of the training phrase.
2124 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
2125 # This field is required for annotated parts of the training phrase.
2126 "text": "A String", # Required. The text for this part.
2127 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
2128 # This field is set to true when the Dialogflow Console is used to
2129 # manually annotate the part. When creating an annotated part with the
2130 # API, you must set this to true.
2131 },
2132 ],
2133 "type": "A String", # Required. The type of the training phrase.
2134 "name": "A String", # Output only. The unique identifier of this training phrase.
2135 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
2136 # the intent. Each time a developer adds an existing sample by editing an
2137 # intent or training, this counter is increased.
2138 },
2139 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2140 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
2141 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
2142 "A String",
2143 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2144 "priority": 42, # The priority of this intent. Higher numbers represent higher
2145 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2146 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2147 # - If the supplied value is unspecified or 0, the service
2148 # translates the value to 500,000, which corresponds to the
2149 # `Normal` priority in the console.
2150 # - If the supplied value is negative, the intent is ignored
2151 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2152 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
2153 # followup intents. It identifies the correct followup intents chain for
2154 # this intent. We populate this field only in the output.
2155 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2156 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
2157 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
2158 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2159 "inputContextNames": [ # Optional. The list of context names required for this intent to be
2160 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2161 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2162 "A String",
2163 ],
2164 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
2165 # Note: If `ml_enabled` setting is set to false, then this intent is not
2166 # taken into account during inference in `ML ONLY` match mode. Also,
2167 # auto-markup in the UI is turned off.
2168 # DEPRECATED! Please use `ml_disabled` field instead.
2169 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
2170 # then the default value is determined as follows:
2171 # - Before April 15th, 2018 the default is:
2172 # ml_enabled = false / ml_disabled = true.
2173 # - After April 15th, 2018 the default is:
2174 # ml_enabled = true / ml_disabled = false.
2175 "action": "A String", # Optional. The name of the action associated with the intent.
2176 # Note: The action name must not contain whitespaces.
2177 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
2178 # is matched. Context messages in this collection should not set the
2179 # parameters field. Setting the `lifespan_count` to 0 will reset the context
2180 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2181 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2182 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2183 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2184 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
2185 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
2186 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2187 #
2188 # The `Context ID` is always converted to lowercase, may only contain
2189 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
2190 #
2191 # If `Environment ID` is not specified, we assume default 'draft'
2192 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2193 #
2194 # The following context names are reserved for internal use by Dialogflow.
2195 # You should not use these contexts or create contexts with these names:
2196 #
2197 # * `__system_counters__`
2198 # * `*_id_dialog_context`
2199 # * `*_dialog_params_size`
2200 "parameters": { # Optional. The collection of parameters associated with this context.
2201 #
2202 # Depending on your protocol or client library language, this is a
2203 # map, associative array, symbol table, dictionary, or JSON object
2204 # composed of a collection of (MapKey, MapValue) pairs:
2205 #
2206 # - MapKey type: string
2207 # - MapKey value: parameter name
2208 # - MapValue type:
2209 # - If parameter's entity type is a composite entity: map
2210 # - Else: string or number, depending on parameter value type
2211 # - MapValue value:
2212 # - If parameter's entity type is a composite entity:
2213 # map from composite entity property names to property values
2214 # - Else: parameter value
2215 "a_key": "", # Properties of the object.
2216 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2217 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2218 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2219 # immediately. Contexts expire automatically after 20 minutes if there
2220 # are no matching queries.
2221 },
2222 ],
2223 "events": [ # Optional. The collection of event names that trigger the intent.
2224 # If the collection of input contexts is not empty, all of the contexts must
2225 # 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^]2226 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2227 "A String",
2228 ],
2229}
2230
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2231 languageCode: string, Optional. The language used to access language-specific data.
2232If not specified, the agent's default language is used.
2233For more information, see
2234[Multilingual intent and entity
2235data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2236 intentView: string, Optional. The resource view to apply to the returned intent.
2237 x__xgafv: string, V1 error format.
2238 Allowed values
2239 1 - v1 error format
2240 2 - v2 error format
2241
2242Returns:
2243 An object of the form:
2244
2245 { # Represents an intent.
2246 # Intents convert a number of user expressions or patterns into an action. An
2247 # action is an extraction of a user command or sentence semantics.
2248 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
2249 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
2250 # Note: If `ml_disabled` setting is set to true, then this intent is not
2251 # taken into account during inference in `ML ONLY` match mode. Also,
2252 # auto-markup in the UI is turned off.
2253 "displayName": "A String", # Required. The name of this intent.
2254 "name": "A String", # The unique identifier of this intent.
2255 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2256 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2257 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2258 "parameters": [ # Optional. The collection of parameters associated with the intent.
2259 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2260 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2261 "name": "A String", # The unique identifier of this parameter.
2262 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
2263 # result.
2264 # Default values can be extracted from contexts by using the following
2265 # syntax: `#context_name.parameter_name`.
2266 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
2267 # describes values of the parameter. If the parameter is
2268 # required, this must be provided.
2269 "value": "A String", # Optional. The definition of the parameter value. It can be:
2270 # - a constant string,
2271 # - a parameter value defined as `$parameter_name`,
2272 # - an original parameter value defined as `$parameter_name.original`,
2273 # - a parameter value from some context defined as
2274 # `#context_name.parameter_name`.
2275 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2276 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2277 "A String",
2278 ],
2279 "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^]2280 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
2281 # whether the intent cannot be completed without collecting the parameter
2282 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2283 },
2284 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2285 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
2286 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
2287 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2288 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
2289 # a direct or indirect parent. We populate this field only in the output.
2290 { # Represents a single followup intent in the chain.
2291 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2292 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2293 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2294 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2295 },
2296 ],
2297 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2298 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
2299 # chain of followup intents. You can set this field when creating an intent,
2300 # for example with CreateIntent or
2301 # BatchUpdateIntents, in order to make this
2302 # intent a followup intent.
2303 #
2304 # It identifies the parent followup intent.
2305 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2306 "messages": [ # Optional. The collection of rich messages corresponding to the
2307 # `Response` field in the Dialogflow console.
2308 { # Corresponds to the `Response` field in the Dialogflow console.
2309 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
2310 # This message in `QueryResult.fulfillment_messages` and
2311 # `WebhookResponse.fulfillment_messages` should contain only one
2312 # `SimpleResponse`.
2313 "simpleResponses": [ # Required. The list of simple responses.
2314 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2315 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
2316 # response to the user in the SSML format. Mutually exclusive with
2317 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2318 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
2319 # speech output. Mutually exclusive with ssml.
2320 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2321 },
2322 ],
2323 },
2324 "quickReplies": { # The quick replies response message. # Displays quick replies.
2325 "quickReplies": [ # Optional. The collection of quick replies.
2326 "A String",
2327 ],
2328 "title": "A String", # Optional. The title of the collection of quick replies.
2329 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2330 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
2331 #
2332 # RBM allows businesses to send enriched and branded versions of SMS. See
2333 # https://jibe.google.com/business-messaging.
2334 "text": "A String", # Required. Text sent and displayed to the user.
2335 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
2336 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
2337 # easily select/click a predefined response or perform an action (like
2338 # opening a web uri).
2339 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
2340 # can choose from the card.
2341 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
2342 # to send back to the agent (https://goo.gl/GXotJW).
2343 },
2344 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
2345 # (https://goo.gl/6GLJD2). If the user has an app installed that is
2346 # registered as the default handler for the URL, then this app will be
2347 # opened instead, and its icon will be used in the suggested action UI.
2348 "uri": "A String", # Required. The uri to open on the user device
2349 },
2350 "text": "A String", # Text to display alongside the action.
2351 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
2352 # but does not dial automatically (https://goo.gl/ergbB2).
2353 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
2354 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
2355 # format. An example of a correctly formatted phone number:
2356 # +15556767888.
2357 },
2358 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2359 # when the user taps the suggested action. This data will be also
2360 # forwarded to webhook to allow performing custom business logic.
2361 },
2362 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
2363 # instead of typing in their own response.
2364 "text": "A String", # Suggested reply text.
2365 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2366 # when the user taps the suggested reply. This data will be also
2367 # forwarded to webhook to allow performing custom business logic.
2368 },
2369 },
2370 ],
2371 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2372 "platform": "A String", # Optional. The platform that this message is intended for.
2373 "text": { # The text response message. # Returns a text response.
2374 "text": [ # Optional. The collection of the agent's responses.
2375 "A String",
2376 ],
2377 },
2378 "image": { # The image response message. # Displays an image.
2379 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2380 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2381 "imageUri": "A String", # Optional. The public URI to an image file.
2382 },
2383 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
2384 # Telephony Gateway.
2385 #
2386 # Telephony Gateway takes the synthesizer settings from
2387 # `DetectIntentResponse.output_audio_config` which can either be set
2388 # at request-level or can come from the agent-level synthesizer config.
2389 "ssml": "A String", # The SSML to be synthesized. For more information, see
2390 # [SSML](https://developers.google.com/actions/reference/ssml).
2391 "text": "A String", # The raw text to be synthesized.
2392 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2393 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
2394 #
2395 # Rich cards allow you to respond to users with more vivid content, e.g.
2396 # with media and suggestions.
2397 #
2398 # For more details about RBM rich cards, please see:
2399 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
2400 # If you want to show a single card with more control over the layout,
2401 # please use RbmStandaloneCard instead.
2402 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
2403 # 2 cards and at most 10.
2404 { # Rich Business Messaging (RBM) Card content
2405 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
2406 # be set. Media (image, GIF or a video) to include in the card.
2407 # The following media-types are currently supported:
2408 #
2409 # Image Types
2410 #
2411 # * image/jpeg
2412 # * image/jpg'
2413 # * image/gif
2414 # * image/png
2415 #
2416 # Video Types
2417 #
2418 # * video/h263
2419 # * video/m4v
2420 # * video/mp4
2421 # * video/mpeg
2422 # * video/mpeg4
2423 # * video/webm
2424 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
2425 # determines the MIME type of the file from the content-type field in
2426 # the HTTP headers when the platform fetches the file. The content-type
2427 # field must be present and accurate in the HTTP response from the URL.
2428 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
2429 # provide a thumbnail URI, the RBM platform displays a blank
2430 # placeholder thumbnail until the user's device downloads the file.
2431 # Depending on the user's setting, the file may not download
2432 # automatically and may require the user to tap a download button.
2433 "height": "A String", # Required for cards with vertical orientation. The height of the media
2434 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
2435 # For a standalone card with horizontal layout, height is not
2436 # customizable, and this field is ignored.
2437 },
2438 "suggestions": [ # Optional. List of suggestions to include in the card.
2439 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
2440 # easily select/click a predefined response or perform an action (like
2441 # opening a web uri).
2442 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
2443 # can choose from the card.
2444 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
2445 # to send back to the agent (https://goo.gl/GXotJW).
2446 },
2447 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
2448 # (https://goo.gl/6GLJD2). If the user has an app installed that is
2449 # registered as the default handler for the URL, then this app will be
2450 # opened instead, and its icon will be used in the suggested action UI.
2451 "uri": "A String", # Required. The uri to open on the user device
2452 },
2453 "text": "A String", # Text to display alongside the action.
2454 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
2455 # but does not dial automatically (https://goo.gl/ergbB2).
2456 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
2457 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
2458 # format. An example of a correctly formatted phone number:
2459 # +15556767888.
2460 },
2461 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2462 # when the user taps the suggested action. This data will be also
2463 # forwarded to webhook to allow performing custom business logic.
2464 },
2465 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
2466 # instead of typing in their own response.
2467 "text": "A String", # Suggested reply text.
2468 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2469 # when the user taps the suggested reply. This data will be also
2470 # forwarded to webhook to allow performing custom business logic.
2471 },
2472 },
2473 ],
2474 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
2475 #
2476 # At least one of the title, description or media must be set.
2477 "title": "A String", # Optional. Title of the card (at most 200 bytes).
2478 #
2479 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2480 },
2481 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2482 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2483 },
2484 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
2485 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
2486 # play, e.g., "gs://bucket/object". The object must contain a single
2487 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
2488 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2489 # This object must be readable by the `service-&lt;Project
2490 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
2491 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2492 # (usually the same as the Dialogflow agent project). If the Google Cloud
2493 # Storage bucket is in the Telephony Gateway project, this permission is
2494 # added by default when enabling the Dialogflow V2 API.
2495 #
2496 # For audio from other sources, consider using the
2497 # `TelephonySynthesizeSpeech` message with SSML.
2498 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2499 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
2500 #
2501 # Rich cards allow you to respond to users with more vivid content, e.g.
2502 # with media and suggestions.
2503 #
2504 # For more details about RBM rich cards, please see:
2505 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
2506 # You can group multiple rich cards into one using RbmCarouselCard but
2507 # carousel cards will give you less control over the card layout.
2508 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
2509 # Image preview alignment for standalone cards with horizontal layout.
2510 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
2511 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
2512 # be set. Media (image, GIF or a video) to include in the card.
2513 # The following media-types are currently supported:
2514 #
2515 # Image Types
2516 #
2517 # * image/jpeg
2518 # * image/jpg'
2519 # * image/gif
2520 # * image/png
2521 #
2522 # Video Types
2523 #
2524 # * video/h263
2525 # * video/m4v
2526 # * video/mp4
2527 # * video/mpeg
2528 # * video/mpeg4
2529 # * video/webm
2530 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
2531 # determines the MIME type of the file from the content-type field in
2532 # the HTTP headers when the platform fetches the file. The content-type
2533 # field must be present and accurate in the HTTP response from the URL.
2534 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
2535 # provide a thumbnail URI, the RBM platform displays a blank
2536 # placeholder thumbnail until the user's device downloads the file.
2537 # Depending on the user's setting, the file may not download
2538 # automatically and may require the user to tap a download button.
2539 "height": "A String", # Required for cards with vertical orientation. The height of the media
2540 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
2541 # For a standalone card with horizontal layout, height is not
2542 # customizable, and this field is ignored.
2543 },
2544 "suggestions": [ # Optional. List of suggestions to include in the card.
2545 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
2546 # easily select/click a predefined response or perform an action (like
2547 # opening a web uri).
2548 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
2549 # can choose from the card.
2550 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
2551 # to send back to the agent (https://goo.gl/GXotJW).
2552 },
2553 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
2554 # (https://goo.gl/6GLJD2). If the user has an app installed that is
2555 # registered as the default handler for the URL, then this app will be
2556 # opened instead, and its icon will be used in the suggested action UI.
2557 "uri": "A String", # Required. The uri to open on the user device
2558 },
2559 "text": "A String", # Text to display alongside the action.
2560 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
2561 # but does not dial automatically (https://goo.gl/ergbB2).
2562 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
2563 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
2564 # format. An example of a correctly formatted phone number:
2565 # +15556767888.
2566 },
2567 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2568 # when the user taps the suggested action. This data will be also
2569 # forwarded to webhook to allow performing custom business logic.
2570 },
2571 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
2572 # instead of typing in their own response.
2573 "text": "A String", # Suggested reply text.
2574 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
2575 # when the user taps the suggested reply. This data will be also
2576 # forwarded to webhook to allow performing custom business logic.
2577 },
2578 },
2579 ],
2580 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
2581 #
2582 # At least one of the title, description or media must be set.
2583 "title": "A String", # Optional. Title of the card (at most 200 bytes).
2584 #
2585 # At least one of the title, description or media must be set.
2586 },
2587 "cardOrientation": "A String", # Required. Orientation of the card.
2588 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2589 "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.
2590 # or website associated with this agent.
2591 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
2592 # suggestion chip.
2593 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
2594 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2595 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
2596 # https://developers.google.com/actions/assistant/responses#browsing_carousel
2597 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
2598 # items, maximum of ten.
2599 { # Browsing carousel tile
2600 "image": { # The image response message. # Optional. Hero image for the carousel item.
2601 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2602 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2603 "imageUri": "A String", # Optional. The public URI to an image file.
2604 },
2605 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
2606 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
2607 # text.
2608 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
2609 "url": "A String", # Required. URL
2610 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
2611 # the URL. Defaults to opening via web browser.
2612 },
2613 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
2614 # Card. Maximum of one line of text.
2615 },
2616 ],
2617 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
2618 # items.
2619 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2620 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
2621 "buttons": [ # Optional. The collection of card buttons.
2622 { # The button object that appears at the bottom of a card.
2623 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2624 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2625 },
2626 "title": "A String", # Required. The title of the button.
2627 },
2628 ],
2629 "formattedText": "A String", # Required, unless image is present. The body text of the card.
2630 "image": { # The image response message. # Optional. The image for the card.
2631 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2632 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2633 "imageUri": "A String", # Optional. The public URI to an image file.
2634 },
2635 "subtitle": "A String", # Optional. The subtitle of the card.
2636 "title": "A String", # Optional. The title of the card.
2637 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2638 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
2639 "mediaObjects": [ # Required. List of media objects.
2640 { # Response media object for media content card.
2641 "contentUrl": "A String", # Required. Url where the media is stored.
2642 "description": "A String", # Optional. Description of media card.
2643 "name": "A String", # Required. Name of media card.
2644 "largeImage": { # The image response message. # Optional. Image to display above media content.
2645 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2646 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2647 "imageUri": "A String", # Optional. The public URI to an image file.
2648 },
2649 "icon": { # The image response message. # Optional. Icon to display above media content.
2650 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2651 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2652 "imageUri": "A String", # Optional. The public URI to an image file.
2653 },
2654 },
2655 ],
2656 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
2657 },
2658 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
2659 "rows": [ # Optional. Rows in this table of data.
2660 { # Row of TableCard.
2661 "cells": [ # Optional. List of cells that make up this row.
2662 { # Cell of TableCardRow.
2663 "text": "A String", # Required. Text in this cell.
2664 },
2665 ],
2666 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
2667 },
2668 ],
2669 "subtitle": "A String", # Optional. Subtitle to the title.
2670 "title": "A String", # Required. Title of the card.
2671 "image": { # The image response message. # Optional. Image which should be displayed on the card.
2672 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2673 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2674 "imageUri": "A String", # Optional. The public URI to an image file.
2675 },
2676 "columnProperties": [ # Optional. Display properties for the columns in this table.
2677 { # Column properties for TableCard.
2678 "header": "A String", # Required. Column heading.
2679 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
2680 },
2681 ],
2682 "buttons": [ # Optional. List of buttons for the card.
2683 { # The button object that appears at the bottom of a card.
2684 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2685 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2686 },
2687 "title": "A String", # Required. The title of the button.
2688 },
2689 ],
2690 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2691 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
2692 "items": [ # Required. Carousel items.
2693 { # An item in the carousel.
2694 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2695 # dialog.
2696 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2697 # item in dialog.
2698 "A String",
2699 ],
2700 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2701 # response is given.
2702 },
2703 "image": { # The image response message. # Optional. The image to display.
2704 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2705 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2706 "imageUri": "A String", # Optional. The public URI to an image file.
2707 },
2708 "description": "A String", # Optional. The body text of the card.
2709 "title": "A String", # Required. Title of the carousel item.
2710 },
2711 ],
2712 },
2713 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
2714 "items": [ # Required. List items.
2715 { # An item in the list.
2716 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
2717 # dialog.
2718 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2719 # item in dialog.
2720 "A String",
2721 ],
2722 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2723 # response is given.
2724 },
2725 "image": { # The image response message. # Optional. The image to display.
2726 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
2727 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
2728 "imageUri": "A String", # Optional. The public URI to an image file.
2729 },
2730 "description": "A String", # Optional. The main text describing the item.
2731 "title": "A String", # Required. The title of the list item.
2732 },
2733 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2734 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2735 "title": "A String", # Optional. The overall title of the list.
2736 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2737 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
2738 "suggestions": [ # Required. The list of suggested replies.
2739 { # The suggestion chip message that the user can tap to quickly post a reply
2740 # to the conversation.
2741 "title": "A String", # Required. The text shown the in the suggestion chip.
2742 },
2743 ],
2744 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2745 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
2746 "phoneNumber": "A String", # Required. The phone number to transfer the call to
2747 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
2748 #
2749 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
2750 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2751 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2752 "a_key": "", # Properties of the object.
2753 },
2754 "card": { # The card response message. # Displays a card.
2755 "buttons": [ # Optional. The collection of card buttons.
2756 { # Optional. Contains information about a button.
2757 "text": "A String", # Optional. The text to show on the button.
2758 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
2759 # open.
2760 },
2761 ],
2762 "title": "A String", # Optional. The title of the card.
2763 "subtitle": "A String", # Optional. The subtitle of the card.
2764 "imageUri": "A String", # Optional. The public URI to an image file for the card.
2765 },
2766 },
2767 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2768 "trainingPhrases": [ # Optional. The collection of examples that the agent is
2769 # trained on.
2770 { # Represents an example that the agent is trained on.
2771 "parts": [ # Required. The ordered list of training phrase parts.
2772 # The parts are concatenated in order to form the training phrase.
2773 #
2774 # Note: The API does not automatically annotate training phrases like the
2775 # Dialogflow Console does.
2776 #
2777 # Note: Do not forget to include whitespace at part boundaries,
2778 # so the training phrase is well formatted when the parts are concatenated.
2779 #
2780 # If the training phrase does not need to be annotated with parameters,
2781 # you just need a single part with only the Part.text field set.
2782 #
2783 # If you want to annotate the training phrase, you must create multiple
2784 # parts, where the fields of each part are populated in one of two ways:
2785 #
2786 # - `Part.text` is set to a part of the phrase that has no parameters.
2787 # - `Part.text` is set to a part of the phrase that you want to annotate,
2788 # and the `entity_type`, `alias`, and `user_defined` fields are all
2789 # set.
2790 { # Represents a part of a training phrase.
2791 "alias": "A String", # Optional. The parameter name for the value extracted from the
2792 # annotated part of the example.
2793 # This field is required for annotated parts of the training phrase.
2794 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
2795 # This field is required for annotated parts of the training phrase.
2796 "text": "A String", # Required. The text for this part.
2797 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
2798 # This field is set to true when the Dialogflow Console is used to
2799 # manually annotate the part. When creating an annotated part with the
2800 # API, you must set this to true.
2801 },
2802 ],
2803 "type": "A String", # Required. The type of the training phrase.
2804 "name": "A String", # Output only. The unique identifier of this training phrase.
2805 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
2806 # the intent. Each time a developer adds an existing sample by editing an
2807 # intent or training, this counter is increased.
2808 },
2809 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2810 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
2811 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
2812 "A String",
2813 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2814 "priority": 42, # The priority of this intent. Higher numbers represent higher
2815 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2816 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2817 # - If the supplied value is unspecified or 0, the service
2818 # translates the value to 500,000, which corresponds to the
2819 # `Normal` priority in the console.
2820 # - If the supplied value is negative, the intent is ignored
2821 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2822 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
2823 # followup intents. It identifies the correct followup intents chain for
2824 # this intent. We populate this field only in the output.
2825 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2826 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
2827 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
2828 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2829 "inputContextNames": [ # Optional. The list of context names required for this intent to be
2830 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2831 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2832 "A String",
2833 ],
2834 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
2835 # Note: If `ml_enabled` setting is set to false, then this intent is not
2836 # taken into account during inference in `ML ONLY` match mode. Also,
2837 # auto-markup in the UI is turned off.
2838 # DEPRECATED! Please use `ml_disabled` field instead.
2839 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
2840 # then the default value is determined as follows:
2841 # - Before April 15th, 2018 the default is:
2842 # ml_enabled = false / ml_disabled = true.
2843 # - After April 15th, 2018 the default is:
2844 # ml_enabled = true / ml_disabled = false.
2845 "action": "A String", # Optional. The name of the action associated with the intent.
2846 # Note: The action name must not contain whitespaces.
2847 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
2848 # is matched. Context messages in this collection should not set the
2849 # parameters field. Setting the `lifespan_count` to 0 will reset the context
2850 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2851 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2852 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2853 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2854 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
2855 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
2856 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2857 #
2858 # The `Context ID` is always converted to lowercase, may only contain
2859 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
2860 #
2861 # If `Environment ID` is not specified, we assume default 'draft'
2862 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2863 #
2864 # The following context names are reserved for internal use by Dialogflow.
2865 # You should not use these contexts or create contexts with these names:
2866 #
2867 # * `__system_counters__`
2868 # * `*_id_dialog_context`
2869 # * `*_dialog_params_size`
2870 "parameters": { # Optional. The collection of parameters associated with this context.
2871 #
2872 # Depending on your protocol or client library language, this is a
2873 # map, associative array, symbol table, dictionary, or JSON object
2874 # composed of a collection of (MapKey, MapValue) pairs:
2875 #
2876 # - MapKey type: string
2877 # - MapKey value: parameter name
2878 # - MapValue type:
2879 # - If parameter's entity type is a composite entity: map
2880 # - Else: string or number, depending on parameter value type
2881 # - MapValue value:
2882 # - If parameter's entity type is a composite entity:
2883 # map from composite entity property names to property values
2884 # - Else: parameter value
2885 "a_key": "", # Properties of the object.
2886 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2887 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2888 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2889 # immediately. Contexts expire automatically after 20 minutes if there
2890 # are no matching queries.
2891 },
2892 ],
2893 "events": [ # Optional. The collection of event names that trigger the intent.
2894 # If the collection of input contexts is not empty, all of the contexts must
2895 # 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^]2896 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2897 "A String",
2898 ],
2899 }</pre>
2900</div>
2901
2902<div class="method">
2903 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
2904 <pre>Deletes the specified intent and its direct or indirect followup intents.
2905
2906Args:
2907 name: string, Required. The name of the intent to delete. If this intent has direct or
2908indirect followup intents, we also delete them.
2909
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2910Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2911 x__xgafv: string, V1 error format.
2912 Allowed values
2913 1 - v1 error format
2914 2 - v2 error format
2915
2916Returns:
2917 An object of the form:
2918
2919 { # A generic empty message that you can re-use to avoid defining duplicated
2920 # empty messages in your APIs. A typical example is to use it as the request
2921 # or the response type of an API method. For instance:
2922 #
2923 # service Foo {
2924 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
2925 # }
2926 #
2927 # The JSON representation for `Empty` is empty JSON object `{}`.
2928 }</pre>
2929</div>
2930
2931<div class="method">
2932 <code class="details" id="get">get(name, languageCode=None, intentView=None, x__xgafv=None)</code>
2933 <pre>Retrieves the specified intent.
2934
2935Args:
2936 name: string, Required. The name of the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2937Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`. (required)
2938 languageCode: string, Optional. The language used to access language-specific data.
2939If not specified, the agent's default language is used.
2940For more information, see
2941[Multilingual intent and entity
2942data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2943 intentView: string, Optional. The resource view to apply to the returned intent.
2944 x__xgafv: string, V1 error format.
2945 Allowed values
2946 1 - v1 error format
2947 2 - v2 error format
2948
2949Returns:
2950 An object of the form:
2951
2952 { # Represents an intent.
2953 # Intents convert a number of user expressions or patterns into an action. An
2954 # action is an extraction of a user command or sentence semantics.
2955 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
2956 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
2957 # Note: If `ml_disabled` setting is set to true, then this intent is not
2958 # taken into account during inference in `ML ONLY` match mode. Also,
2959 # auto-markup in the UI is turned off.
2960 "displayName": "A String", # Required. The name of this intent.
2961 "name": "A String", # The unique identifier of this intent.
2962 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2963 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2964 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2965 "parameters": [ # Optional. The collection of parameters associated with the intent.
2966 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2967 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2968 "name": "A String", # The unique identifier of this parameter.
2969 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
2970 # result.
2971 # Default values can be extracted from contexts by using the following
2972 # syntax: `#context_name.parameter_name`.
2973 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
2974 # describes values of the parameter. If the parameter is
2975 # required, this must be provided.
2976 "value": "A String", # Optional. The definition of the parameter value. It can be:
2977 # - a constant string,
2978 # - a parameter value defined as `$parameter_name`,
2979 # - an original parameter value defined as `$parameter_name.original`,
2980 # - a parameter value from some context defined as
2981 # `#context_name.parameter_name`.
2982 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2983 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2984 "A String",
2985 ],
2986 "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^]2987 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
2988 # whether the intent cannot be completed without collecting the parameter
2989 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2990 },
2991 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2992 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
2993 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
2994 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2995 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
2996 # a direct or indirect parent. We populate this field only in the output.
2997 { # Represents a single followup intent in the chain.
2998 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2999 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3000 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3001 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3002 },
3003 ],
3004 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3005 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
3006 # chain of followup intents. You can set this field when creating an intent,
3007 # for example with CreateIntent or
3008 # BatchUpdateIntents, in order to make this
3009 # intent a followup intent.
3010 #
3011 # It identifies the parent followup intent.
3012 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3013 "messages": [ # Optional. The collection of rich messages corresponding to the
3014 # `Response` field in the Dialogflow console.
3015 { # Corresponds to the `Response` field in the Dialogflow console.
3016 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
3017 # This message in `QueryResult.fulfillment_messages` and
3018 # `WebhookResponse.fulfillment_messages` should contain only one
3019 # `SimpleResponse`.
3020 "simpleResponses": [ # Required. The list of simple responses.
3021 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3022 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
3023 # response to the user in the SSML format. Mutually exclusive with
3024 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3025 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
3026 # speech output. Mutually exclusive with ssml.
3027 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3028 },
3029 ],
3030 },
3031 "quickReplies": { # The quick replies response message. # Displays quick replies.
3032 "quickReplies": [ # Optional. The collection of quick replies.
3033 "A String",
3034 ],
3035 "title": "A String", # Optional. The title of the collection of quick replies.
3036 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3037 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
3038 #
3039 # RBM allows businesses to send enriched and branded versions of SMS. See
3040 # https://jibe.google.com/business-messaging.
3041 "text": "A String", # Required. Text sent and displayed to the user.
3042 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
3043 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
3044 # easily select/click a predefined response or perform an action (like
3045 # opening a web uri).
3046 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
3047 # can choose from the card.
3048 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
3049 # to send back to the agent (https://goo.gl/GXotJW).
3050 },
3051 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
3052 # (https://goo.gl/6GLJD2). If the user has an app installed that is
3053 # registered as the default handler for the URL, then this app will be
3054 # opened instead, and its icon will be used in the suggested action UI.
3055 "uri": "A String", # Required. The uri to open on the user device
3056 },
3057 "text": "A String", # Text to display alongside the action.
3058 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
3059 # but does not dial automatically (https://goo.gl/ergbB2).
3060 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
3061 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
3062 # format. An example of a correctly formatted phone number:
3063 # +15556767888.
3064 },
3065 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3066 # when the user taps the suggested action. This data will be also
3067 # forwarded to webhook to allow performing custom business logic.
3068 },
3069 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
3070 # instead of typing in their own response.
3071 "text": "A String", # Suggested reply text.
3072 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3073 # when the user taps the suggested reply. This data will be also
3074 # forwarded to webhook to allow performing custom business logic.
3075 },
3076 },
3077 ],
3078 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3079 "platform": "A String", # Optional. The platform that this message is intended for.
3080 "text": { # The text response message. # Returns a text response.
3081 "text": [ # Optional. The collection of the agent's responses.
3082 "A String",
3083 ],
3084 },
3085 "image": { # The image response message. # Displays an image.
3086 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3087 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3088 "imageUri": "A String", # Optional. The public URI to an image file.
3089 },
3090 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
3091 # Telephony Gateway.
3092 #
3093 # Telephony Gateway takes the synthesizer settings from
3094 # `DetectIntentResponse.output_audio_config` which can either be set
3095 # at request-level or can come from the agent-level synthesizer config.
3096 "ssml": "A String", # The SSML to be synthesized. For more information, see
3097 # [SSML](https://developers.google.com/actions/reference/ssml).
3098 "text": "A String", # The raw text to be synthesized.
3099 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3100 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
3101 #
3102 # Rich cards allow you to respond to users with more vivid content, e.g.
3103 # with media and suggestions.
3104 #
3105 # For more details about RBM rich cards, please see:
3106 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
3107 # If you want to show a single card with more control over the layout,
3108 # please use RbmStandaloneCard instead.
3109 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
3110 # 2 cards and at most 10.
3111 { # Rich Business Messaging (RBM) Card content
3112 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
3113 # be set. Media (image, GIF or a video) to include in the card.
3114 # The following media-types are currently supported:
3115 #
3116 # Image Types
3117 #
3118 # * image/jpeg
3119 # * image/jpg'
3120 # * image/gif
3121 # * image/png
3122 #
3123 # Video Types
3124 #
3125 # * video/h263
3126 # * video/m4v
3127 # * video/mp4
3128 # * video/mpeg
3129 # * video/mpeg4
3130 # * video/webm
3131 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
3132 # determines the MIME type of the file from the content-type field in
3133 # the HTTP headers when the platform fetches the file. The content-type
3134 # field must be present and accurate in the HTTP response from the URL.
3135 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
3136 # provide a thumbnail URI, the RBM platform displays a blank
3137 # placeholder thumbnail until the user's device downloads the file.
3138 # Depending on the user's setting, the file may not download
3139 # automatically and may require the user to tap a download button.
3140 "height": "A String", # Required for cards with vertical orientation. The height of the media
3141 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
3142 # For a standalone card with horizontal layout, height is not
3143 # customizable, and this field is ignored.
3144 },
3145 "suggestions": [ # Optional. List of suggestions to include in the card.
3146 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
3147 # easily select/click a predefined response or perform an action (like
3148 # opening a web uri).
3149 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
3150 # can choose from the card.
3151 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
3152 # to send back to the agent (https://goo.gl/GXotJW).
3153 },
3154 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
3155 # (https://goo.gl/6GLJD2). If the user has an app installed that is
3156 # registered as the default handler for the URL, then this app will be
3157 # opened instead, and its icon will be used in the suggested action UI.
3158 "uri": "A String", # Required. The uri to open on the user device
3159 },
3160 "text": "A String", # Text to display alongside the action.
3161 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
3162 # but does not dial automatically (https://goo.gl/ergbB2).
3163 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
3164 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
3165 # format. An example of a correctly formatted phone number:
3166 # +15556767888.
3167 },
3168 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3169 # when the user taps the suggested action. This data will be also
3170 # forwarded to webhook to allow performing custom business logic.
3171 },
3172 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
3173 # instead of typing in their own response.
3174 "text": "A String", # Suggested reply text.
3175 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3176 # when the user taps the suggested reply. This data will be also
3177 # forwarded to webhook to allow performing custom business logic.
3178 },
3179 },
3180 ],
3181 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
3182 #
3183 # At least one of the title, description or media must be set.
3184 "title": "A String", # Optional. Title of the card (at most 200 bytes).
3185 #
3186 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3187 },
3188 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3189 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3190 },
3191 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
3192 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
3193 # play, e.g., "gs://bucket/object". The object must contain a single
3194 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
3195 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3196 # This object must be readable by the `service-&lt;Project
3197 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
3198 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3199 # (usually the same as the Dialogflow agent project). If the Google Cloud
3200 # Storage bucket is in the Telephony Gateway project, this permission is
3201 # added by default when enabling the Dialogflow V2 API.
3202 #
3203 # For audio from other sources, consider using the
3204 # `TelephonySynthesizeSpeech` message with SSML.
3205 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3206 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
3207 #
3208 # Rich cards allow you to respond to users with more vivid content, e.g.
3209 # with media and suggestions.
3210 #
3211 # For more details about RBM rich cards, please see:
3212 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
3213 # You can group multiple rich cards into one using RbmCarouselCard but
3214 # carousel cards will give you less control over the card layout.
3215 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
3216 # Image preview alignment for standalone cards with horizontal layout.
3217 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
3218 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
3219 # be set. Media (image, GIF or a video) to include in the card.
3220 # The following media-types are currently supported:
3221 #
3222 # Image Types
3223 #
3224 # * image/jpeg
3225 # * image/jpg'
3226 # * image/gif
3227 # * image/png
3228 #
3229 # Video Types
3230 #
3231 # * video/h263
3232 # * video/m4v
3233 # * video/mp4
3234 # * video/mpeg
3235 # * video/mpeg4
3236 # * video/webm
3237 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
3238 # determines the MIME type of the file from the content-type field in
3239 # the HTTP headers when the platform fetches the file. The content-type
3240 # field must be present and accurate in the HTTP response from the URL.
3241 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
3242 # provide a thumbnail URI, the RBM platform displays a blank
3243 # placeholder thumbnail until the user's device downloads the file.
3244 # Depending on the user's setting, the file may not download
3245 # automatically and may require the user to tap a download button.
3246 "height": "A String", # Required for cards with vertical orientation. The height of the media
3247 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
3248 # For a standalone card with horizontal layout, height is not
3249 # customizable, and this field is ignored.
3250 },
3251 "suggestions": [ # Optional. List of suggestions to include in the card.
3252 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
3253 # easily select/click a predefined response or perform an action (like
3254 # opening a web uri).
3255 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
3256 # can choose from the card.
3257 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
3258 # to send back to the agent (https://goo.gl/GXotJW).
3259 },
3260 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
3261 # (https://goo.gl/6GLJD2). If the user has an app installed that is
3262 # registered as the default handler for the URL, then this app will be
3263 # opened instead, and its icon will be used in the suggested action UI.
3264 "uri": "A String", # Required. The uri to open on the user device
3265 },
3266 "text": "A String", # Text to display alongside the action.
3267 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
3268 # but does not dial automatically (https://goo.gl/ergbB2).
3269 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
3270 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
3271 # format. An example of a correctly formatted phone number:
3272 # +15556767888.
3273 },
3274 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3275 # when the user taps the suggested action. This data will be also
3276 # forwarded to webhook to allow performing custom business logic.
3277 },
3278 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
3279 # instead of typing in their own response.
3280 "text": "A String", # Suggested reply text.
3281 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3282 # when the user taps the suggested reply. This data will be also
3283 # forwarded to webhook to allow performing custom business logic.
3284 },
3285 },
3286 ],
3287 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
3288 #
3289 # At least one of the title, description or media must be set.
3290 "title": "A String", # Optional. Title of the card (at most 200 bytes).
3291 #
3292 # At least one of the title, description or media must be set.
3293 },
3294 "cardOrientation": "A String", # Required. Orientation of the card.
3295 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3296 "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.
3297 # or website associated with this agent.
3298 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
3299 # suggestion chip.
3300 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
3301 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3302 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
3303 # https://developers.google.com/actions/assistant/responses#browsing_carousel
3304 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
3305 # items, maximum of ten.
3306 { # Browsing carousel tile
3307 "image": { # The image response message. # Optional. Hero image for the carousel item.
3308 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3309 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3310 "imageUri": "A String", # Optional. The public URI to an image file.
3311 },
3312 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
3313 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
3314 # text.
3315 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
3316 "url": "A String", # Required. URL
3317 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
3318 # the URL. Defaults to opening via web browser.
3319 },
3320 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
3321 # Card. Maximum of one line of text.
3322 },
3323 ],
3324 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
3325 # items.
3326 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3327 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
3328 "buttons": [ # Optional. The collection of card buttons.
3329 { # The button object that appears at the bottom of a card.
3330 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
3331 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
3332 },
3333 "title": "A String", # Required. The title of the button.
3334 },
3335 ],
3336 "formattedText": "A String", # Required, unless image is present. The body text of the card.
3337 "image": { # The image response message. # Optional. The image for the card.
3338 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3339 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3340 "imageUri": "A String", # Optional. The public URI to an image file.
3341 },
3342 "subtitle": "A String", # Optional. The subtitle of the card.
3343 "title": "A String", # Optional. The title of the card.
3344 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3345 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
3346 "mediaObjects": [ # Required. List of media objects.
3347 { # Response media object for media content card.
3348 "contentUrl": "A String", # Required. Url where the media is stored.
3349 "description": "A String", # Optional. Description of media card.
3350 "name": "A String", # Required. Name of media card.
3351 "largeImage": { # The image response message. # Optional. Image to display above media content.
3352 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3353 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3354 "imageUri": "A String", # Optional. The public URI to an image file.
3355 },
3356 "icon": { # The image response message. # Optional. Icon to display above media content.
3357 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3358 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3359 "imageUri": "A String", # Optional. The public URI to an image file.
3360 },
3361 },
3362 ],
3363 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
3364 },
3365 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
3366 "rows": [ # Optional. Rows in this table of data.
3367 { # Row of TableCard.
3368 "cells": [ # Optional. List of cells that make up this row.
3369 { # Cell of TableCardRow.
3370 "text": "A String", # Required. Text in this cell.
3371 },
3372 ],
3373 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
3374 },
3375 ],
3376 "subtitle": "A String", # Optional. Subtitle to the title.
3377 "title": "A String", # Required. Title of the card.
3378 "image": { # The image response message. # Optional. Image which should be displayed on the card.
3379 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3380 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3381 "imageUri": "A String", # Optional. The public URI to an image file.
3382 },
3383 "columnProperties": [ # Optional. Display properties for the columns in this table.
3384 { # Column properties for TableCard.
3385 "header": "A String", # Required. Column heading.
3386 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
3387 },
3388 ],
3389 "buttons": [ # Optional. List of buttons for the card.
3390 { # The button object that appears at the bottom of a card.
3391 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
3392 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
3393 },
3394 "title": "A String", # Required. The title of the button.
3395 },
3396 ],
3397 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3398 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
3399 "items": [ # Required. Carousel items.
3400 { # An item in the carousel.
3401 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
3402 # dialog.
3403 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
3404 # item in dialog.
3405 "A String",
3406 ],
3407 "key": "A String", # Required. A unique key that will be sent back to the agent if this
3408 # response is given.
3409 },
3410 "image": { # The image response message. # Optional. The image to display.
3411 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3412 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3413 "imageUri": "A String", # Optional. The public URI to an image file.
3414 },
3415 "description": "A String", # Optional. The body text of the card.
3416 "title": "A String", # Required. Title of the carousel item.
3417 },
3418 ],
3419 },
3420 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
3421 "items": [ # Required. List items.
3422 { # An item in the list.
3423 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
3424 # dialog.
3425 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
3426 # item in dialog.
3427 "A String",
3428 ],
3429 "key": "A String", # Required. A unique key that will be sent back to the agent if this
3430 # response is given.
3431 },
3432 "image": { # The image response message. # Optional. The image to display.
3433 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3434 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3435 "imageUri": "A String", # Optional. The public URI to an image file.
3436 },
3437 "description": "A String", # Optional. The main text describing the item.
3438 "title": "A String", # Required. The title of the list item.
3439 },
3440 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3441 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3442 "title": "A String", # Optional. The overall title of the list.
3443 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3444 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
3445 "suggestions": [ # Required. The list of suggested replies.
3446 { # The suggestion chip message that the user can tap to quickly post a reply
3447 # to the conversation.
3448 "title": "A String", # Required. The text shown the in the suggestion chip.
3449 },
3450 ],
3451 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3452 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
3453 "phoneNumber": "A String", # Required. The phone number to transfer the call to
3454 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
3455 #
3456 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
3457 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3458 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3459 "a_key": "", # Properties of the object.
3460 },
3461 "card": { # The card response message. # Displays a card.
3462 "buttons": [ # Optional. The collection of card buttons.
3463 { # Optional. Contains information about a button.
3464 "text": "A String", # Optional. The text to show on the button.
3465 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
3466 # open.
3467 },
3468 ],
3469 "title": "A String", # Optional. The title of the card.
3470 "subtitle": "A String", # Optional. The subtitle of the card.
3471 "imageUri": "A String", # Optional. The public URI to an image file for the card.
3472 },
3473 },
3474 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3475 "trainingPhrases": [ # Optional. The collection of examples that the agent is
3476 # trained on.
3477 { # Represents an example that the agent is trained on.
3478 "parts": [ # Required. The ordered list of training phrase parts.
3479 # The parts are concatenated in order to form the training phrase.
3480 #
3481 # Note: The API does not automatically annotate training phrases like the
3482 # Dialogflow Console does.
3483 #
3484 # Note: Do not forget to include whitespace at part boundaries,
3485 # so the training phrase is well formatted when the parts are concatenated.
3486 #
3487 # If the training phrase does not need to be annotated with parameters,
3488 # you just need a single part with only the Part.text field set.
3489 #
3490 # If you want to annotate the training phrase, you must create multiple
3491 # parts, where the fields of each part are populated in one of two ways:
3492 #
3493 # - `Part.text` is set to a part of the phrase that has no parameters.
3494 # - `Part.text` is set to a part of the phrase that you want to annotate,
3495 # and the `entity_type`, `alias`, and `user_defined` fields are all
3496 # set.
3497 { # Represents a part of a training phrase.
3498 "alias": "A String", # Optional. The parameter name for the value extracted from the
3499 # annotated part of the example.
3500 # This field is required for annotated parts of the training phrase.
3501 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
3502 # This field is required for annotated parts of the training phrase.
3503 "text": "A String", # Required. The text for this part.
3504 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
3505 # This field is set to true when the Dialogflow Console is used to
3506 # manually annotate the part. When creating an annotated part with the
3507 # API, you must set this to true.
3508 },
3509 ],
3510 "type": "A String", # Required. The type of the training phrase.
3511 "name": "A String", # Output only. The unique identifier of this training phrase.
3512 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
3513 # the intent. Each time a developer adds an existing sample by editing an
3514 # intent or training, this counter is increased.
3515 },
3516 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3517 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
3518 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
3519 "A String",
3520 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3521 "priority": 42, # The priority of this intent. Higher numbers represent higher
3522 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3523 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3524 # - If the supplied value is unspecified or 0, the service
3525 # translates the value to 500,000, which corresponds to the
3526 # `Normal` priority in the console.
3527 # - If the supplied value is negative, the intent is ignored
3528 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3529 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
3530 # followup intents. It identifies the correct followup intents chain for
3531 # this intent. We populate this field only in the output.
3532 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3533 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
3534 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
3535 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3536 "inputContextNames": [ # Optional. The list of context names required for this intent to be
3537 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3538 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3539 "A String",
3540 ],
3541 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
3542 # Note: If `ml_enabled` setting is set to false, then this intent is not
3543 # taken into account during inference in `ML ONLY` match mode. Also,
3544 # auto-markup in the UI is turned off.
3545 # DEPRECATED! Please use `ml_disabled` field instead.
3546 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
3547 # then the default value is determined as follows:
3548 # - Before April 15th, 2018 the default is:
3549 # ml_enabled = false / ml_disabled = true.
3550 # - After April 15th, 2018 the default is:
3551 # ml_enabled = true / ml_disabled = false.
3552 "action": "A String", # Optional. The name of the action associated with the intent.
3553 # Note: The action name must not contain whitespaces.
3554 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
3555 # is matched. Context messages in this collection should not set the
3556 # parameters field. Setting the `lifespan_count` to 0 will reset the context
3557 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3558 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3559 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3560 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3561 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
3562 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
3563 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3564 #
3565 # The `Context ID` is always converted to lowercase, may only contain
3566 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
3567 #
3568 # If `Environment ID` is not specified, we assume default 'draft'
3569 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3570 #
3571 # The following context names are reserved for internal use by Dialogflow.
3572 # You should not use these contexts or create contexts with these names:
3573 #
3574 # * `__system_counters__`
3575 # * `*_id_dialog_context`
3576 # * `*_dialog_params_size`
3577 "parameters": { # Optional. The collection of parameters associated with this context.
3578 #
3579 # Depending on your protocol or client library language, this is a
3580 # map, associative array, symbol table, dictionary, or JSON object
3581 # composed of a collection of (MapKey, MapValue) pairs:
3582 #
3583 # - MapKey type: string
3584 # - MapKey value: parameter name
3585 # - MapValue type:
3586 # - If parameter's entity type is a composite entity: map
3587 # - Else: string or number, depending on parameter value type
3588 # - MapValue value:
3589 # - If parameter's entity type is a composite entity:
3590 # map from composite entity property names to property values
3591 # - Else: parameter value
3592 "a_key": "", # Properties of the object.
3593 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3594 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3595 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3596 # immediately. Contexts expire automatically after 20 minutes if there
3597 # are no matching queries.
3598 },
3599 ],
3600 "events": [ # Optional. The collection of event names that trigger the intent.
3601 # If the collection of input contexts is not empty, all of the contexts must
3602 # 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^]3603 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3604 "A String",
3605 ],
3606 }</pre>
3607</div>
3608
3609<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3610 <code class="details" id="list">list(parent, languageCode=None, pageSize=None, intentView=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3611 <pre>Returns the list of all intents in the specified agent.
3612
3613Args:
3614 parent: string, Required. The agent to list all intents from.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3615Format: `projects/&lt;Project ID&gt;/agent`. (required)
3616 languageCode: string, Optional. The language used to access language-specific data.
3617If not specified, the agent's default language is used.
3618For more information, see
3619[Multilingual intent and entity
3620data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3621 pageSize: integer, Optional. The maximum number of items to return in a single page. By
3622default 100 and at most 1000.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3623 intentView: string, Optional. The resource view to apply to the returned intent.
3624 pageToken: string, Optional. The next_page_token value returned from a previous list request.
3625 x__xgafv: string, V1 error format.
3626 Allowed values
3627 1 - v1 error format
3628 2 - v2 error format
3629
3630Returns:
3631 An object of the form:
3632
3633 { # The response message for Intents.ListIntents.
3634 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
3635 # more results in the list.
3636 "intents": [ # The list of agent intents. There will be a maximum number of items
3637 # returned based on the page_size field in the request.
3638 { # Represents an intent.
3639 # Intents convert a number of user expressions or patterns into an action. An
3640 # action is an extraction of a user command or sentence semantics.
3641 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
3642 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
3643 # Note: If `ml_disabled` setting is set to true, then this intent is not
3644 # taken into account during inference in `ML ONLY` match mode. Also,
3645 # auto-markup in the UI is turned off.
3646 "displayName": "A String", # Required. The name of this intent.
3647 "name": "A String", # The unique identifier of this intent.
3648 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
3649 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3650 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3651 "parameters": [ # Optional. The collection of parameters associated with the intent.
3652 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3653 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3654 "name": "A String", # The unique identifier of this parameter.
3655 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
3656 # result.
3657 # Default values can be extracted from contexts by using the following
3658 # syntax: `#context_name.parameter_name`.
3659 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
3660 # describes values of the parameter. If the parameter is
3661 # required, this must be provided.
3662 "value": "A String", # Optional. The definition of the parameter value. It can be:
3663 # - a constant string,
3664 # - a parameter value defined as `$parameter_name`,
3665 # - an original parameter value defined as `$parameter_name.original`,
3666 # - a parameter value from some context defined as
3667 # `#context_name.parameter_name`.
3668 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3669 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3670 "A String",
3671 ],
3672 "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^]3673 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
3674 # whether the intent cannot be completed without collecting the parameter
3675 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3676 },
3677 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3678 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
3679 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
3680 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3681 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
3682 # a direct or indirect parent. We populate this field only in the output.
3683 { # Represents a single followup intent in the chain.
3684 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3685 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3686 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3687 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3688 },
3689 ],
3690 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3691 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
3692 # chain of followup intents. You can set this field when creating an intent,
3693 # for example with CreateIntent or
3694 # BatchUpdateIntents, in order to make this
3695 # intent a followup intent.
3696 #
3697 # It identifies the parent followup intent.
3698 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3699 "messages": [ # Optional. The collection of rich messages corresponding to the
3700 # `Response` field in the Dialogflow console.
3701 { # Corresponds to the `Response` field in the Dialogflow console.
3702 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
3703 # This message in `QueryResult.fulfillment_messages` and
3704 # `WebhookResponse.fulfillment_messages` should contain only one
3705 # `SimpleResponse`.
3706 "simpleResponses": [ # Required. The list of simple responses.
3707 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3708 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
3709 # response to the user in the SSML format. Mutually exclusive with
3710 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3711 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
3712 # speech output. Mutually exclusive with ssml.
3713 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3714 },
3715 ],
3716 },
3717 "quickReplies": { # The quick replies response message. # Displays quick replies.
3718 "quickReplies": [ # Optional. The collection of quick replies.
3719 "A String",
3720 ],
3721 "title": "A String", # Optional. The title of the collection of quick replies.
3722 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3723 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
3724 #
3725 # RBM allows businesses to send enriched and branded versions of SMS. See
3726 # https://jibe.google.com/business-messaging.
3727 "text": "A String", # Required. Text sent and displayed to the user.
3728 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
3729 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
3730 # easily select/click a predefined response or perform an action (like
3731 # opening a web uri).
3732 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
3733 # can choose from the card.
3734 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
3735 # to send back to the agent (https://goo.gl/GXotJW).
3736 },
3737 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
3738 # (https://goo.gl/6GLJD2). If the user has an app installed that is
3739 # registered as the default handler for the URL, then this app will be
3740 # opened instead, and its icon will be used in the suggested action UI.
3741 "uri": "A String", # Required. The uri to open on the user device
3742 },
3743 "text": "A String", # Text to display alongside the action.
3744 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
3745 # but does not dial automatically (https://goo.gl/ergbB2).
3746 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
3747 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
3748 # format. An example of a correctly formatted phone number:
3749 # +15556767888.
3750 },
3751 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3752 # when the user taps the suggested action. This data will be also
3753 # forwarded to webhook to allow performing custom business logic.
3754 },
3755 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
3756 # instead of typing in their own response.
3757 "text": "A String", # Suggested reply text.
3758 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3759 # when the user taps the suggested reply. This data will be also
3760 # forwarded to webhook to allow performing custom business logic.
3761 },
3762 },
3763 ],
3764 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3765 "platform": "A String", # Optional. The platform that this message is intended for.
3766 "text": { # The text response message. # Returns a text response.
3767 "text": [ # Optional. The collection of the agent's responses.
3768 "A String",
3769 ],
3770 },
3771 "image": { # The image response message. # Displays an image.
3772 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3773 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3774 "imageUri": "A String", # Optional. The public URI to an image file.
3775 },
3776 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
3777 # Telephony Gateway.
3778 #
3779 # Telephony Gateway takes the synthesizer settings from
3780 # `DetectIntentResponse.output_audio_config` which can either be set
3781 # at request-level or can come from the agent-level synthesizer config.
3782 "ssml": "A String", # The SSML to be synthesized. For more information, see
3783 # [SSML](https://developers.google.com/actions/reference/ssml).
3784 "text": "A String", # The raw text to be synthesized.
3785 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3786 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
3787 #
3788 # Rich cards allow you to respond to users with more vivid content, e.g.
3789 # with media and suggestions.
3790 #
3791 # For more details about RBM rich cards, please see:
3792 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
3793 # If you want to show a single card with more control over the layout,
3794 # please use RbmStandaloneCard instead.
3795 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
3796 # 2 cards and at most 10.
3797 { # Rich Business Messaging (RBM) Card content
3798 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
3799 # be set. Media (image, GIF or a video) to include in the card.
3800 # The following media-types are currently supported:
3801 #
3802 # Image Types
3803 #
3804 # * image/jpeg
3805 # * image/jpg'
3806 # * image/gif
3807 # * image/png
3808 #
3809 # Video Types
3810 #
3811 # * video/h263
3812 # * video/m4v
3813 # * video/mp4
3814 # * video/mpeg
3815 # * video/mpeg4
3816 # * video/webm
3817 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
3818 # determines the MIME type of the file from the content-type field in
3819 # the HTTP headers when the platform fetches the file. The content-type
3820 # field must be present and accurate in the HTTP response from the URL.
3821 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
3822 # provide a thumbnail URI, the RBM platform displays a blank
3823 # placeholder thumbnail until the user's device downloads the file.
3824 # Depending on the user's setting, the file may not download
3825 # automatically and may require the user to tap a download button.
3826 "height": "A String", # Required for cards with vertical orientation. The height of the media
3827 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
3828 # For a standalone card with horizontal layout, height is not
3829 # customizable, and this field is ignored.
3830 },
3831 "suggestions": [ # Optional. List of suggestions to include in the card.
3832 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
3833 # easily select/click a predefined response or perform an action (like
3834 # opening a web uri).
3835 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
3836 # can choose from the card.
3837 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
3838 # to send back to the agent (https://goo.gl/GXotJW).
3839 },
3840 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
3841 # (https://goo.gl/6GLJD2). If the user has an app installed that is
3842 # registered as the default handler for the URL, then this app will be
3843 # opened instead, and its icon will be used in the suggested action UI.
3844 "uri": "A String", # Required. The uri to open on the user device
3845 },
3846 "text": "A String", # Text to display alongside the action.
3847 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
3848 # but does not dial automatically (https://goo.gl/ergbB2).
3849 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
3850 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
3851 # format. An example of a correctly formatted phone number:
3852 # +15556767888.
3853 },
3854 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3855 # when the user taps the suggested action. This data will be also
3856 # forwarded to webhook to allow performing custom business logic.
3857 },
3858 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
3859 # instead of typing in their own response.
3860 "text": "A String", # Suggested reply text.
3861 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3862 # when the user taps the suggested reply. This data will be also
3863 # forwarded to webhook to allow performing custom business logic.
3864 },
3865 },
3866 ],
3867 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
3868 #
3869 # At least one of the title, description or media must be set.
3870 "title": "A String", # Optional. Title of the card (at most 200 bytes).
3871 #
3872 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3873 },
3874 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3875 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3876 },
3877 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
3878 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
3879 # play, e.g., "gs://bucket/object". The object must contain a single
3880 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
3881 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3882 # This object must be readable by the `service-&lt;Project
3883 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
3884 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3885 # (usually the same as the Dialogflow agent project). If the Google Cloud
3886 # Storage bucket is in the Telephony Gateway project, this permission is
3887 # added by default when enabling the Dialogflow V2 API.
3888 #
3889 # For audio from other sources, consider using the
3890 # `TelephonySynthesizeSpeech` message with SSML.
3891 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3892 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
3893 #
3894 # Rich cards allow you to respond to users with more vivid content, e.g.
3895 # with media and suggestions.
3896 #
3897 # For more details about RBM rich cards, please see:
3898 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
3899 # You can group multiple rich cards into one using RbmCarouselCard but
3900 # carousel cards will give you less control over the card layout.
3901 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
3902 # Image preview alignment for standalone cards with horizontal layout.
3903 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
3904 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
3905 # be set. Media (image, GIF or a video) to include in the card.
3906 # The following media-types are currently supported:
3907 #
3908 # Image Types
3909 #
3910 # * image/jpeg
3911 # * image/jpg'
3912 # * image/gif
3913 # * image/png
3914 #
3915 # Video Types
3916 #
3917 # * video/h263
3918 # * video/m4v
3919 # * video/mp4
3920 # * video/mpeg
3921 # * video/mpeg4
3922 # * video/webm
3923 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
3924 # determines the MIME type of the file from the content-type field in
3925 # the HTTP headers when the platform fetches the file. The content-type
3926 # field must be present and accurate in the HTTP response from the URL.
3927 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
3928 # provide a thumbnail URI, the RBM platform displays a blank
3929 # placeholder thumbnail until the user's device downloads the file.
3930 # Depending on the user's setting, the file may not download
3931 # automatically and may require the user to tap a download button.
3932 "height": "A String", # Required for cards with vertical orientation. The height of the media
3933 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
3934 # For a standalone card with horizontal layout, height is not
3935 # customizable, and this field is ignored.
3936 },
3937 "suggestions": [ # Optional. List of suggestions to include in the card.
3938 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
3939 # easily select/click a predefined response or perform an action (like
3940 # opening a web uri).
3941 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
3942 # can choose from the card.
3943 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
3944 # to send back to the agent (https://goo.gl/GXotJW).
3945 },
3946 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
3947 # (https://goo.gl/6GLJD2). If the user has an app installed that is
3948 # registered as the default handler for the URL, then this app will be
3949 # opened instead, and its icon will be used in the suggested action UI.
3950 "uri": "A String", # Required. The uri to open on the user device
3951 },
3952 "text": "A String", # Text to display alongside the action.
3953 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
3954 # but does not dial automatically (https://goo.gl/ergbB2).
3955 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
3956 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
3957 # format. An example of a correctly formatted phone number:
3958 # +15556767888.
3959 },
3960 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3961 # when the user taps the suggested action. This data will be also
3962 # forwarded to webhook to allow performing custom business logic.
3963 },
3964 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
3965 # instead of typing in their own response.
3966 "text": "A String", # Suggested reply text.
3967 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
3968 # when the user taps the suggested reply. This data will be also
3969 # forwarded to webhook to allow performing custom business logic.
3970 },
3971 },
3972 ],
3973 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
3974 #
3975 # At least one of the title, description or media must be set.
3976 "title": "A String", # Optional. Title of the card (at most 200 bytes).
3977 #
3978 # At least one of the title, description or media must be set.
3979 },
3980 "cardOrientation": "A String", # Required. Orientation of the card.
3981 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3982 "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.
3983 # or website associated with this agent.
3984 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
3985 # suggestion chip.
3986 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
3987 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3988 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
3989 # https://developers.google.com/actions/assistant/responses#browsing_carousel
3990 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
3991 # items, maximum of ten.
3992 { # Browsing carousel tile
3993 "image": { # The image response message. # Optional. Hero image for the carousel item.
3994 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
3995 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
3996 "imageUri": "A String", # Optional. The public URI to an image file.
3997 },
3998 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
3999 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
4000 # text.
4001 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
4002 "url": "A String", # Required. URL
4003 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
4004 # the URL. Defaults to opening via web browser.
4005 },
4006 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
4007 # Card. Maximum of one line of text.
4008 },
4009 ],
4010 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
4011 # items.
4012 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4013 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
4014 "buttons": [ # Optional. The collection of card buttons.
4015 { # The button object that appears at the bottom of a card.
4016 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
4017 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
4018 },
4019 "title": "A String", # Required. The title of the button.
4020 },
4021 ],
4022 "formattedText": "A String", # Required, unless image is present. The body text of the card.
4023 "image": { # The image response message. # Optional. The image for the card.
4024 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4025 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4026 "imageUri": "A String", # Optional. The public URI to an image file.
4027 },
4028 "subtitle": "A String", # Optional. The subtitle of the card.
4029 "title": "A String", # Optional. The title of the card.
4030 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4031 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
4032 "mediaObjects": [ # Required. List of media objects.
4033 { # Response media object for media content card.
4034 "contentUrl": "A String", # Required. Url where the media is stored.
4035 "description": "A String", # Optional. Description of media card.
4036 "name": "A String", # Required. Name of media card.
4037 "largeImage": { # The image response message. # Optional. Image to display above media content.
4038 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4039 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4040 "imageUri": "A String", # Optional. The public URI to an image file.
4041 },
4042 "icon": { # The image response message. # Optional. Icon to display above media content.
4043 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4044 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4045 "imageUri": "A String", # Optional. The public URI to an image file.
4046 },
4047 },
4048 ],
4049 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
4050 },
4051 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
4052 "rows": [ # Optional. Rows in this table of data.
4053 { # Row of TableCard.
4054 "cells": [ # Optional. List of cells that make up this row.
4055 { # Cell of TableCardRow.
4056 "text": "A String", # Required. Text in this cell.
4057 },
4058 ],
4059 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
4060 },
4061 ],
4062 "subtitle": "A String", # Optional. Subtitle to the title.
4063 "title": "A String", # Required. Title of the card.
4064 "image": { # The image response message. # Optional. Image which should be displayed on the card.
4065 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4066 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4067 "imageUri": "A String", # Optional. The public URI to an image file.
4068 },
4069 "columnProperties": [ # Optional. Display properties for the columns in this table.
4070 { # Column properties for TableCard.
4071 "header": "A String", # Required. Column heading.
4072 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
4073 },
4074 ],
4075 "buttons": [ # Optional. List of buttons for the card.
4076 { # The button object that appears at the bottom of a card.
4077 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
4078 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
4079 },
4080 "title": "A String", # Required. The title of the button.
4081 },
4082 ],
4083 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4084 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
4085 "items": [ # Required. Carousel items.
4086 { # An item in the carousel.
4087 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
4088 # dialog.
4089 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
4090 # item in dialog.
4091 "A String",
4092 ],
4093 "key": "A String", # Required. A unique key that will be sent back to the agent if this
4094 # response is given.
4095 },
4096 "image": { # The image response message. # Optional. The image to display.
4097 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4098 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4099 "imageUri": "A String", # Optional. The public URI to an image file.
4100 },
4101 "description": "A String", # Optional. The body text of the card.
4102 "title": "A String", # Required. Title of the carousel item.
4103 },
4104 ],
4105 },
4106 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
4107 "items": [ # Required. List items.
4108 { # An item in the list.
4109 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
4110 # dialog.
4111 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
4112 # item in dialog.
4113 "A String",
4114 ],
4115 "key": "A String", # Required. A unique key that will be sent back to the agent if this
4116 # response is given.
4117 },
4118 "image": { # The image response message. # Optional. The image to display.
4119 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4120 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4121 "imageUri": "A String", # Optional. The public URI to an image file.
4122 },
4123 "description": "A String", # Optional. The main text describing the item.
4124 "title": "A String", # Required. The title of the list item.
4125 },
4126 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4127 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4128 "title": "A String", # Optional. The overall title of the list.
4129 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4130 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
4131 "suggestions": [ # Required. The list of suggested replies.
4132 { # The suggestion chip message that the user can tap to quickly post a reply
4133 # to the conversation.
4134 "title": "A String", # Required. The text shown the in the suggestion chip.
4135 },
4136 ],
4137 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4138 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
4139 "phoneNumber": "A String", # Required. The phone number to transfer the call to
4140 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
4141 #
4142 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
4143 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4144 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4145 "a_key": "", # Properties of the object.
4146 },
4147 "card": { # The card response message. # Displays a card.
4148 "buttons": [ # Optional. The collection of card buttons.
4149 { # Optional. Contains information about a button.
4150 "text": "A String", # Optional. The text to show on the button.
4151 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
4152 # open.
4153 },
4154 ],
4155 "title": "A String", # Optional. The title of the card.
4156 "subtitle": "A String", # Optional. The subtitle of the card.
4157 "imageUri": "A String", # Optional. The public URI to an image file for the card.
4158 },
4159 },
4160 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4161 "trainingPhrases": [ # Optional. The collection of examples that the agent is
4162 # trained on.
4163 { # Represents an example that the agent is trained on.
4164 "parts": [ # Required. The ordered list of training phrase parts.
4165 # The parts are concatenated in order to form the training phrase.
4166 #
4167 # Note: The API does not automatically annotate training phrases like the
4168 # Dialogflow Console does.
4169 #
4170 # Note: Do not forget to include whitespace at part boundaries,
4171 # so the training phrase is well formatted when the parts are concatenated.
4172 #
4173 # If the training phrase does not need to be annotated with parameters,
4174 # you just need a single part with only the Part.text field set.
4175 #
4176 # If you want to annotate the training phrase, you must create multiple
4177 # parts, where the fields of each part are populated in one of two ways:
4178 #
4179 # - `Part.text` is set to a part of the phrase that has no parameters.
4180 # - `Part.text` is set to a part of the phrase that you want to annotate,
4181 # and the `entity_type`, `alias`, and `user_defined` fields are all
4182 # set.
4183 { # Represents a part of a training phrase.
4184 "alias": "A String", # Optional. The parameter name for the value extracted from the
4185 # annotated part of the example.
4186 # This field is required for annotated parts of the training phrase.
4187 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
4188 # This field is required for annotated parts of the training phrase.
4189 "text": "A String", # Required. The text for this part.
4190 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
4191 # This field is set to true when the Dialogflow Console is used to
4192 # manually annotate the part. When creating an annotated part with the
4193 # API, you must set this to true.
4194 },
4195 ],
4196 "type": "A String", # Required. The type of the training phrase.
4197 "name": "A String", # Output only. The unique identifier of this training phrase.
4198 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
4199 # the intent. Each time a developer adds an existing sample by editing an
4200 # intent or training, this counter is increased.
4201 },
4202 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4203 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
4204 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
4205 "A String",
4206 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4207 "priority": 42, # The priority of this intent. Higher numbers represent higher
4208 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4209 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4210 # - If the supplied value is unspecified or 0, the service
4211 # translates the value to 500,000, which corresponds to the
4212 # `Normal` priority in the console.
4213 # - If the supplied value is negative, the intent is ignored
4214 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4215 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
4216 # followup intents. It identifies the correct followup intents chain for
4217 # this intent. We populate this field only in the output.
4218 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4219 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
4220 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
4221 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4222 "inputContextNames": [ # Optional. The list of context names required for this intent to be
4223 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4224 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4225 "A String",
4226 ],
4227 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
4228 # Note: If `ml_enabled` setting is set to false, then this intent is not
4229 # taken into account during inference in `ML ONLY` match mode. Also,
4230 # auto-markup in the UI is turned off.
4231 # DEPRECATED! Please use `ml_disabled` field instead.
4232 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
4233 # then the default value is determined as follows:
4234 # - Before April 15th, 2018 the default is:
4235 # ml_enabled = false / ml_disabled = true.
4236 # - After April 15th, 2018 the default is:
4237 # ml_enabled = true / ml_disabled = false.
4238 "action": "A String", # Optional. The name of the action associated with the intent.
4239 # Note: The action name must not contain whitespaces.
4240 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
4241 # is matched. Context messages in this collection should not set the
4242 # parameters field. Setting the `lifespan_count` to 0 will reset the context
4243 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4244 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4245 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4246 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4247 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
4248 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
4249 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4250 #
4251 # The `Context ID` is always converted to lowercase, may only contain
4252 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
4253 #
4254 # If `Environment ID` is not specified, we assume default 'draft'
4255 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4256 #
4257 # The following context names are reserved for internal use by Dialogflow.
4258 # You should not use these contexts or create contexts with these names:
4259 #
4260 # * `__system_counters__`
4261 # * `*_id_dialog_context`
4262 # * `*_dialog_params_size`
4263 "parameters": { # Optional. The collection of parameters associated with this context.
4264 #
4265 # Depending on your protocol or client library language, this is a
4266 # map, associative array, symbol table, dictionary, or JSON object
4267 # composed of a collection of (MapKey, MapValue) pairs:
4268 #
4269 # - MapKey type: string
4270 # - MapKey value: parameter name
4271 # - MapValue type:
4272 # - If parameter's entity type is a composite entity: map
4273 # - Else: string or number, depending on parameter value type
4274 # - MapValue value:
4275 # - If parameter's entity type is a composite entity:
4276 # map from composite entity property names to property values
4277 # - Else: parameter value
4278 "a_key": "", # Properties of the object.
4279 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4280 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4281 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4282 # immediately. Contexts expire automatically after 20 minutes if there
4283 # are no matching queries.
4284 },
4285 ],
4286 "events": [ # Optional. The collection of event names that trigger the intent.
4287 # If the collection of input contexts is not empty, all of the contexts must
4288 # 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^]4289 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4290 "A String",
4291 ],
4292 },
4293 ],
4294 }</pre>
4295</div>
4296
4297<div class="method">
4298 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
4299 <pre>Retrieves the next page of results.
4300
4301Args:
4302 previous_request: The request for the previous page. (required)
4303 previous_response: The response from the request for the previous page. (required)
4304
4305Returns:
4306 A request object that you can call 'execute()' on to request the next
4307 page. Returns None if there are no more items in the collection.
4308 </pre>
4309</div>
4310
4311<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4312 <code class="details" id="patch">patch(name, body=None, languageCode=None, intentView=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4313 <pre>Updates the specified intent.
4314
4315Args:
4316 name: string, The unique identifier of this intent.
4317Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
4318methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4319Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`. (required)
4320 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4321 The object takes the form of:
4322
4323{ # Represents an intent.
4324 # Intents convert a number of user expressions or patterns into an action. An
4325 # action is an extraction of a user command or sentence semantics.
4326 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
4327 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
4328 # Note: If `ml_disabled` setting is set to true, then this intent is not
4329 # taken into account during inference in `ML ONLY` match mode. Also,
4330 # auto-markup in the UI is turned off.
4331 "displayName": "A String", # Required. The name of this intent.
4332 "name": "A String", # The unique identifier of this intent.
4333 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
4334 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4335 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4336 "parameters": [ # Optional. The collection of parameters associated with the intent.
4337 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4338 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4339 "name": "A String", # The unique identifier of this parameter.
4340 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
4341 # result.
4342 # Default values can be extracted from contexts by using the following
4343 # syntax: `#context_name.parameter_name`.
4344 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
4345 # describes values of the parameter. If the parameter is
4346 # required, this must be provided.
4347 "value": "A String", # Optional. The definition of the parameter value. It can be:
4348 # - a constant string,
4349 # - a parameter value defined as `$parameter_name`,
4350 # - an original parameter value defined as `$parameter_name.original`,
4351 # - a parameter value from some context defined as
4352 # `#context_name.parameter_name`.
4353 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4354 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4355 "A String",
4356 ],
4357 "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^]4358 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
4359 # whether the intent cannot be completed without collecting the parameter
4360 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4361 },
4362 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4363 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
4364 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
4365 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4366 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
4367 # a direct or indirect parent. We populate this field only in the output.
4368 { # Represents a single followup intent in the chain.
4369 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4370 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4371 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4372 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4373 },
4374 ],
4375 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4376 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
4377 # chain of followup intents. You can set this field when creating an intent,
4378 # for example with CreateIntent or
4379 # BatchUpdateIntents, in order to make this
4380 # intent a followup intent.
4381 #
4382 # It identifies the parent followup intent.
4383 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4384 "messages": [ # Optional. The collection of rich messages corresponding to the
4385 # `Response` field in the Dialogflow console.
4386 { # Corresponds to the `Response` field in the Dialogflow console.
4387 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
4388 # This message in `QueryResult.fulfillment_messages` and
4389 # `WebhookResponse.fulfillment_messages` should contain only one
4390 # `SimpleResponse`.
4391 "simpleResponses": [ # Required. The list of simple responses.
4392 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4393 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
4394 # response to the user in the SSML format. Mutually exclusive with
4395 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4396 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
4397 # speech output. Mutually exclusive with ssml.
4398 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4399 },
4400 ],
4401 },
4402 "quickReplies": { # The quick replies response message. # Displays quick replies.
4403 "quickReplies": [ # Optional. The collection of quick replies.
4404 "A String",
4405 ],
4406 "title": "A String", # Optional. The title of the collection of quick replies.
4407 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4408 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
4409 #
4410 # RBM allows businesses to send enriched and branded versions of SMS. See
4411 # https://jibe.google.com/business-messaging.
4412 "text": "A String", # Required. Text sent and displayed to the user.
4413 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
4414 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
4415 # easily select/click a predefined response or perform an action (like
4416 # opening a web uri).
4417 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
4418 # can choose from the card.
4419 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
4420 # to send back to the agent (https://goo.gl/GXotJW).
4421 },
4422 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
4423 # (https://goo.gl/6GLJD2). If the user has an app installed that is
4424 # registered as the default handler for the URL, then this app will be
4425 # opened instead, and its icon will be used in the suggested action UI.
4426 "uri": "A String", # Required. The uri to open on the user device
4427 },
4428 "text": "A String", # Text to display alongside the action.
4429 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
4430 # but does not dial automatically (https://goo.gl/ergbB2).
4431 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
4432 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
4433 # format. An example of a correctly formatted phone number:
4434 # +15556767888.
4435 },
4436 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
4437 # when the user taps the suggested action. This data will be also
4438 # forwarded to webhook to allow performing custom business logic.
4439 },
4440 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
4441 # instead of typing in their own response.
4442 "text": "A String", # Suggested reply text.
4443 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
4444 # when the user taps the suggested reply. This data will be also
4445 # forwarded to webhook to allow performing custom business logic.
4446 },
4447 },
4448 ],
4449 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4450 "platform": "A String", # Optional. The platform that this message is intended for.
4451 "text": { # The text response message. # Returns a text response.
4452 "text": [ # Optional. The collection of the agent's responses.
4453 "A String",
4454 ],
4455 },
4456 "image": { # The image response message. # Displays an image.
4457 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4458 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4459 "imageUri": "A String", # Optional. The public URI to an image file.
4460 },
4461 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
4462 # Telephony Gateway.
4463 #
4464 # Telephony Gateway takes the synthesizer settings from
4465 # `DetectIntentResponse.output_audio_config` which can either be set
4466 # at request-level or can come from the agent-level synthesizer config.
4467 "ssml": "A String", # The SSML to be synthesized. For more information, see
4468 # [SSML](https://developers.google.com/actions/reference/ssml).
4469 "text": "A String", # The raw text to be synthesized.
4470 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4471 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
4472 #
4473 # Rich cards allow you to respond to users with more vivid content, e.g.
4474 # with media and suggestions.
4475 #
4476 # For more details about RBM rich cards, please see:
4477 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
4478 # If you want to show a single card with more control over the layout,
4479 # please use RbmStandaloneCard instead.
4480 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
4481 # 2 cards and at most 10.
4482 { # Rich Business Messaging (RBM) Card content
4483 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
4484 # be set. Media (image, GIF or a video) to include in the card.
4485 # The following media-types are currently supported:
4486 #
4487 # Image Types
4488 #
4489 # * image/jpeg
4490 # * image/jpg'
4491 # * image/gif
4492 # * image/png
4493 #
4494 # Video Types
4495 #
4496 # * video/h263
4497 # * video/m4v
4498 # * video/mp4
4499 # * video/mpeg
4500 # * video/mpeg4
4501 # * video/webm
4502 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
4503 # determines the MIME type of the file from the content-type field in
4504 # the HTTP headers when the platform fetches the file. The content-type
4505 # field must be present and accurate in the HTTP response from the URL.
4506 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
4507 # provide a thumbnail URI, the RBM platform displays a blank
4508 # placeholder thumbnail until the user's device downloads the file.
4509 # Depending on the user's setting, the file may not download
4510 # automatically and may require the user to tap a download button.
4511 "height": "A String", # Required for cards with vertical orientation. The height of the media
4512 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
4513 # For a standalone card with horizontal layout, height is not
4514 # customizable, and this field is ignored.
4515 },
4516 "suggestions": [ # Optional. List of suggestions to include in the card.
4517 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
4518 # easily select/click a predefined response or perform an action (like
4519 # opening a web uri).
4520 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
4521 # can choose from the card.
4522 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
4523 # to send back to the agent (https://goo.gl/GXotJW).
4524 },
4525 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
4526 # (https://goo.gl/6GLJD2). If the user has an app installed that is
4527 # registered as the default handler for the URL, then this app will be
4528 # opened instead, and its icon will be used in the suggested action UI.
4529 "uri": "A String", # Required. The uri to open on the user device
4530 },
4531 "text": "A String", # Text to display alongside the action.
4532 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
4533 # but does not dial automatically (https://goo.gl/ergbB2).
4534 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
4535 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
4536 # format. An example of a correctly formatted phone number:
4537 # +15556767888.
4538 },
4539 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
4540 # when the user taps the suggested action. This data will be also
4541 # forwarded to webhook to allow performing custom business logic.
4542 },
4543 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
4544 # instead of typing in their own response.
4545 "text": "A String", # Suggested reply text.
4546 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
4547 # when the user taps the suggested reply. This data will be also
4548 # forwarded to webhook to allow performing custom business logic.
4549 },
4550 },
4551 ],
4552 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
4553 #
4554 # At least one of the title, description or media must be set.
4555 "title": "A String", # Optional. Title of the card (at most 200 bytes).
4556 #
4557 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4558 },
4559 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4560 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4561 },
4562 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
4563 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
4564 # play, e.g., "gs://bucket/object". The object must contain a single
4565 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
4566 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4567 # This object must be readable by the `service-&lt;Project
4568 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
4569 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4570 # (usually the same as the Dialogflow agent project). If the Google Cloud
4571 # Storage bucket is in the Telephony Gateway project, this permission is
4572 # added by default when enabling the Dialogflow V2 API.
4573 #
4574 # For audio from other sources, consider using the
4575 # `TelephonySynthesizeSpeech` message with SSML.
4576 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4577 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
4578 #
4579 # Rich cards allow you to respond to users with more vivid content, e.g.
4580 # with media and suggestions.
4581 #
4582 # For more details about RBM rich cards, please see:
4583 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
4584 # You can group multiple rich cards into one using RbmCarouselCard but
4585 # carousel cards will give you less control over the card layout.
4586 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
4587 # Image preview alignment for standalone cards with horizontal layout.
4588 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
4589 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
4590 # be set. Media (image, GIF or a video) to include in the card.
4591 # The following media-types are currently supported:
4592 #
4593 # Image Types
4594 #
4595 # * image/jpeg
4596 # * image/jpg'
4597 # * image/gif
4598 # * image/png
4599 #
4600 # Video Types
4601 #
4602 # * video/h263
4603 # * video/m4v
4604 # * video/mp4
4605 # * video/mpeg
4606 # * video/mpeg4
4607 # * video/webm
4608 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
4609 # determines the MIME type of the file from the content-type field in
4610 # the HTTP headers when the platform fetches the file. The content-type
4611 # field must be present and accurate in the HTTP response from the URL.
4612 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
4613 # provide a thumbnail URI, the RBM platform displays a blank
4614 # placeholder thumbnail until the user's device downloads the file.
4615 # Depending on the user's setting, the file may not download
4616 # automatically and may require the user to tap a download button.
4617 "height": "A String", # Required for cards with vertical orientation. The height of the media
4618 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
4619 # For a standalone card with horizontal layout, height is not
4620 # customizable, and this field is ignored.
4621 },
4622 "suggestions": [ # Optional. List of suggestions to include in the card.
4623 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
4624 # easily select/click a predefined response or perform an action (like
4625 # opening a web uri).
4626 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
4627 # can choose from the card.
4628 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
4629 # to send back to the agent (https://goo.gl/GXotJW).
4630 },
4631 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
4632 # (https://goo.gl/6GLJD2). If the user has an app installed that is
4633 # registered as the default handler for the URL, then this app will be
4634 # opened instead, and its icon will be used in the suggested action UI.
4635 "uri": "A String", # Required. The uri to open on the user device
4636 },
4637 "text": "A String", # Text to display alongside the action.
4638 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
4639 # but does not dial automatically (https://goo.gl/ergbB2).
4640 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
4641 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
4642 # format. An example of a correctly formatted phone number:
4643 # +15556767888.
4644 },
4645 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
4646 # when the user taps the suggested action. This data will be also
4647 # forwarded to webhook to allow performing custom business logic.
4648 },
4649 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
4650 # instead of typing in their own response.
4651 "text": "A String", # Suggested reply text.
4652 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
4653 # when the user taps the suggested reply. This data will be also
4654 # forwarded to webhook to allow performing custom business logic.
4655 },
4656 },
4657 ],
4658 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
4659 #
4660 # At least one of the title, description or media must be set.
4661 "title": "A String", # Optional. Title of the card (at most 200 bytes).
4662 #
4663 # At least one of the title, description or media must be set.
4664 },
4665 "cardOrientation": "A String", # Required. Orientation of the card.
4666 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4667 "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.
4668 # or website associated with this agent.
4669 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
4670 # suggestion chip.
4671 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
4672 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4673 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
4674 # https://developers.google.com/actions/assistant/responses#browsing_carousel
4675 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
4676 # items, maximum of ten.
4677 { # Browsing carousel tile
4678 "image": { # The image response message. # Optional. Hero image for the carousel item.
4679 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4680 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4681 "imageUri": "A String", # Optional. The public URI to an image file.
4682 },
4683 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
4684 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
4685 # text.
4686 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
4687 "url": "A String", # Required. URL
4688 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
4689 # the URL. Defaults to opening via web browser.
4690 },
4691 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
4692 # Card. Maximum of one line of text.
4693 },
4694 ],
4695 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
4696 # items.
4697 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4698 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
4699 "buttons": [ # Optional. The collection of card buttons.
4700 { # The button object that appears at the bottom of a card.
4701 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
4702 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
4703 },
4704 "title": "A String", # Required. The title of the button.
4705 },
4706 ],
4707 "formattedText": "A String", # Required, unless image is present. The body text of the card.
4708 "image": { # The image response message. # Optional. The image for the card.
4709 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4710 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4711 "imageUri": "A String", # Optional. The public URI to an image file.
4712 },
4713 "subtitle": "A String", # Optional. The subtitle of the card.
4714 "title": "A String", # Optional. The title of the card.
4715 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4716 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
4717 "mediaObjects": [ # Required. List of media objects.
4718 { # Response media object for media content card.
4719 "contentUrl": "A String", # Required. Url where the media is stored.
4720 "description": "A String", # Optional. Description of media card.
4721 "name": "A String", # Required. Name of media card.
4722 "largeImage": { # The image response message. # Optional. Image to display above media content.
4723 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4724 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4725 "imageUri": "A String", # Optional. The public URI to an image file.
4726 },
4727 "icon": { # The image response message. # Optional. Icon to display above media content.
4728 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4729 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4730 "imageUri": "A String", # Optional. The public URI to an image file.
4731 },
4732 },
4733 ],
4734 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
4735 },
4736 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
4737 "rows": [ # Optional. Rows in this table of data.
4738 { # Row of TableCard.
4739 "cells": [ # Optional. List of cells that make up this row.
4740 { # Cell of TableCardRow.
4741 "text": "A String", # Required. Text in this cell.
4742 },
4743 ],
4744 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
4745 },
4746 ],
4747 "subtitle": "A String", # Optional. Subtitle to the title.
4748 "title": "A String", # Required. Title of the card.
4749 "image": { # The image response message. # Optional. Image which should be displayed on the card.
4750 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4751 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4752 "imageUri": "A String", # Optional. The public URI to an image file.
4753 },
4754 "columnProperties": [ # Optional. Display properties for the columns in this table.
4755 { # Column properties for TableCard.
4756 "header": "A String", # Required. Column heading.
4757 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
4758 },
4759 ],
4760 "buttons": [ # Optional. List of buttons for the card.
4761 { # The button object that appears at the bottom of a card.
4762 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
4763 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
4764 },
4765 "title": "A String", # Required. The title of the button.
4766 },
4767 ],
4768 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4769 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
4770 "items": [ # Required. Carousel items.
4771 { # An item in the carousel.
4772 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
4773 # dialog.
4774 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
4775 # item in dialog.
4776 "A String",
4777 ],
4778 "key": "A String", # Required. A unique key that will be sent back to the agent if this
4779 # response is given.
4780 },
4781 "image": { # The image response message. # Optional. The image to display.
4782 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4783 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4784 "imageUri": "A String", # Optional. The public URI to an image file.
4785 },
4786 "description": "A String", # Optional. The body text of the card.
4787 "title": "A String", # Required. Title of the carousel item.
4788 },
4789 ],
4790 },
4791 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
4792 "items": [ # Required. List items.
4793 { # An item in the list.
4794 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
4795 # dialog.
4796 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
4797 # item in dialog.
4798 "A String",
4799 ],
4800 "key": "A String", # Required. A unique key that will be sent back to the agent if this
4801 # response is given.
4802 },
4803 "image": { # The image response message. # Optional. The image to display.
4804 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
4805 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
4806 "imageUri": "A String", # Optional. The public URI to an image file.
4807 },
4808 "description": "A String", # Optional. The main text describing the item.
4809 "title": "A String", # Required. The title of the list item.
4810 },
4811 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4812 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4813 "title": "A String", # Optional. The overall title of the list.
4814 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4815 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
4816 "suggestions": [ # Required. The list of suggested replies.
4817 { # The suggestion chip message that the user can tap to quickly post a reply
4818 # to the conversation.
4819 "title": "A String", # Required. The text shown the in the suggestion chip.
4820 },
4821 ],
4822 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4823 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
4824 "phoneNumber": "A String", # Required. The phone number to transfer the call to
4825 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
4826 #
4827 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
4828 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4829 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4830 "a_key": "", # Properties of the object.
4831 },
4832 "card": { # The card response message. # Displays a card.
4833 "buttons": [ # Optional. The collection of card buttons.
4834 { # Optional. Contains information about a button.
4835 "text": "A String", # Optional. The text to show on the button.
4836 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
4837 # open.
4838 },
4839 ],
4840 "title": "A String", # Optional. The title of the card.
4841 "subtitle": "A String", # Optional. The subtitle of the card.
4842 "imageUri": "A String", # Optional. The public URI to an image file for the card.
4843 },
4844 },
4845 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4846 "trainingPhrases": [ # Optional. The collection of examples that the agent is
4847 # trained on.
4848 { # Represents an example that the agent is trained on.
4849 "parts": [ # Required. The ordered list of training phrase parts.
4850 # The parts are concatenated in order to form the training phrase.
4851 #
4852 # Note: The API does not automatically annotate training phrases like the
4853 # Dialogflow Console does.
4854 #
4855 # Note: Do not forget to include whitespace at part boundaries,
4856 # so the training phrase is well formatted when the parts are concatenated.
4857 #
4858 # If the training phrase does not need to be annotated with parameters,
4859 # you just need a single part with only the Part.text field set.
4860 #
4861 # If you want to annotate the training phrase, you must create multiple
4862 # parts, where the fields of each part are populated in one of two ways:
4863 #
4864 # - `Part.text` is set to a part of the phrase that has no parameters.
4865 # - `Part.text` is set to a part of the phrase that you want to annotate,
4866 # and the `entity_type`, `alias`, and `user_defined` fields are all
4867 # set.
4868 { # Represents a part of a training phrase.
4869 "alias": "A String", # Optional. The parameter name for the value extracted from the
4870 # annotated part of the example.
4871 # This field is required for annotated parts of the training phrase.
4872 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
4873 # This field is required for annotated parts of the training phrase.
4874 "text": "A String", # Required. The text for this part.
4875 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
4876 # This field is set to true when the Dialogflow Console is used to
4877 # manually annotate the part. When creating an annotated part with the
4878 # API, you must set this to true.
4879 },
4880 ],
4881 "type": "A String", # Required. The type of the training phrase.
4882 "name": "A String", # Output only. The unique identifier of this training phrase.
4883 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
4884 # the intent. Each time a developer adds an existing sample by editing an
4885 # intent or training, this counter is increased.
4886 },
4887 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4888 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
4889 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
4890 "A String",
4891 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4892 "priority": 42, # The priority of this intent. Higher numbers represent higher
4893 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4894 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4895 # - If the supplied value is unspecified or 0, the service
4896 # translates the value to 500,000, which corresponds to the
4897 # `Normal` priority in the console.
4898 # - If the supplied value is negative, the intent is ignored
4899 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4900 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
4901 # followup intents. It identifies the correct followup intents chain for
4902 # this intent. We populate this field only in the output.
4903 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4904 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
4905 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
4906 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4907 "inputContextNames": [ # Optional. The list of context names required for this intent to be
4908 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4909 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4910 "A String",
4911 ],
4912 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
4913 # Note: If `ml_enabled` setting is set to false, then this intent is not
4914 # taken into account during inference in `ML ONLY` match mode. Also,
4915 # auto-markup in the UI is turned off.
4916 # DEPRECATED! Please use `ml_disabled` field instead.
4917 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
4918 # then the default value is determined as follows:
4919 # - Before April 15th, 2018 the default is:
4920 # ml_enabled = false / ml_disabled = true.
4921 # - After April 15th, 2018 the default is:
4922 # ml_enabled = true / ml_disabled = false.
4923 "action": "A String", # Optional. The name of the action associated with the intent.
4924 # Note: The action name must not contain whitespaces.
4925 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
4926 # is matched. Context messages in this collection should not set the
4927 # parameters field. Setting the `lifespan_count` to 0 will reset the context
4928 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4929 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4930 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4931 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4932 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
4933 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
4934 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4935 #
4936 # The `Context ID` is always converted to lowercase, may only contain
4937 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
4938 #
4939 # If `Environment ID` is not specified, we assume default 'draft'
4940 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4941 #
4942 # The following context names are reserved for internal use by Dialogflow.
4943 # You should not use these contexts or create contexts with these names:
4944 #
4945 # * `__system_counters__`
4946 # * `*_id_dialog_context`
4947 # * `*_dialog_params_size`
4948 "parameters": { # Optional. The collection of parameters associated with this context.
4949 #
4950 # Depending on your protocol or client library language, this is a
4951 # map, associative array, symbol table, dictionary, or JSON object
4952 # composed of a collection of (MapKey, MapValue) pairs:
4953 #
4954 # - MapKey type: string
4955 # - MapKey value: parameter name
4956 # - MapValue type:
4957 # - If parameter's entity type is a composite entity: map
4958 # - Else: string or number, depending on parameter value type
4959 # - MapValue value:
4960 # - If parameter's entity type is a composite entity:
4961 # map from composite entity property names to property values
4962 # - Else: parameter value
4963 "a_key": "", # Properties of the object.
4964 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4965 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4966 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4967 # immediately. Contexts expire automatically after 20 minutes if there
4968 # are no matching queries.
4969 },
4970 ],
4971 "events": [ # Optional. The collection of event names that trigger the intent.
4972 # If the collection of input contexts is not empty, all of the contexts must
4973 # 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^]4974 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4975 "A String",
4976 ],
4977}
4978
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4979 languageCode: string, Optional. The language used to access language-specific data.
4980If not specified, the agent's default language is used.
4981For more information, see
4982[Multilingual intent and entity
4983data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4984 intentView: string, Optional. The resource view to apply to the returned intent.
4985 updateMask: string, Optional. The mask to control which fields get updated.
4986 x__xgafv: string, V1 error format.
4987 Allowed values
4988 1 - v1 error format
4989 2 - v2 error format
4990
4991Returns:
4992 An object of the form:
4993
4994 { # Represents an intent.
4995 # Intents convert a number of user expressions or patterns into an action. An
4996 # action is an extraction of a user command or sentence semantics.
4997 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
4998 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
4999 # Note: If `ml_disabled` setting is set to true, then this intent is not
5000 # taken into account during inference in `ML ONLY` match mode. Also,
5001 # auto-markup in the UI is turned off.
5002 "displayName": "A String", # Required. The name of this intent.
5003 "name": "A String", # The unique identifier of this intent.
5004 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
5005 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5006 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5007 "parameters": [ # Optional. The collection of parameters associated with the intent.
5008 { # Represents intent parameters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5009 "displayName": "A String", # Required. The name of the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5010 "name": "A String", # The unique identifier of this parameter.
5011 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
5012 # result.
5013 # Default values can be extracted from contexts by using the following
5014 # syntax: `#context_name.parameter_name`.
5015 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
5016 # describes values of the parameter. If the parameter is
5017 # required, this must be provided.
5018 "value": "A String", # Optional. The definition of the parameter value. It can be:
5019 # - a constant string,
5020 # - a parameter value defined as `$parameter_name`,
5021 # - an original parameter value defined as `$parameter_name.original`,
5022 # - a parameter value from some context defined as
5023 # `#context_name.parameter_name`.
5024 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5025 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5026 "A String",
5027 ],
5028 "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^]5029 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
5030 # whether the intent cannot be completed without collecting the parameter
5031 # value.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5032 },
5033 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5034 "endInteraction": True or False, # Optional. Indicates that this intent ends an interaction. Some integrations
5035 # (e.g., Actions on Google or Dialogflow phone gateway) use this information
5036 # to close interaction with an end user. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5037 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
5038 # a direct or indirect parent. We populate this field only in the output.
5039 { # Represents a single followup intent in the chain.
5040 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5041 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5042 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5043 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5044 },
5045 ],
5046 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5047 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
5048 # chain of followup intents. You can set this field when creating an intent,
5049 # for example with CreateIntent or
5050 # BatchUpdateIntents, in order to make this
5051 # intent a followup intent.
5052 #
5053 # It identifies the parent followup intent.
5054 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5055 "messages": [ # Optional. The collection of rich messages corresponding to the
5056 # `Response` field in the Dialogflow console.
5057 { # Corresponds to the `Response` field in the Dialogflow console.
5058 "simpleResponses": { # The collection of simple response candidates. # Returns a voice or text-only response for Actions on Google.
5059 # This message in `QueryResult.fulfillment_messages` and
5060 # `WebhookResponse.fulfillment_messages` should contain only one
5061 # `SimpleResponse`.
5062 "simpleResponses": [ # Required. The list of simple responses.
5063 { # The simple response message containing speech or text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5064 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
5065 # response to the user in the SSML format. Mutually exclusive with
5066 # text_to_speech.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5067 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
5068 # speech output. Mutually exclusive with ssml.
5069 "displayText": "A String", # Optional. The text to display.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5070 },
5071 ],
5072 },
5073 "quickReplies": { # The quick replies response message. # Displays quick replies.
5074 "quickReplies": [ # Optional. The collection of quick replies.
5075 "A String",
5076 ],
5077 "title": "A String", # Optional. The title of the collection of quick replies.
5078 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5079 "rbmText": { # Rich Business Messaging (RBM) text response with suggestions. # Rich Business Messaging (RBM) text response.
5080 #
5081 # RBM allows businesses to send enriched and branded versions of SMS. See
5082 # https://jibe.google.com/business-messaging.
5083 "text": "A String", # Required. Text sent and displayed to the user.
5084 "rbmSuggestion": [ # Optional. One or more suggestions to show to the user.
5085 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
5086 # easily select/click a predefined response or perform an action (like
5087 # opening a web uri).
5088 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
5089 # can choose from the card.
5090 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
5091 # to send back to the agent (https://goo.gl/GXotJW).
5092 },
5093 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
5094 # (https://goo.gl/6GLJD2). If the user has an app installed that is
5095 # registered as the default handler for the URL, then this app will be
5096 # opened instead, and its icon will be used in the suggested action UI.
5097 "uri": "A String", # Required. The uri to open on the user device
5098 },
5099 "text": "A String", # Text to display alongside the action.
5100 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
5101 # but does not dial automatically (https://goo.gl/ergbB2).
5102 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
5103 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
5104 # format. An example of a correctly formatted phone number:
5105 # +15556767888.
5106 },
5107 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
5108 # when the user taps the suggested action. This data will be also
5109 # forwarded to webhook to allow performing custom business logic.
5110 },
5111 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
5112 # instead of typing in their own response.
5113 "text": "A String", # Suggested reply text.
5114 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
5115 # when the user taps the suggested reply. This data will be also
5116 # forwarded to webhook to allow performing custom business logic.
5117 },
5118 },
5119 ],
5120 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5121 "platform": "A String", # Optional. The platform that this message is intended for.
5122 "text": { # The text response message. # Returns a text response.
5123 "text": [ # Optional. The collection of the agent's responses.
5124 "A String",
5125 ],
5126 },
5127 "image": { # The image response message. # Displays an image.
5128 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
5129 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
5130 "imageUri": "A String", # Optional. The public URI to an image file.
5131 },
5132 "telephonySynthesizeSpeech": { # Synthesizes speech and plays back the synthesized audio to the caller in # Synthesizes speech in Telephony Gateway.
5133 # Telephony Gateway.
5134 #
5135 # Telephony Gateway takes the synthesizer settings from
5136 # `DetectIntentResponse.output_audio_config` which can either be set
5137 # at request-level or can come from the agent-level synthesizer config.
5138 "ssml": "A String", # The SSML to be synthesized. For more information, see
5139 # [SSML](https://developers.google.com/actions/reference/ssml).
5140 "text": "A String", # The raw text to be synthesized.
5141 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5142 "rbmCarouselRichCard": { # Carousel Rich Business Messaging (RBM) rich card. # Rich Business Messaging (RBM) carousel rich card response.
5143 #
5144 # Rich cards allow you to respond to users with more vivid content, e.g.
5145 # with media and suggestions.
5146 #
5147 # For more details about RBM rich cards, please see:
5148 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
5149 # If you want to show a single card with more control over the layout,
5150 # please use RbmStandaloneCard instead.
5151 "cardContents": [ # Required. The cards in the carousel. A carousel must have at least
5152 # 2 cards and at most 10.
5153 { # Rich Business Messaging (RBM) Card content
5154 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
5155 # be set. Media (image, GIF or a video) to include in the card.
5156 # The following media-types are currently supported:
5157 #
5158 # Image Types
5159 #
5160 # * image/jpeg
5161 # * image/jpg'
5162 # * image/gif
5163 # * image/png
5164 #
5165 # Video Types
5166 #
5167 # * video/h263
5168 # * video/m4v
5169 # * video/mp4
5170 # * video/mpeg
5171 # * video/mpeg4
5172 # * video/webm
5173 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
5174 # determines the MIME type of the file from the content-type field in
5175 # the HTTP headers when the platform fetches the file. The content-type
5176 # field must be present and accurate in the HTTP response from the URL.
5177 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
5178 # provide a thumbnail URI, the RBM platform displays a blank
5179 # placeholder thumbnail until the user's device downloads the file.
5180 # Depending on the user's setting, the file may not download
5181 # automatically and may require the user to tap a download button.
5182 "height": "A String", # Required for cards with vertical orientation. The height of the media
5183 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
5184 # For a standalone card with horizontal layout, height is not
5185 # customizable, and this field is ignored.
5186 },
5187 "suggestions": [ # Optional. List of suggestions to include in the card.
5188 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
5189 # easily select/click a predefined response or perform an action (like
5190 # opening a web uri).
5191 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
5192 # can choose from the card.
5193 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
5194 # to send back to the agent (https://goo.gl/GXotJW).
5195 },
5196 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
5197 # (https://goo.gl/6GLJD2). If the user has an app installed that is
5198 # registered as the default handler for the URL, then this app will be
5199 # opened instead, and its icon will be used in the suggested action UI.
5200 "uri": "A String", # Required. The uri to open on the user device
5201 },
5202 "text": "A String", # Text to display alongside the action.
5203 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
5204 # but does not dial automatically (https://goo.gl/ergbB2).
5205 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
5206 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
5207 # format. An example of a correctly formatted phone number:
5208 # +15556767888.
5209 },
5210 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
5211 # when the user taps the suggested action. This data will be also
5212 # forwarded to webhook to allow performing custom business logic.
5213 },
5214 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
5215 # instead of typing in their own response.
5216 "text": "A String", # Suggested reply text.
5217 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
5218 # when the user taps the suggested reply. This data will be also
5219 # forwarded to webhook to allow performing custom business logic.
5220 },
5221 },
5222 ],
5223 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
5224 #
5225 # At least one of the title, description or media must be set.
5226 "title": "A String", # Optional. Title of the card (at most 200 bytes).
5227 #
5228 # At least one of the title, description or media must be set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5229 },
5230 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5231 "cardWidth": "A String", # Required. The width of the cards in the carousel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5232 },
5233 "telephonyPlayAudio": { # Plays audio from a file in Telephony Gateway. # Plays audio from a file in Telephony Gateway.
5234 "audioUri": "A String", # Required. URI to a Google Cloud Storage object containing the audio to
5235 # play, e.g., "gs://bucket/object". The object must contain a single
5236 # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.
5237 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5238 # This object must be readable by the `service-&lt;Project
5239 # Number&gt;@gcp-sa-dialogflow.iam.gserviceaccount.com` service account
5240 # where &lt;Project Number&gt; is the number of the Telephony Gateway project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5241 # (usually the same as the Dialogflow agent project). If the Google Cloud
5242 # Storage bucket is in the Telephony Gateway project, this permission is
5243 # added by default when enabling the Dialogflow V2 API.
5244 #
5245 # For audio from other sources, consider using the
5246 # `TelephonySynthesizeSpeech` message with SSML.
5247 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5248 "rbmStandaloneRichCard": { # Standalone Rich Business Messaging (RBM) rich card. # Standalone Rich Business Messaging (RBM) rich card response.
5249 #
5250 # Rich cards allow you to respond to users with more vivid content, e.g.
5251 # with media and suggestions.
5252 #
5253 # For more details about RBM rich cards, please see:
5254 # https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards.
5255 # You can group multiple rich cards into one using RbmCarouselCard but
5256 # carousel cards will give you less control over the card layout.
5257 "thumbnailImageAlignment": "A String", # Required if orientation is horizontal.
5258 # Image preview alignment for standalone cards with horizontal layout.
5259 "cardContent": { # Rich Business Messaging (RBM) Card content # Required. Card content.
5260 "media": { # Rich Business Messaging (RBM) Media displayed in Cards # Optional. However at least one of the title, description or media must
5261 # be set. Media (image, GIF or a video) to include in the card.
5262 # The following media-types are currently supported:
5263 #
5264 # Image Types
5265 #
5266 # * image/jpeg
5267 # * image/jpg'
5268 # * image/gif
5269 # * image/png
5270 #
5271 # Video Types
5272 #
5273 # * video/h263
5274 # * video/m4v
5275 # * video/mp4
5276 # * video/mpeg
5277 # * video/mpeg4
5278 # * video/webm
5279 "fileUri": "A String", # Required. Publicly reachable URI of the file. The RBM platform
5280 # determines the MIME type of the file from the content-type field in
5281 # the HTTP headers when the platform fetches the file. The content-type
5282 # field must be present and accurate in the HTTP response from the URL.
5283 "thumbnailUri": "A String", # Optional. Publicly reachable URI of the thumbnail.If you don't
5284 # provide a thumbnail URI, the RBM platform displays a blank
5285 # placeholder thumbnail until the user's device downloads the file.
5286 # Depending on the user's setting, the file may not download
5287 # automatically and may require the user to tap a download button.
5288 "height": "A String", # Required for cards with vertical orientation. The height of the media
5289 # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
5290 # For a standalone card with horizontal layout, height is not
5291 # customizable, and this field is ignored.
5292 },
5293 "suggestions": [ # Optional. List of suggestions to include in the card.
5294 { # Rich Business Messaging (RBM) suggestion. Suggestions allow user to
5295 # easily select/click a predefined response or perform an action (like
5296 # opening a web uri).
5297 "action": { # Rich Business Messaging (RBM) suggested client-side action that the user # Predefined client side actions that user can choose
5298 # can choose from the card.
5299 "shareLocation": { # Opens the device's location chooser so the user can pick a location # Suggested client side action: Share user location
5300 # to send back to the agent (https://goo.gl/GXotJW).
5301 },
5302 "openUrl": { # Opens the user's default web browser app to the specified uri # Suggested client side action: Open a URI on device
5303 # (https://goo.gl/6GLJD2). If the user has an app installed that is
5304 # registered as the default handler for the URL, then this app will be
5305 # opened instead, and its icon will be used in the suggested action UI.
5306 "uri": "A String", # Required. The uri to open on the user device
5307 },
5308 "text": "A String", # Text to display alongside the action.
5309 "dial": { # Opens the user's default dialer app with the specified phone number # Suggested client side action: Dial a phone number
5310 # but does not dial automatically (https://goo.gl/ergbB2).
5311 "phoneNumber": "A String", # Required. The phone number to fill in the default dialer app.
5312 # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164)
5313 # format. An example of a correctly formatted phone number:
5314 # +15556767888.
5315 },
5316 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
5317 # when the user taps the suggested action. This data will be also
5318 # forwarded to webhook to allow performing custom business logic.
5319 },
5320 "reply": { # Rich Business Messaging (RBM) suggested reply that the user can click # Predefined replies for user to select instead of typing
5321 # instead of typing in their own response.
5322 "text": "A String", # Suggested reply text.
5323 "postbackData": "A String", # Opaque payload that the Dialogflow receives in a user event
5324 # when the user taps the suggested reply. This data will be also
5325 # forwarded to webhook to allow performing custom business logic.
5326 },
5327 },
5328 ],
5329 "description": "A String", # Optional. Description of the card (at most 2000 bytes).
5330 #
5331 # At least one of the title, description or media must be set.
5332 "title": "A String", # Optional. Title of the card (at most 200 bytes).
5333 #
5334 # At least one of the title, description or media must be set.
5335 },
5336 "cardOrientation": "A String", # Required. Orientation of the card.
5337 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5338 "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.
5339 # or website associated with this agent.
5340 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
5341 # suggestion chip.
5342 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
5343 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5344 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
5345 # https://developers.google.com/actions/assistant/responses#browsing_carousel
5346 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
5347 # items, maximum of ten.
5348 { # Browsing carousel tile
5349 "image": { # The image response message. # Optional. Hero image for the carousel item.
5350 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
5351 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
5352 "imageUri": "A String", # Optional. The public URI to an image file.
5353 },
5354 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
5355 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
5356 # text.
5357 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
5358 "url": "A String", # Required. URL
5359 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
5360 # the URL. Defaults to opening via web browser.
5361 },
5362 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
5363 # Card. Maximum of one line of text.
5364 },
5365 ],
5366 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
5367 # items.
5368 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5369 "basicCard": { # The basic card message. Useful for displaying information. # Displays a basic card for Actions on Google.
5370 "buttons": [ # Optional. The collection of card buttons.
5371 { # The button object that appears at the bottom of a card.
5372 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
5373 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
5374 },
5375 "title": "A String", # Required. The title of the button.
5376 },
5377 ],
5378 "formattedText": "A String", # Required, unless image is present. The body text of the card.
5379 "image": { # The image response message. # Optional. The image for the card.
5380 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
5381 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
5382 "imageUri": "A String", # Optional. The public URI to an image file.
5383 },
5384 "subtitle": "A String", # Optional. The subtitle of the card.
5385 "title": "A String", # Optional. The title of the card.
5386 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5387 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
5388 "mediaObjects": [ # Required. List of media objects.
5389 { # Response media object for media content card.
5390 "contentUrl": "A String", # Required. Url where the media is stored.
5391 "description": "A String", # Optional. Description of media card.
5392 "name": "A String", # Required. Name of media card.
5393 "largeImage": { # The image response message. # Optional. Image to display above media content.
5394 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
5395 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
5396 "imageUri": "A String", # Optional. The public URI to an image file.
5397 },
5398 "icon": { # The image response message. # Optional. Icon to display above media content.
5399 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
5400 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
5401 "imageUri": "A String", # Optional. The public URI to an image file.
5402 },
5403 },
5404 ],
5405 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
5406 },
5407 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
5408 "rows": [ # Optional. Rows in this table of data.
5409 { # Row of TableCard.
5410 "cells": [ # Optional. List of cells that make up this row.
5411 { # Cell of TableCardRow.
5412 "text": "A String", # Required. Text in this cell.
5413 },
5414 ],
5415 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
5416 },
5417 ],
5418 "subtitle": "A String", # Optional. Subtitle to the title.
5419 "title": "A String", # Required. Title of the card.
5420 "image": { # The image response message. # Optional. Image which should be displayed on the card.
5421 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
5422 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
5423 "imageUri": "A String", # Optional. The public URI to an image file.
5424 },
5425 "columnProperties": [ # Optional. Display properties for the columns in this table.
5426 { # Column properties for TableCard.
5427 "header": "A String", # Required. Column heading.
5428 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
5429 },
5430 ],
5431 "buttons": [ # Optional. List of buttons for the card.
5432 { # The button object that appears at the bottom of a card.
5433 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
5434 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
5435 },
5436 "title": "A String", # Required. The title of the button.
5437 },
5438 ],
5439 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5440 "carouselSelect": { # The card for presenting a carousel of options to select from. # Displays a carousel card for Actions on Google.
5441 "items": [ # Required. Carousel items.
5442 { # An item in the carousel.
5443 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
5444 # dialog.
5445 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
5446 # item in dialog.
5447 "A String",
5448 ],
5449 "key": "A String", # Required. A unique key that will be sent back to the agent if this
5450 # response is given.
5451 },
5452 "image": { # The image response message. # Optional. The image to display.
5453 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
5454 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
5455 "imageUri": "A String", # Optional. The public URI to an image file.
5456 },
5457 "description": "A String", # Optional. The body text of the card.
5458 "title": "A String", # Required. Title of the carousel item.
5459 },
5460 ],
5461 },
5462 "listSelect": { # The card for presenting a list of options to select from. # Displays a list card for Actions on Google.
5463 "items": [ # Required. List items.
5464 { # An item in the list.
5465 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
5466 # dialog.
5467 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
5468 # item in dialog.
5469 "A String",
5470 ],
5471 "key": "A String", # Required. A unique key that will be sent back to the agent if this
5472 # response is given.
5473 },
5474 "image": { # The image response message. # Optional. The image to display.
5475 "accessibilityText": "A String", # A text description of the image to be used for accessibility,
5476 # e.g., screen readers. Required if image_uri is set for CarouselSelect.
5477 "imageUri": "A String", # Optional. The public URI to an image file.
5478 },
5479 "description": "A String", # Optional. The main text describing the item.
5480 "title": "A String", # Required. The title of the list item.
5481 },
5482 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5483 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5484 "title": "A String", # Optional. The overall title of the list.
5485 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5486 "suggestions": { # The collection of suggestions. # Displays suggestion chips for Actions on Google.
5487 "suggestions": [ # Required. The list of suggested replies.
5488 { # The suggestion chip message that the user can tap to quickly post a reply
5489 # to the conversation.
5490 "title": "A String", # Required. The text shown the in the suggestion chip.
5491 },
5492 ],
5493 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5494 "telephonyTransferCall": { # Transfers the call in Telephony Gateway. # Transfers the call in Telephony Gateway.
5495 "phoneNumber": "A String", # Required. The phone number to transfer the call to
5496 # in [E.164 format](https://en.wikipedia.org/wiki/E.164).
5497 #
5498 # We currently only allow transferring to US numbers (+1xxxyyyzzzz).
5499 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5500 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5501 "a_key": "", # Properties of the object.
5502 },
5503 "card": { # The card response message. # Displays a card.
5504 "buttons": [ # Optional. The collection of card buttons.
5505 { # Optional. Contains information about a button.
5506 "text": "A String", # Optional. The text to show on the button.
5507 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
5508 # open.
5509 },
5510 ],
5511 "title": "A String", # Optional. The title of the card.
5512 "subtitle": "A String", # Optional. The subtitle of the card.
5513 "imageUri": "A String", # Optional. The public URI to an image file for the card.
5514 },
5515 },
5516 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5517 "trainingPhrases": [ # Optional. The collection of examples that the agent is
5518 # trained on.
5519 { # Represents an example that the agent is trained on.
5520 "parts": [ # Required. The ordered list of training phrase parts.
5521 # The parts are concatenated in order to form the training phrase.
5522 #
5523 # Note: The API does not automatically annotate training phrases like the
5524 # Dialogflow Console does.
5525 #
5526 # Note: Do not forget to include whitespace at part boundaries,
5527 # so the training phrase is well formatted when the parts are concatenated.
5528 #
5529 # If the training phrase does not need to be annotated with parameters,
5530 # you just need a single part with only the Part.text field set.
5531 #
5532 # If you want to annotate the training phrase, you must create multiple
5533 # parts, where the fields of each part are populated in one of two ways:
5534 #
5535 # - `Part.text` is set to a part of the phrase that has no parameters.
5536 # - `Part.text` is set to a part of the phrase that you want to annotate,
5537 # and the `entity_type`, `alias`, and `user_defined` fields are all
5538 # set.
5539 { # Represents a part of a training phrase.
5540 "alias": "A String", # Optional. The parameter name for the value extracted from the
5541 # annotated part of the example.
5542 # This field is required for annotated parts of the training phrase.
5543 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
5544 # This field is required for annotated parts of the training phrase.
5545 "text": "A String", # Required. The text for this part.
5546 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
5547 # This field is set to true when the Dialogflow Console is used to
5548 # manually annotate the part. When creating an annotated part with the
5549 # API, you must set this to true.
5550 },
5551 ],
5552 "type": "A String", # Required. The type of the training phrase.
5553 "name": "A String", # Output only. The unique identifier of this training phrase.
5554 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
5555 # the intent. Each time a developer adds an existing sample by editing an
5556 # intent or training, this counter is increased.
5557 },
5558 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5559 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
5560 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
5561 "A String",
5562 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5563 "priority": 42, # The priority of this intent. Higher numbers represent higher
5564 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5565 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5566 # - If the supplied value is unspecified or 0, the service
5567 # translates the value to 500,000, which corresponds to the
5568 # `Normal` priority in the console.
5569 # - If the supplied value is negative, the intent is ignored
5570 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5571 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
5572 # followup intents. It identifies the correct followup intents chain for
5573 # this intent. We populate this field only in the output.
5574 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5575 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
5576 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
5577 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5578 "inputContextNames": [ # Optional. The list of context names required for this intent to be
5579 # triggered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5580 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5581 "A String",
5582 ],
5583 "mlEnabled": True or False, # Optional. Indicates whether Machine Learning is enabled for the intent.
5584 # Note: If `ml_enabled` setting is set to false, then this intent is not
5585 # taken into account during inference in `ML ONLY` match mode. Also,
5586 # auto-markup in the UI is turned off.
5587 # DEPRECATED! Please use `ml_disabled` field instead.
5588 # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
5589 # then the default value is determined as follows:
5590 # - Before April 15th, 2018 the default is:
5591 # ml_enabled = false / ml_disabled = true.
5592 # - After April 15th, 2018 the default is:
5593 # ml_enabled = true / ml_disabled = false.
5594 "action": "A String", # Optional. The name of the action associated with the intent.
5595 # Note: The action name must not contain whitespaces.
5596 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
5597 # is matched. Context messages in this collection should not set the
5598 # parameters field. Setting the `lifespan_count` to 0 will reset the context
5599 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5600 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5601 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5602 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5603 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
5604 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
5605 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5606 #
5607 # The `Context ID` is always converted to lowercase, may only contain
5608 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
5609 #
5610 # If `Environment ID` is not specified, we assume default 'draft'
5611 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5612 #
5613 # The following context names are reserved for internal use by Dialogflow.
5614 # You should not use these contexts or create contexts with these names:
5615 #
5616 # * `__system_counters__`
5617 # * `*_id_dialog_context`
5618 # * `*_dialog_params_size`
5619 "parameters": { # Optional. The collection of parameters associated with this context.
5620 #
5621 # Depending on your protocol or client library language, this is a
5622 # map, associative array, symbol table, dictionary, or JSON object
5623 # composed of a collection of (MapKey, MapValue) pairs:
5624 #
5625 # - MapKey type: string
5626 # - MapKey value: parameter name
5627 # - MapValue type:
5628 # - If parameter's entity type is a composite entity: map
5629 # - Else: string or number, depending on parameter value type
5630 # - MapValue value:
5631 # - If parameter's entity type is a composite entity:
5632 # map from composite entity property names to property values
5633 # - Else: parameter value
5634 "a_key": "", # Properties of the object.
5635 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5636 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5637 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5638 # immediately. Contexts expire automatically after 20 minutes if there
5639 # are no matching queries.
5640 },
5641 ],
5642 "events": [ # Optional. The collection of event names that trigger the intent.
5643 # If the collection of input contexts is not empty, all of the contexts must
5644 # 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^]5645 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5646 "A String",
5647 ],
5648 }</pre>
5649</div>
5650
5651</body></html>