Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dialogflow_v2.projects.agent.intents.html
blob: f79300f1b8cb0cabb43352dedf0285a8118e63be [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_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.agent.html">agent</a> . <a href="dialogflow_v2.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">
93 <code><a href="#list">list(parent, languageCode=None, pageSize=None, intentView=None, pageToken=None, x__xgafv=None)</a></code></p>
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 # Note: If `ml_disabled` setting is set to true, then this intent is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 "name": "A String", # Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
132 "displayName": "A String", # Required. The name of the parameter.
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.
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.
155 },
156 ],
157 "trainingPhrases": [ # Optional. The collection of examples that the agent is
158 # trained on.
159 { # Represents an example that the agent is trained on.
160 "parts": [ # Required. The ordered list of training phrase parts.
161 # The parts are concatenated in order to form the training phrase.
162 #
163 # Note: The API does not automatically annotate training phrases like the
164 # Dialogflow Console does.
165 #
166 # Note: Do not forget to include whitespace at part boundaries,
167 # so the training phrase is well formatted when the parts are concatenated.
168 #
169 # If the training phrase does not need to be annotated with parameters,
170 # you just need a single part with only the Part.text field set.
171 #
172 # If you want to annotate the training phrase, you must create multiple
173 # parts, where the fields of each part are populated in one of two ways:
174 #
175 # - `Part.text` is set to a part of the phrase that has no parameters.
176 # - `Part.text` is set to a part of the phrase that you want to annotate,
177 # and the `entity_type`, `alias`, and `user_defined` fields are all
178 # set.
179 { # Represents a part of a training phrase.
180 "alias": "A String", # Optional. The parameter name for the value extracted from the
181 # annotated part of the example.
182 # This field is required for annotated parts of the training phrase.
183 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
184 # This field is required for annotated parts of the training phrase.
185 "text": "A String", # Required. The text for this part.
186 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
187 # This field is set to true when the Dialogflow Console is used to
188 # manually annotate the part. When creating an annotated part with the
189 # API, you must set this to true.
190 },
191 ],
192 "type": "A String", # Required. The type of the training phrase.
193 "name": "A String", # Output only. The unique identifier of this training phrase.
194 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
195 # the intent. Each time a developer adds an existing sample by editing an
196 # intent or training, this counter is increased.
197 },
198 ],
199 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
200 # a direct or indirect parent. We populate this field only in the output.
201 { # Represents a single followup intent in the chain.
202 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]203 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]204 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 },
207 ],
208 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]209 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
210 # chain of followup intents. You can set this field when creating an intent,
211 # for example with CreateIntent or
212 # BatchUpdateIntents, in order to make this
213 # intent a followup intent.
214 #
215 # It identifies the parent followup intent.
216 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 "messages": [ # Optional. The collection of rich messages corresponding to the
218 # `Response` field in the Dialogflow console.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]219 { # A rich response message.
220 # Corresponds to the intent `Response` field in the Dialogflow console.
221 # For more information, see
222 # [Rich response
223 # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
225 # This message in `QueryResult.fulfillment_messages` and
226 # `WebhookResponse.fulfillment_messages` should contain only one
227 # `SimpleResponse`.
228 "simpleResponses": [ # Required. The list of simple responses.
229 { # The simple response message containing speech or text.
230 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
231 # speech output. Mutually exclusive with ssml.
232 "displayText": "A String", # Optional. The text to display.
233 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
234 # response to the user in the SSML format. Mutually exclusive with
235 # text_to_speech.
236 },
237 ],
238 },
239 "quickReplies": { # The quick replies response message. # The quick replies response.
240 "quickReplies": [ # Optional. The collection of quick replies.
241 "A String",
242 ],
243 "title": "A String", # Optional. The title of the collection of quick replies.
244 },
245 "platform": "A String", # Optional. The platform that this message is intended for.
246 "text": { # The text response message. # The text response.
247 "text": [ # Optional. The collection of the agent's responses.
248 "A String",
249 ],
250 },
251 "image": { # The image response message. # The image response.
252 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
253 # e.g., screen readers.
254 "imageUri": "A String", # Optional. The public URI to an image file.
255 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]256 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
257 "mediaObjects": [ # Required. List of media objects.
258 { # Response media object for media content card.
259 "contentUrl": "A String", # Required. Url where the media is stored.
260 "description": "A String", # Optional. Description of media card.
261 "name": "A String", # Required. Name of media card.
262 "largeImage": { # The image response message. # Optional. Image to display above media content.
263 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
264 # e.g., screen readers.
265 "imageUri": "A String", # Optional. The public URI to an image file.
266 },
267 "icon": { # The image response message. # Optional. Icon to display above media content.
268 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
269 # e.g., screen readers.
270 "imageUri": "A String", # Optional. The public URI to an image file.
271 },
272 },
273 ],
274 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
275 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
277 "suggestions": [ # Required. The list of suggested replies.
278 { # The suggestion chip message that the user can tap to quickly post a reply
279 # to the conversation.
280 "title": "A String", # Required. The text shown the in the suggestion chip.
281 },
282 ],
283 },
284 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
285 # or website associated with this agent.
286 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
287 # suggestion chip.
288 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
289 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]290 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
291 # https://developers.google.com/actions/assistant/responses#browsing_carousel
292 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
293 # items, maximum of ten.
294 { # Browsing carousel tile
295 "image": { # The image response message. # Optional. Hero image for the carousel item.
296 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
297 # e.g., screen readers.
298 "imageUri": "A String", # Optional. The public URI to an image file.
299 },
300 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
301 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
302 # text.
303 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
304 "url": "A String", # Required. URL
305 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
306 # the URL. Defaults to opening via web browser.
307 },
308 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
309 # Card. Maximum of one line of text.
310 },
311 ],
312 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
313 # items.
314 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]315 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
316 "buttons": [ # Optional. The collection of card buttons.
317 { # The button object that appears at the bottom of a card.
318 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
319 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
320 },
321 "title": "A String", # Required. The title of the button.
322 },
323 ],
324 "subtitle": "A String", # Optional. The subtitle of the card.
325 "image": { # The image response message. # Optional. The image for the card.
326 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
327 # e.g., screen readers.
328 "imageUri": "A String", # Optional. The public URI to an image file.
329 },
330 "formattedText": "A String", # Required, unless image is present. The body text of the card.
331 "title": "A String", # Optional. The title of the card.
332 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]333 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
334 "rows": [ # Optional. Rows in this table of data.
335 { # Row of TableCard.
336 "cells": [ # Optional. List of cells that make up this row.
337 { # Cell of TableCardRow.
338 "text": "A String", # Required. Text in this cell.
339 },
340 ],
341 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
342 },
343 ],
344 "subtitle": "A String", # Optional. Subtitle to the title.
345 "title": "A String", # Required. Title of the card.
346 "image": { # The image response message. # Optional. Image which should be displayed on the card.
347 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
348 # e.g., screen readers.
349 "imageUri": "A String", # Optional. The public URI to an image file.
350 },
351 "columnProperties": [ # Optional. Display properties for the columns in this table.
352 { # Column properties for TableCard.
353 "header": "A String", # Required. Column heading.
354 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
355 },
356 ],
357 "buttons": [ # Optional. List of buttons for the card.
358 { # The button object that appears at the bottom of a card.
359 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
360 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
361 },
362 "title": "A String", # Required. The title of the button.
363 },
364 ],
365 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]366 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
367 "items": [ # Required. Carousel items.
368 { # An item in the carousel.
369 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
370 # dialog.
371 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
372 # item in dialog.
373 "A String",
374 ],
375 "key": "A String", # Required. A unique key that will be sent back to the agent if this
376 # response is given.
377 },
378 "image": { # The image response message. # Optional. The image to display.
379 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
380 # e.g., screen readers.
381 "imageUri": "A String", # Optional. The public URI to an image file.
382 },
383 "description": "A String", # Optional. The body text of the card.
384 "title": "A String", # Required. Title of the carousel item.
385 },
386 ],
387 },
388 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
389 "items": [ # Required. List items.
390 { # An item in the list.
391 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
392 # dialog.
393 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
394 # item in dialog.
395 "A String",
396 ],
397 "key": "A String", # Required. A unique key that will be sent back to the agent if this
398 # response is given.
399 },
400 "image": { # The image response message. # Optional. The image to display.
401 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
402 # e.g., screen readers.
403 "imageUri": "A String", # Optional. The public URI to an image file.
404 },
405 "description": "A String", # Optional. The main text describing the item.
406 "title": "A String", # Required. The title of the list item.
407 },
408 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]409 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]410 "title": "A String", # Optional. The overall title of the list.
411 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]412 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]413 "a_key": "", # Properties of the object.
414 },
415 "card": { # The card response message. # The card response.
416 "buttons": [ # Optional. The collection of card buttons.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 { # Contains information about a button.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 "text": "A String", # Optional. The text to show on the button.
419 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
420 # open.
421 },
422 ],
423 "title": "A String", # Optional. The title of the card.
424 "subtitle": "A String", # Optional. The subtitle of the card.
425 "imageUri": "A String", # Optional. The public URI to an image file for the card.
426 },
427 },
428 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]429 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
430 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
431 "A String",
432 ],
433 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]434 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]435 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]436 # - If the supplied value is unspecified or 0, the service
437 # translates the value to 500,000, which corresponds to the
438 # `Normal` priority in the console.
439 # - If the supplied value is negative, the intent is ignored
440 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
442 # followup intents. It identifies the correct followup intents chain for
443 # this intent. We populate this field only in the output.
444 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]445 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]446 "action": "A String", # Optional. The name of the action associated with the intent.
447 # Note: The action name must not contain whitespaces.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]448 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
449 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]450 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
451 # is matched. Context messages in this collection should not set the
452 # parameters field. Setting the `lifespan_count` to 0 will reset the context
453 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]454 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]455 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]457 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
458 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
459 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]460 #
461 # The `Context ID` is always converted to lowercase, may only contain
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
463 #
464 # If `Environment ID` is not specified, we assume default 'draft'
465 # environment. If `User ID` is not specified, we assume default '-' user.
466 #
467 # The following context names are reserved for internal use by Dialogflow.
468 # You should not use these contexts or create contexts with these names:
469 #
470 # * `__system_counters__`
471 # * `*_id_dialog_context`
472 # * `*_dialog_params_size`
473 "parameters": { # Optional. The collection of parameters associated with this context.
474 #
475 # Depending on your protocol or client library language, this is a
476 # map, associative array, symbol table, dictionary, or JSON object
477 # composed of a collection of (MapKey, MapValue) pairs:
478 #
479 # - MapKey type: string
480 # - MapKey value: parameter name
481 # - MapValue type:
482 # - If parameter's entity type is a composite entity: map
483 # - Else: string or number, depending on parameter value type
484 # - MapValue value:
485 # - If parameter's entity type is a composite entity:
486 # map from composite entity property names to property values
487 # - Else: parameter value
488 "a_key": "", # Properties of the object.
489 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]491 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492 # immediately. Contexts expire automatically after 20 minutes if there
493 # are no matching queries.
494 },
495 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]496 "inputContextNames": [ # Optional. The list of context names required for this intent to be
497 # triggered.
498 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
499 "A String",
500 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]501 "events": [ # Optional. The collection of event names that trigger the intent.
502 # If the collection of input contexts is not empty, all of the contexts must
503 # 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^]504 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]505 "A String",
506 ],
507 },
508 ],
509 }
510
511 x__xgafv: string, V1 error format.
512 Allowed values
513 1 - v1 error format
514 2 - v2 error format
515
516Returns:
517 An object of the form:
518
519 { # This resource represents a long-running operation that is the result of a
520 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]521 "response": { # The normal response of the operation in case of success. If the original
522 # method returns no data on success, such as `Delete`, the response is
523 # `google.protobuf.Empty`. If the original method is standard
524 # `Get`/`Create`/`Update`, the response should be the resource. For other
525 # methods, the response should have the type `XxxResponse`, where `Xxx`
526 # is the original method name. For example, if the original method name
527 # is `TakeSnapshot()`, the inferred response type is
528 # `TakeSnapshotResponse`.
529 "a_key": "", # Properties of the object. Contains field @type with type URL.
530 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]531 "metadata": { # Service-specific metadata associated with the operation. It typically
532 # contains progress information and common metadata such as create time.
533 # Some services might not provide such metadata. Any method that returns a
534 # long-running operation should document the metadata type, if any.
535 "a_key": "", # Properties of the object. Contains field @type with type URL.
536 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]537 "done": True or False, # If the value is `false`, it means the operation is still in progress.
538 # If `true`, the operation is completed, and either `error` or `response` is
539 # available.
540 "name": "A String", # The server-assigned name, which is only unique within the same service that
541 # originally returns it. If you use the default HTTP mapping, the
542 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]543 "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.
544 # different programming environments, including REST APIs and RPC APIs. It is
545 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
546 # three pieces of data: error code, error message, and error details.
547 #
548 # You can find out more about this error model and how to work with it in the
549 # [API Design Guide](https://cloud.google.com/apis/design/errors).
550 "message": "A String", # A developer-facing error message, which should be in English. Any
551 # user-facing error message should be localized and sent in the
552 # google.rpc.Status.details field, or localized by the client.
553 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
554 "details": [ # A list of messages that carry the error details. There is a common set of
555 # message types for APIs to use.
556 {
557 "a_key": "", # Properties of the object. Contains field @type with type URL.
558 },
559 ],
560 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]561 }</pre>
562</div>
563
564<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]565 <code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]566 <pre>Updates/Creates multiple intents in the specified agent.
567
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]568Operation &lt;response: BatchUpdateIntentsResponse&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569
570Args:
571 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^]572Format: `projects/&lt;Project ID&gt;/agent`. (required)
573 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]574 The object takes the form of:
575
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]576{
577 "languageCode": "A String", # Optional. The language used to access language-specific data.
578 # If not specified, the agent's default language is used.
579 # For more information, see
580 # [Multilingual intent and entity
581 # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]582 "intentBatchUri": "A String", # The URI to a Google Cloud Storage file containing intents to update or
583 # create. The file format can either be a serialized proto (of IntentBatch
584 # type) or JSON object. Note: The URI must start with "gs://".
585 "intentBatchInline": { # This message is a wrapper around a collection of intents. # The collection of intents to update or create.
586 "intents": [ # A collection of intents.
587 { # Represents an intent.
588 # Intents convert a number of user expressions or patterns into an action. An
589 # action is an extraction of a user command or sentence semantics.
590 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
591 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]592 # Note: If `ml_disabled` setting is set to true, then this intent is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]593 # taken into account during inference in `ML ONLY` match mode. Also,
594 # auto-markup in the UI is turned off.
595 "displayName": "A String", # Required. The name of this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]596 "name": "A String", # Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]597 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
598 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]599 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]600 "parameters": [ # Optional. The collection of parameters associated with the intent.
601 { # Represents intent parameters.
602 "displayName": "A String", # Required. The name of the parameter.
603 "name": "A String", # The unique identifier of this parameter.
604 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
605 # result.
606 # Default values can be extracted from contexts by using the following
607 # syntax: `#context_name.parameter_name`.
608 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
609 # describes values of the parameter. If the parameter is
610 # required, this must be provided.
611 "value": "A String", # Optional. The definition of the parameter value. It can be:
612 # - a constant string,
613 # - a parameter value defined as `$parameter_name`,
614 # - an original parameter value defined as `$parameter_name.original`,
615 # - a parameter value from some context defined as
616 # `#context_name.parameter_name`.
617 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]618 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]619 "A String",
620 ],
621 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
622 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
623 # whether the intent cannot be completed without collecting the parameter
624 # value.
625 },
626 ],
627 "trainingPhrases": [ # Optional. The collection of examples that the agent is
628 # trained on.
629 { # Represents an example that the agent is trained on.
630 "parts": [ # Required. The ordered list of training phrase parts.
631 # The parts are concatenated in order to form the training phrase.
632 #
633 # Note: The API does not automatically annotate training phrases like the
634 # Dialogflow Console does.
635 #
636 # Note: Do not forget to include whitespace at part boundaries,
637 # so the training phrase is well formatted when the parts are concatenated.
638 #
639 # If the training phrase does not need to be annotated with parameters,
640 # you just need a single part with only the Part.text field set.
641 #
642 # If you want to annotate the training phrase, you must create multiple
643 # parts, where the fields of each part are populated in one of two ways:
644 #
645 # - `Part.text` is set to a part of the phrase that has no parameters.
646 # - `Part.text` is set to a part of the phrase that you want to annotate,
647 # and the `entity_type`, `alias`, and `user_defined` fields are all
648 # set.
649 { # Represents a part of a training phrase.
650 "alias": "A String", # Optional. The parameter name for the value extracted from the
651 # annotated part of the example.
652 # This field is required for annotated parts of the training phrase.
653 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
654 # This field is required for annotated parts of the training phrase.
655 "text": "A String", # Required. The text for this part.
656 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
657 # This field is set to true when the Dialogflow Console is used to
658 # manually annotate the part. When creating an annotated part with the
659 # API, you must set this to true.
660 },
661 ],
662 "type": "A String", # Required. The type of the training phrase.
663 "name": "A String", # Output only. The unique identifier of this training phrase.
664 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
665 # the intent. Each time a developer adds an existing sample by editing an
666 # intent or training, this counter is increased.
667 },
668 ],
669 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
670 # a direct or indirect parent. We populate this field only in the output.
671 { # Represents a single followup intent in the chain.
672 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]673 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]674 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]675 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]676 },
677 ],
678 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]679 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
680 # chain of followup intents. You can set this field when creating an intent,
681 # for example with CreateIntent or
682 # BatchUpdateIntents, in order to make this
683 # intent a followup intent.
684 #
685 # It identifies the parent followup intent.
686 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]687 "messages": [ # Optional. The collection of rich messages corresponding to the
688 # `Response` field in the Dialogflow console.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]689 { # A rich response message.
690 # Corresponds to the intent `Response` field in the Dialogflow console.
691 # For more information, see
692 # [Rich response
693 # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]694 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
695 # This message in `QueryResult.fulfillment_messages` and
696 # `WebhookResponse.fulfillment_messages` should contain only one
697 # `SimpleResponse`.
698 "simpleResponses": [ # Required. The list of simple responses.
699 { # The simple response message containing speech or text.
700 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
701 # speech output. Mutually exclusive with ssml.
702 "displayText": "A String", # Optional. The text to display.
703 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
704 # response to the user in the SSML format. Mutually exclusive with
705 # text_to_speech.
706 },
707 ],
708 },
709 "quickReplies": { # The quick replies response message. # The quick replies response.
710 "quickReplies": [ # Optional. The collection of quick replies.
711 "A String",
712 ],
713 "title": "A String", # Optional. The title of the collection of quick replies.
714 },
715 "platform": "A String", # Optional. The platform that this message is intended for.
716 "text": { # The text response message. # The text response.
717 "text": [ # Optional. The collection of the agent's responses.
718 "A String",
719 ],
720 },
721 "image": { # The image response message. # The image response.
722 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
723 # e.g., screen readers.
724 "imageUri": "A String", # Optional. The public URI to an image file.
725 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]726 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
727 "mediaObjects": [ # Required. List of media objects.
728 { # Response media object for media content card.
729 "contentUrl": "A String", # Required. Url where the media is stored.
730 "description": "A String", # Optional. Description of media card.
731 "name": "A String", # Required. Name of media card.
732 "largeImage": { # The image response message. # Optional. Image to display above media content.
733 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
734 # e.g., screen readers.
735 "imageUri": "A String", # Optional. The public URI to an image file.
736 },
737 "icon": { # The image response message. # Optional. Icon to display above media content.
738 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
739 # e.g., screen readers.
740 "imageUri": "A String", # Optional. The public URI to an image file.
741 },
742 },
743 ],
744 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
745 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]746 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
747 "suggestions": [ # Required. The list of suggested replies.
748 { # The suggestion chip message that the user can tap to quickly post a reply
749 # to the conversation.
750 "title": "A String", # Required. The text shown the in the suggestion chip.
751 },
752 ],
753 },
754 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
755 # or website associated with this agent.
756 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
757 # suggestion chip.
758 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
759 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]760 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
761 # https://developers.google.com/actions/assistant/responses#browsing_carousel
762 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
763 # items, maximum of ten.
764 { # Browsing carousel tile
765 "image": { # The image response message. # Optional. Hero image for the carousel item.
766 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
767 # e.g., screen readers.
768 "imageUri": "A String", # Optional. The public URI to an image file.
769 },
770 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
771 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
772 # text.
773 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
774 "url": "A String", # Required. URL
775 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
776 # the URL. Defaults to opening via web browser.
777 },
778 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
779 # Card. Maximum of one line of text.
780 },
781 ],
782 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
783 # items.
784 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]785 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
786 "buttons": [ # Optional. The collection of card buttons.
787 { # The button object that appears at the bottom of a card.
788 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
789 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
790 },
791 "title": "A String", # Required. The title of the button.
792 },
793 ],
794 "subtitle": "A String", # Optional. The subtitle of the card.
795 "image": { # The image response message. # Optional. The image for the card.
796 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
797 # e.g., screen readers.
798 "imageUri": "A String", # Optional. The public URI to an image file.
799 },
800 "formattedText": "A String", # Required, unless image is present. The body text of the card.
801 "title": "A String", # Optional. The title of the card.
802 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]803 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
804 "rows": [ # Optional. Rows in this table of data.
805 { # Row of TableCard.
806 "cells": [ # Optional. List of cells that make up this row.
807 { # Cell of TableCardRow.
808 "text": "A String", # Required. Text in this cell.
809 },
810 ],
811 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
812 },
813 ],
814 "subtitle": "A String", # Optional. Subtitle to the title.
815 "title": "A String", # Required. Title of the card.
816 "image": { # The image response message. # Optional. Image which should be displayed on the card.
817 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
818 # e.g., screen readers.
819 "imageUri": "A String", # Optional. The public URI to an image file.
820 },
821 "columnProperties": [ # Optional. Display properties for the columns in this table.
822 { # Column properties for TableCard.
823 "header": "A String", # Required. Column heading.
824 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
825 },
826 ],
827 "buttons": [ # Optional. List of buttons for the card.
828 { # The button object that appears at the bottom of a card.
829 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
830 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
831 },
832 "title": "A String", # Required. The title of the button.
833 },
834 ],
835 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]836 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
837 "items": [ # Required. Carousel items.
838 { # An item in the carousel.
839 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
840 # dialog.
841 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
842 # item in dialog.
843 "A String",
844 ],
845 "key": "A String", # Required. A unique key that will be sent back to the agent if this
846 # response is given.
847 },
848 "image": { # The image response message. # Optional. The image to display.
849 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
850 # e.g., screen readers.
851 "imageUri": "A String", # Optional. The public URI to an image file.
852 },
853 "description": "A String", # Optional. The body text of the card.
854 "title": "A String", # Required. Title of the carousel item.
855 },
856 ],
857 },
858 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
859 "items": [ # Required. List items.
860 { # An item in the list.
861 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
862 # dialog.
863 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
864 # item in dialog.
865 "A String",
866 ],
867 "key": "A String", # Required. A unique key that will be sent back to the agent if this
868 # response is given.
869 },
870 "image": { # The image response message. # Optional. The image to display.
871 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
872 # e.g., screen readers.
873 "imageUri": "A String", # Optional. The public URI to an image file.
874 },
875 "description": "A String", # Optional. The main text describing the item.
876 "title": "A String", # Required. The title of the list item.
877 },
878 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]879 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]880 "title": "A String", # Optional. The overall title of the list.
881 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]882 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]883 "a_key": "", # Properties of the object.
884 },
885 "card": { # The card response message. # The card response.
886 "buttons": [ # Optional. The collection of card buttons.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]887 { # Contains information about a button.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]888 "text": "A String", # Optional. The text to show on the button.
889 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
890 # open.
891 },
892 ],
893 "title": "A String", # Optional. The title of the card.
894 "subtitle": "A String", # Optional. The subtitle of the card.
895 "imageUri": "A String", # Optional. The public URI to an image file for the card.
896 },
897 },
898 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]899 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
900 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
901 "A String",
902 ],
903 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]904 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]905 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]906 # - If the supplied value is unspecified or 0, the service
907 # translates the value to 500,000, which corresponds to the
908 # `Normal` priority in the console.
909 # - If the supplied value is negative, the intent is ignored
910 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]911 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
912 # followup intents. It identifies the correct followup intents chain for
913 # this intent. We populate this field only in the output.
914 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]915 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]916 "action": "A String", # Optional. The name of the action associated with the intent.
917 # Note: The action name must not contain whitespaces.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]918 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
919 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]920 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
921 # is matched. Context messages in this collection should not set the
922 # parameters field. Setting the `lifespan_count` to 0 will reset the context
923 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]924 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]925 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]926 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]927 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
928 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
929 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]930 #
931 # The `Context ID` is always converted to lowercase, may only contain
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]932 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
933 #
934 # If `Environment ID` is not specified, we assume default 'draft'
935 # environment. If `User ID` is not specified, we assume default '-' user.
936 #
937 # The following context names are reserved for internal use by Dialogflow.
938 # You should not use these contexts or create contexts with these names:
939 #
940 # * `__system_counters__`
941 # * `*_id_dialog_context`
942 # * `*_dialog_params_size`
943 "parameters": { # Optional. The collection of parameters associated with this context.
944 #
945 # Depending on your protocol or client library language, this is a
946 # map, associative array, symbol table, dictionary, or JSON object
947 # composed of a collection of (MapKey, MapValue) pairs:
948 #
949 # - MapKey type: string
950 # - MapKey value: parameter name
951 # - MapValue type:
952 # - If parameter's entity type is a composite entity: map
953 # - Else: string or number, depending on parameter value type
954 # - MapValue value:
955 # - If parameter's entity type is a composite entity:
956 # map from composite entity property names to property values
957 # - Else: parameter value
958 "a_key": "", # Properties of the object.
959 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]960 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]961 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]962 # immediately. Contexts expire automatically after 20 minutes if there
963 # are no matching queries.
964 },
965 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]966 "inputContextNames": [ # Optional. The list of context names required for this intent to be
967 # triggered.
968 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
969 "A String",
970 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]971 "events": [ # Optional. The collection of event names that trigger the intent.
972 # If the collection of input contexts is not empty, all of the contexts must
973 # 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^]974 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]975 "A String",
976 ],
977 },
978 ],
979 },
980 "updateMask": "A String", # Optional. The mask to control which fields get updated.
981 "intentView": "A String", # Optional. The resource view to apply to the returned intent.
982 }
983
984 x__xgafv: string, V1 error format.
985 Allowed values
986 1 - v1 error format
987 2 - v2 error format
988
989Returns:
990 An object of the form:
991
992 { # This resource represents a long-running operation that is the result of a
993 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]994 "response": { # The normal response of the operation in case of success. If the original
995 # method returns no data on success, such as `Delete`, the response is
996 # `google.protobuf.Empty`. If the original method is standard
997 # `Get`/`Create`/`Update`, the response should be the resource. For other
998 # methods, the response should have the type `XxxResponse`, where `Xxx`
999 # is the original method name. For example, if the original method name
1000 # is `TakeSnapshot()`, the inferred response type is
1001 # `TakeSnapshotResponse`.
1002 "a_key": "", # Properties of the object. Contains field @type with type URL.
1003 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1004 "metadata": { # Service-specific metadata associated with the operation. It typically
1005 # contains progress information and common metadata such as create time.
1006 # Some services might not provide such metadata. Any method that returns a
1007 # long-running operation should document the metadata type, if any.
1008 "a_key": "", # Properties of the object. Contains field @type with type URL.
1009 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1010 "done": True or False, # If the value is `false`, it means the operation is still in progress.
1011 # If `true`, the operation is completed, and either `error` or `response` is
1012 # available.
1013 "name": "A String", # The server-assigned name, which is only unique within the same service that
1014 # originally returns it. If you use the default HTTP mapping, the
1015 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1016 "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.
1017 # different programming environments, including REST APIs and RPC APIs. It is
1018 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1019 # three pieces of data: error code, error message, and error details.
1020 #
1021 # You can find out more about this error model and how to work with it in the
1022 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1023 "message": "A String", # A developer-facing error message, which should be in English. Any
1024 # user-facing error message should be localized and sent in the
1025 # google.rpc.Status.details field, or localized by the client.
1026 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1027 "details": [ # A list of messages that carry the error details. There is a common set of
1028 # message types for APIs to use.
1029 {
1030 "a_key": "", # Properties of the object. Contains field @type with type URL.
1031 },
1032 ],
1033 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1034 }</pre>
1035</div>
1036
1037<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1038 <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]1039 <pre>Creates an intent in the specified agent.
1040
1041Args:
1042 parent: string, Required. The agent to create a intent for.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1043Format: `projects/&lt;Project ID&gt;/agent`. (required)
1044 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1045 The object takes the form of:
1046
1047{ # Represents an intent.
1048 # Intents convert a number of user expressions or patterns into an action. An
1049 # action is an extraction of a user command or sentence semantics.
1050 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
1051 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1052 # Note: If `ml_disabled` setting is set to true, then this intent is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1053 # taken into account during inference in `ML ONLY` match mode. Also,
1054 # auto-markup in the UI is turned off.
1055 "displayName": "A String", # Required. The name of this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1056 "name": "A String", # Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1057 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
1058 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1059 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1060 "parameters": [ # Optional. The collection of parameters associated with the intent.
1061 { # Represents intent parameters.
1062 "displayName": "A String", # Required. The name of the parameter.
1063 "name": "A String", # The unique identifier of this parameter.
1064 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
1065 # result.
1066 # Default values can be extracted from contexts by using the following
1067 # syntax: `#context_name.parameter_name`.
1068 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
1069 # describes values of the parameter. If the parameter is
1070 # required, this must be provided.
1071 "value": "A String", # Optional. The definition of the parameter value. It can be:
1072 # - a constant string,
1073 # - a parameter value defined as `$parameter_name`,
1074 # - an original parameter value defined as `$parameter_name.original`,
1075 # - a parameter value from some context defined as
1076 # `#context_name.parameter_name`.
1077 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1078 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1079 "A String",
1080 ],
1081 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
1082 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
1083 # whether the intent cannot be completed without collecting the parameter
1084 # value.
1085 },
1086 ],
1087 "trainingPhrases": [ # Optional. The collection of examples that the agent is
1088 # trained on.
1089 { # Represents an example that the agent is trained on.
1090 "parts": [ # Required. The ordered list of training phrase parts.
1091 # The parts are concatenated in order to form the training phrase.
1092 #
1093 # Note: The API does not automatically annotate training phrases like the
1094 # Dialogflow Console does.
1095 #
1096 # Note: Do not forget to include whitespace at part boundaries,
1097 # so the training phrase is well formatted when the parts are concatenated.
1098 #
1099 # If the training phrase does not need to be annotated with parameters,
1100 # you just need a single part with only the Part.text field set.
1101 #
1102 # If you want to annotate the training phrase, you must create multiple
1103 # parts, where the fields of each part are populated in one of two ways:
1104 #
1105 # - `Part.text` is set to a part of the phrase that has no parameters.
1106 # - `Part.text` is set to a part of the phrase that you want to annotate,
1107 # and the `entity_type`, `alias`, and `user_defined` fields are all
1108 # set.
1109 { # Represents a part of a training phrase.
1110 "alias": "A String", # Optional. The parameter name for the value extracted from the
1111 # annotated part of the example.
1112 # This field is required for annotated parts of the training phrase.
1113 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
1114 # This field is required for annotated parts of the training phrase.
1115 "text": "A String", # Required. The text for this part.
1116 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
1117 # This field is set to true when the Dialogflow Console is used to
1118 # manually annotate the part. When creating an annotated part with the
1119 # API, you must set this to true.
1120 },
1121 ],
1122 "type": "A String", # Required. The type of the training phrase.
1123 "name": "A String", # Output only. The unique identifier of this training phrase.
1124 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
1125 # the intent. Each time a developer adds an existing sample by editing an
1126 # intent or training, this counter is increased.
1127 },
1128 ],
1129 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
1130 # a direct or indirect parent. We populate this field only in the output.
1131 { # Represents a single followup intent in the chain.
1132 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1133 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1134 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1135 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1136 },
1137 ],
1138 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1139 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
1140 # chain of followup intents. You can set this field when creating an intent,
1141 # for example with CreateIntent or
1142 # BatchUpdateIntents, in order to make this
1143 # intent a followup intent.
1144 #
1145 # It identifies the parent followup intent.
1146 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1147 "messages": [ # Optional. The collection of rich messages corresponding to the
1148 # `Response` field in the Dialogflow console.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1149 { # A rich response message.
1150 # Corresponds to the intent `Response` field in the Dialogflow console.
1151 # For more information, see
1152 # [Rich response
1153 # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1154 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
1155 # This message in `QueryResult.fulfillment_messages` and
1156 # `WebhookResponse.fulfillment_messages` should contain only one
1157 # `SimpleResponse`.
1158 "simpleResponses": [ # Required. The list of simple responses.
1159 { # The simple response message containing speech or text.
1160 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
1161 # speech output. Mutually exclusive with ssml.
1162 "displayText": "A String", # Optional. The text to display.
1163 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
1164 # response to the user in the SSML format. Mutually exclusive with
1165 # text_to_speech.
1166 },
1167 ],
1168 },
1169 "quickReplies": { # The quick replies response message. # The quick replies response.
1170 "quickReplies": [ # Optional. The collection of quick replies.
1171 "A String",
1172 ],
1173 "title": "A String", # Optional. The title of the collection of quick replies.
1174 },
1175 "platform": "A String", # Optional. The platform that this message is intended for.
1176 "text": { # The text response message. # The text response.
1177 "text": [ # Optional. The collection of the agent's responses.
1178 "A String",
1179 ],
1180 },
1181 "image": { # The image response message. # The image response.
1182 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1183 # e.g., screen readers.
1184 "imageUri": "A String", # Optional. The public URI to an image file.
1185 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1186 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
1187 "mediaObjects": [ # Required. List of media objects.
1188 { # Response media object for media content card.
1189 "contentUrl": "A String", # Required. Url where the media is stored.
1190 "description": "A String", # Optional. Description of media card.
1191 "name": "A String", # Required. Name of media card.
1192 "largeImage": { # The image response message. # Optional. Image to display above media content.
1193 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1194 # e.g., screen readers.
1195 "imageUri": "A String", # Optional. The public URI to an image file.
1196 },
1197 "icon": { # The image response message. # Optional. Icon to display above media content.
1198 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1199 # e.g., screen readers.
1200 "imageUri": "A String", # Optional. The public URI to an image file.
1201 },
1202 },
1203 ],
1204 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
1205 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1206 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
1207 "suggestions": [ # Required. The list of suggested replies.
1208 { # The suggestion chip message that the user can tap to quickly post a reply
1209 # to the conversation.
1210 "title": "A String", # Required. The text shown the in the suggestion chip.
1211 },
1212 ],
1213 },
1214 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
1215 # or website associated with this agent.
1216 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
1217 # suggestion chip.
1218 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
1219 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1220 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
1221 # https://developers.google.com/actions/assistant/responses#browsing_carousel
1222 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
1223 # items, maximum of ten.
1224 { # Browsing carousel tile
1225 "image": { # The image response message. # Optional. Hero image for the carousel item.
1226 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1227 # e.g., screen readers.
1228 "imageUri": "A String", # Optional. The public URI to an image file.
1229 },
1230 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
1231 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
1232 # text.
1233 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
1234 "url": "A String", # Required. URL
1235 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
1236 # the URL. Defaults to opening via web browser.
1237 },
1238 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
1239 # Card. Maximum of one line of text.
1240 },
1241 ],
1242 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
1243 # items.
1244 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1245 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
1246 "buttons": [ # Optional. The collection of card buttons.
1247 { # The button object that appears at the bottom of a card.
1248 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1249 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1250 },
1251 "title": "A String", # Required. The title of the button.
1252 },
1253 ],
1254 "subtitle": "A String", # Optional. The subtitle of the card.
1255 "image": { # The image response message. # Optional. The image for the card.
1256 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1257 # e.g., screen readers.
1258 "imageUri": "A String", # Optional. The public URI to an image file.
1259 },
1260 "formattedText": "A String", # Required, unless image is present. The body text of the card.
1261 "title": "A String", # Optional. The title of the card.
1262 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1263 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
1264 "rows": [ # Optional. Rows in this table of data.
1265 { # Row of TableCard.
1266 "cells": [ # Optional. List of cells that make up this row.
1267 { # Cell of TableCardRow.
1268 "text": "A String", # Required. Text in this cell.
1269 },
1270 ],
1271 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
1272 },
1273 ],
1274 "subtitle": "A String", # Optional. Subtitle to the title.
1275 "title": "A String", # Required. Title of the card.
1276 "image": { # The image response message. # Optional. Image which should be displayed on the card.
1277 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1278 # e.g., screen readers.
1279 "imageUri": "A String", # Optional. The public URI to an image file.
1280 },
1281 "columnProperties": [ # Optional. Display properties for the columns in this table.
1282 { # Column properties for TableCard.
1283 "header": "A String", # Required. Column heading.
1284 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
1285 },
1286 ],
1287 "buttons": [ # Optional. List of buttons for the card.
1288 { # The button object that appears at the bottom of a card.
1289 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1290 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1291 },
1292 "title": "A String", # Required. The title of the button.
1293 },
1294 ],
1295 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1296 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
1297 "items": [ # Required. Carousel items.
1298 { # An item in the carousel.
1299 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
1300 # dialog.
1301 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1302 # item in dialog.
1303 "A String",
1304 ],
1305 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1306 # response is given.
1307 },
1308 "image": { # The image response message. # Optional. The image to display.
1309 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1310 # e.g., screen readers.
1311 "imageUri": "A String", # Optional. The public URI to an image file.
1312 },
1313 "description": "A String", # Optional. The body text of the card.
1314 "title": "A String", # Required. Title of the carousel item.
1315 },
1316 ],
1317 },
1318 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
1319 "items": [ # Required. List items.
1320 { # An item in the list.
1321 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
1322 # dialog.
1323 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1324 # item in dialog.
1325 "A String",
1326 ],
1327 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1328 # response is given.
1329 },
1330 "image": { # The image response message. # Optional. The image to display.
1331 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1332 # e.g., screen readers.
1333 "imageUri": "A String", # Optional. The public URI to an image file.
1334 },
1335 "description": "A String", # Optional. The main text describing the item.
1336 "title": "A String", # Required. The title of the list item.
1337 },
1338 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1339 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1340 "title": "A String", # Optional. The overall title of the list.
1341 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1342 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1343 "a_key": "", # Properties of the object.
1344 },
1345 "card": { # The card response message. # The card response.
1346 "buttons": [ # Optional. The collection of card buttons.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1347 { # Contains information about a button.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1348 "text": "A String", # Optional. The text to show on the button.
1349 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1350 # open.
1351 },
1352 ],
1353 "title": "A String", # Optional. The title of the card.
1354 "subtitle": "A String", # Optional. The subtitle of the card.
1355 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1356 },
1357 },
1358 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1359 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
1360 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
1361 "A String",
1362 ],
1363 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1364 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1365 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1366 # - If the supplied value is unspecified or 0, the service
1367 # translates the value to 500,000, which corresponds to the
1368 # `Normal` priority in the console.
1369 # - If the supplied value is negative, the intent is ignored
1370 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1371 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
1372 # followup intents. It identifies the correct followup intents chain for
1373 # this intent. We populate this field only in the output.
1374 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1375 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1376 "action": "A String", # Optional. The name of the action associated with the intent.
1377 # Note: The action name must not contain whitespaces.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1378 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
1379 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1380 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
1381 # is matched. Context messages in this collection should not set the
1382 # parameters field. Setting the `lifespan_count` to 0 will reset the context
1383 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1384 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1385 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1386 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1387 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
1388 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
1389 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1390 #
1391 # The `Context ID` is always converted to lowercase, may only contain
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1392 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
1393 #
1394 # If `Environment ID` is not specified, we assume default 'draft'
1395 # environment. If `User ID` is not specified, we assume default '-' user.
1396 #
1397 # The following context names are reserved for internal use by Dialogflow.
1398 # You should not use these contexts or create contexts with these names:
1399 #
1400 # * `__system_counters__`
1401 # * `*_id_dialog_context`
1402 # * `*_dialog_params_size`
1403 "parameters": { # Optional. The collection of parameters associated with this context.
1404 #
1405 # Depending on your protocol or client library language, this is a
1406 # map, associative array, symbol table, dictionary, or JSON object
1407 # composed of a collection of (MapKey, MapValue) pairs:
1408 #
1409 # - MapKey type: string
1410 # - MapKey value: parameter name
1411 # - MapValue type:
1412 # - If parameter's entity type is a composite entity: map
1413 # - Else: string or number, depending on parameter value type
1414 # - MapValue value:
1415 # - If parameter's entity type is a composite entity:
1416 # map from composite entity property names to property values
1417 # - Else: parameter value
1418 "a_key": "", # Properties of the object.
1419 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1420 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1421 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1422 # immediately. Contexts expire automatically after 20 minutes if there
1423 # are no matching queries.
1424 },
1425 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1426 "inputContextNames": [ # Optional. The list of context names required for this intent to be
1427 # triggered.
1428 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
1429 "A String",
1430 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1431 "events": [ # Optional. The collection of event names that trigger the intent.
1432 # If the collection of input contexts is not empty, all of the contexts must
1433 # 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^]1434 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1435 "A String",
1436 ],
1437}
1438
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1439 languageCode: string, Optional. The language used to access language-specific data.
1440If not specified, the agent's default language is used.
1441For more information, see
1442[Multilingual intent and entity
1443data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1444 intentView: string, Optional. The resource view to apply to the returned intent.
1445 x__xgafv: string, V1 error format.
1446 Allowed values
1447 1 - v1 error format
1448 2 - v2 error format
1449
1450Returns:
1451 An object of the form:
1452
1453 { # Represents an intent.
1454 # Intents convert a number of user expressions or patterns into an action. An
1455 # action is an extraction of a user command or sentence semantics.
1456 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
1457 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1458 # Note: If `ml_disabled` setting is set to true, then this intent is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1459 # taken into account during inference in `ML ONLY` match mode. Also,
1460 # auto-markup in the UI is turned off.
1461 "displayName": "A String", # Required. The name of this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1462 "name": "A String", # Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1463 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
1464 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1465 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1466 "parameters": [ # Optional. The collection of parameters associated with the intent.
1467 { # Represents intent parameters.
1468 "displayName": "A String", # Required. The name of the parameter.
1469 "name": "A String", # The unique identifier of this parameter.
1470 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
1471 # result.
1472 # Default values can be extracted from contexts by using the following
1473 # syntax: `#context_name.parameter_name`.
1474 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
1475 # describes values of the parameter. If the parameter is
1476 # required, this must be provided.
1477 "value": "A String", # Optional. The definition of the parameter value. It can be:
1478 # - a constant string,
1479 # - a parameter value defined as `$parameter_name`,
1480 # - an original parameter value defined as `$parameter_name.original`,
1481 # - a parameter value from some context defined as
1482 # `#context_name.parameter_name`.
1483 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1484 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1485 "A String",
1486 ],
1487 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
1488 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
1489 # whether the intent cannot be completed without collecting the parameter
1490 # value.
1491 },
1492 ],
1493 "trainingPhrases": [ # Optional. The collection of examples that the agent is
1494 # trained on.
1495 { # Represents an example that the agent is trained on.
1496 "parts": [ # Required. The ordered list of training phrase parts.
1497 # The parts are concatenated in order to form the training phrase.
1498 #
1499 # Note: The API does not automatically annotate training phrases like the
1500 # Dialogflow Console does.
1501 #
1502 # Note: Do not forget to include whitespace at part boundaries,
1503 # so the training phrase is well formatted when the parts are concatenated.
1504 #
1505 # If the training phrase does not need to be annotated with parameters,
1506 # you just need a single part with only the Part.text field set.
1507 #
1508 # If you want to annotate the training phrase, you must create multiple
1509 # parts, where the fields of each part are populated in one of two ways:
1510 #
1511 # - `Part.text` is set to a part of the phrase that has no parameters.
1512 # - `Part.text` is set to a part of the phrase that you want to annotate,
1513 # and the `entity_type`, `alias`, and `user_defined` fields are all
1514 # set.
1515 { # Represents a part of a training phrase.
1516 "alias": "A String", # Optional. The parameter name for the value extracted from the
1517 # annotated part of the example.
1518 # This field is required for annotated parts of the training phrase.
1519 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
1520 # This field is required for annotated parts of the training phrase.
1521 "text": "A String", # Required. The text for this part.
1522 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
1523 # This field is set to true when the Dialogflow Console is used to
1524 # manually annotate the part. When creating an annotated part with the
1525 # API, you must set this to true.
1526 },
1527 ],
1528 "type": "A String", # Required. The type of the training phrase.
1529 "name": "A String", # Output only. The unique identifier of this training phrase.
1530 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
1531 # the intent. Each time a developer adds an existing sample by editing an
1532 # intent or training, this counter is increased.
1533 },
1534 ],
1535 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
1536 # a direct or indirect parent. We populate this field only in the output.
1537 { # Represents a single followup intent in the chain.
1538 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1539 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1540 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1541 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1542 },
1543 ],
1544 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1545 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
1546 # chain of followup intents. You can set this field when creating an intent,
1547 # for example with CreateIntent or
1548 # BatchUpdateIntents, in order to make this
1549 # intent a followup intent.
1550 #
1551 # It identifies the parent followup intent.
1552 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1553 "messages": [ # Optional. The collection of rich messages corresponding to the
1554 # `Response` field in the Dialogflow console.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1555 { # A rich response message.
1556 # Corresponds to the intent `Response` field in the Dialogflow console.
1557 # For more information, see
1558 # [Rich response
1559 # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1560 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
1561 # This message in `QueryResult.fulfillment_messages` and
1562 # `WebhookResponse.fulfillment_messages` should contain only one
1563 # `SimpleResponse`.
1564 "simpleResponses": [ # Required. The list of simple responses.
1565 { # The simple response message containing speech or text.
1566 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
1567 # speech output. Mutually exclusive with ssml.
1568 "displayText": "A String", # Optional. The text to display.
1569 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
1570 # response to the user in the SSML format. Mutually exclusive with
1571 # text_to_speech.
1572 },
1573 ],
1574 },
1575 "quickReplies": { # The quick replies response message. # The quick replies response.
1576 "quickReplies": [ # Optional. The collection of quick replies.
1577 "A String",
1578 ],
1579 "title": "A String", # Optional. The title of the collection of quick replies.
1580 },
1581 "platform": "A String", # Optional. The platform that this message is intended for.
1582 "text": { # The text response message. # The text response.
1583 "text": [ # Optional. The collection of the agent's responses.
1584 "A String",
1585 ],
1586 },
1587 "image": { # The image response message. # The image response.
1588 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1589 # e.g., screen readers.
1590 "imageUri": "A String", # Optional. The public URI to an image file.
1591 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1592 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
1593 "mediaObjects": [ # Required. List of media objects.
1594 { # Response media object for media content card.
1595 "contentUrl": "A String", # Required. Url where the media is stored.
1596 "description": "A String", # Optional. Description of media card.
1597 "name": "A String", # Required. Name of media card.
1598 "largeImage": { # The image response message. # Optional. Image to display above media content.
1599 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1600 # e.g., screen readers.
1601 "imageUri": "A String", # Optional. The public URI to an image file.
1602 },
1603 "icon": { # The image response message. # Optional. Icon to display above media content.
1604 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1605 # e.g., screen readers.
1606 "imageUri": "A String", # Optional. The public URI to an image file.
1607 },
1608 },
1609 ],
1610 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
1611 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1612 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
1613 "suggestions": [ # Required. The list of suggested replies.
1614 { # The suggestion chip message that the user can tap to quickly post a reply
1615 # to the conversation.
1616 "title": "A String", # Required. The text shown the in the suggestion chip.
1617 },
1618 ],
1619 },
1620 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
1621 # or website associated with this agent.
1622 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
1623 # suggestion chip.
1624 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
1625 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1626 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
1627 # https://developers.google.com/actions/assistant/responses#browsing_carousel
1628 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
1629 # items, maximum of ten.
1630 { # Browsing carousel tile
1631 "image": { # The image response message. # Optional. Hero image for the carousel item.
1632 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1633 # e.g., screen readers.
1634 "imageUri": "A String", # Optional. The public URI to an image file.
1635 },
1636 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
1637 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
1638 # text.
1639 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
1640 "url": "A String", # Required. URL
1641 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
1642 # the URL. Defaults to opening via web browser.
1643 },
1644 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
1645 # Card. Maximum of one line of text.
1646 },
1647 ],
1648 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
1649 # items.
1650 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1651 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
1652 "buttons": [ # Optional. The collection of card buttons.
1653 { # The button object that appears at the bottom of a card.
1654 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1655 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1656 },
1657 "title": "A String", # Required. The title of the button.
1658 },
1659 ],
1660 "subtitle": "A String", # Optional. The subtitle of the card.
1661 "image": { # The image response message. # Optional. The image for the card.
1662 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1663 # e.g., screen readers.
1664 "imageUri": "A String", # Optional. The public URI to an image file.
1665 },
1666 "formattedText": "A String", # Required, unless image is present. The body text of the card.
1667 "title": "A String", # Optional. The title of the card.
1668 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1669 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
1670 "rows": [ # Optional. Rows in this table of data.
1671 { # Row of TableCard.
1672 "cells": [ # Optional. List of cells that make up this row.
1673 { # Cell of TableCardRow.
1674 "text": "A String", # Required. Text in this cell.
1675 },
1676 ],
1677 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
1678 },
1679 ],
1680 "subtitle": "A String", # Optional. Subtitle to the title.
1681 "title": "A String", # Required. Title of the card.
1682 "image": { # The image response message. # Optional. Image which should be displayed on the card.
1683 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1684 # e.g., screen readers.
1685 "imageUri": "A String", # Optional. The public URI to an image file.
1686 },
1687 "columnProperties": [ # Optional. Display properties for the columns in this table.
1688 { # Column properties for TableCard.
1689 "header": "A String", # Required. Column heading.
1690 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
1691 },
1692 ],
1693 "buttons": [ # Optional. List of buttons for the card.
1694 { # The button object that appears at the bottom of a card.
1695 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
1696 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
1697 },
1698 "title": "A String", # Required. The title of the button.
1699 },
1700 ],
1701 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1702 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
1703 "items": [ # Required. Carousel items.
1704 { # An item in the carousel.
1705 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
1706 # dialog.
1707 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1708 # item in dialog.
1709 "A String",
1710 ],
1711 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1712 # response is given.
1713 },
1714 "image": { # The image response message. # Optional. The image to display.
1715 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1716 # e.g., screen readers.
1717 "imageUri": "A String", # Optional. The public URI to an image file.
1718 },
1719 "description": "A String", # Optional. The body text of the card.
1720 "title": "A String", # Required. Title of the carousel item.
1721 },
1722 ],
1723 },
1724 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
1725 "items": [ # Required. List items.
1726 { # An item in the list.
1727 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
1728 # dialog.
1729 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
1730 # item in dialog.
1731 "A String",
1732 ],
1733 "key": "A String", # Required. A unique key that will be sent back to the agent if this
1734 # response is given.
1735 },
1736 "image": { # The image response message. # Optional. The image to display.
1737 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
1738 # e.g., screen readers.
1739 "imageUri": "A String", # Optional. The public URI to an image file.
1740 },
1741 "description": "A String", # Optional. The main text describing the item.
1742 "title": "A String", # Required. The title of the list item.
1743 },
1744 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1745 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1746 "title": "A String", # Optional. The overall title of the list.
1747 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1748 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1749 "a_key": "", # Properties of the object.
1750 },
1751 "card": { # The card response message. # The card response.
1752 "buttons": [ # Optional. The collection of card buttons.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1753 { # Contains information about a button.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1754 "text": "A String", # Optional. The text to show on the button.
1755 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
1756 # open.
1757 },
1758 ],
1759 "title": "A String", # Optional. The title of the card.
1760 "subtitle": "A String", # Optional. The subtitle of the card.
1761 "imageUri": "A String", # Optional. The public URI to an image file for the card.
1762 },
1763 },
1764 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1765 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
1766 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
1767 "A String",
1768 ],
1769 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1770 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1771 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1772 # - If the supplied value is unspecified or 0, the service
1773 # translates the value to 500,000, which corresponds to the
1774 # `Normal` priority in the console.
1775 # - If the supplied value is negative, the intent is ignored
1776 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1777 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
1778 # followup intents. It identifies the correct followup intents chain for
1779 # this intent. We populate this field only in the output.
1780 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1781 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1782 "action": "A String", # Optional. The name of the action associated with the intent.
1783 # Note: The action name must not contain whitespaces.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1784 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
1785 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1786 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
1787 # is matched. Context messages in this collection should not set the
1788 # parameters field. Setting the `lifespan_count` to 0 will reset the context
1789 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1790 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1791 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1792 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1793 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
1794 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
1795 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1796 #
1797 # The `Context ID` is always converted to lowercase, may only contain
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1798 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
1799 #
1800 # If `Environment ID` is not specified, we assume default 'draft'
1801 # environment. If `User ID` is not specified, we assume default '-' user.
1802 #
1803 # The following context names are reserved for internal use by Dialogflow.
1804 # You should not use these contexts or create contexts with these names:
1805 #
1806 # * `__system_counters__`
1807 # * `*_id_dialog_context`
1808 # * `*_dialog_params_size`
1809 "parameters": { # Optional. The collection of parameters associated with this context.
1810 #
1811 # Depending on your protocol or client library language, this is a
1812 # map, associative array, symbol table, dictionary, or JSON object
1813 # composed of a collection of (MapKey, MapValue) pairs:
1814 #
1815 # - MapKey type: string
1816 # - MapKey value: parameter name
1817 # - MapValue type:
1818 # - If parameter's entity type is a composite entity: map
1819 # - Else: string or number, depending on parameter value type
1820 # - MapValue value:
1821 # - If parameter's entity type is a composite entity:
1822 # map from composite entity property names to property values
1823 # - Else: parameter value
1824 "a_key": "", # Properties of the object.
1825 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1826 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1827 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1828 # immediately. Contexts expire automatically after 20 minutes if there
1829 # are no matching queries.
1830 },
1831 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1832 "inputContextNames": [ # Optional. The list of context names required for this intent to be
1833 # triggered.
1834 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
1835 "A String",
1836 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1837 "events": [ # Optional. The collection of event names that trigger the intent.
1838 # If the collection of input contexts is not empty, all of the contexts must
1839 # 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^]1840 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1841 "A String",
1842 ],
1843 }</pre>
1844</div>
1845
1846<div class="method">
1847 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
1848 <pre>Deletes the specified intent and its direct or indirect followup intents.
1849
1850Args:
1851 name: string, Required. The name of the intent to delete. If this intent has direct or
1852indirect followup intents, we also delete them.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1853Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1854 x__xgafv: string, V1 error format.
1855 Allowed values
1856 1 - v1 error format
1857 2 - v2 error format
1858
1859Returns:
1860 An object of the form:
1861
1862 { # A generic empty message that you can re-use to avoid defining duplicated
1863 # empty messages in your APIs. A typical example is to use it as the request
1864 # or the response type of an API method. For instance:
1865 #
1866 # service Foo {
1867 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1868 # }
1869 #
1870 # The JSON representation for `Empty` is empty JSON object `{}`.
1871 }</pre>
1872</div>
1873
1874<div class="method">
1875 <code class="details" id="get">get(name, languageCode=None, intentView=None, x__xgafv=None)</code>
1876 <pre>Retrieves the specified intent.
1877
1878Args:
1879 name: string, Required. The name of the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1880Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`. (required)
1881 languageCode: string, Optional. The language used to access language-specific data.
1882If not specified, the agent's default language is used.
1883For more information, see
1884[Multilingual intent and entity
1885data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1886 intentView: string, Optional. The resource view to apply to the returned intent.
1887 x__xgafv: string, V1 error format.
1888 Allowed values
1889 1 - v1 error format
1890 2 - v2 error format
1891
1892Returns:
1893 An object of the form:
1894
1895 { # Represents an intent.
1896 # Intents convert a number of user expressions or patterns into an action. An
1897 # action is an extraction of a user command or sentence semantics.
1898 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
1899 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1900 # Note: If `ml_disabled` setting is set to true, then this intent is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1901 # taken into account during inference in `ML ONLY` match mode. Also,
1902 # auto-markup in the UI is turned off.
1903 "displayName": "A String", # Required. The name of this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1904 "name": "A String", # Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1905 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
1906 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1907 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1908 "parameters": [ # Optional. The collection of parameters associated with the intent.
1909 { # Represents intent parameters.
1910 "displayName": "A String", # Required. The name of the parameter.
1911 "name": "A String", # The unique identifier of this parameter.
1912 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
1913 # result.
1914 # Default values can be extracted from contexts by using the following
1915 # syntax: `#context_name.parameter_name`.
1916 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
1917 # describes values of the parameter. If the parameter is
1918 # required, this must be provided.
1919 "value": "A String", # Optional. The definition of the parameter value. It can be:
1920 # - a constant string,
1921 # - a parameter value defined as `$parameter_name`,
1922 # - an original parameter value defined as `$parameter_name.original`,
1923 # - a parameter value from some context defined as
1924 # `#context_name.parameter_name`.
1925 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1926 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1927 "A String",
1928 ],
1929 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
1930 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
1931 # whether the intent cannot be completed without collecting the parameter
1932 # value.
1933 },
1934 ],
1935 "trainingPhrases": [ # Optional. The collection of examples that the agent is
1936 # trained on.
1937 { # Represents an example that the agent is trained on.
1938 "parts": [ # Required. The ordered list of training phrase parts.
1939 # The parts are concatenated in order to form the training phrase.
1940 #
1941 # Note: The API does not automatically annotate training phrases like the
1942 # Dialogflow Console does.
1943 #
1944 # Note: Do not forget to include whitespace at part boundaries,
1945 # so the training phrase is well formatted when the parts are concatenated.
1946 #
1947 # If the training phrase does not need to be annotated with parameters,
1948 # you just need a single part with only the Part.text field set.
1949 #
1950 # If you want to annotate the training phrase, you must create multiple
1951 # parts, where the fields of each part are populated in one of two ways:
1952 #
1953 # - `Part.text` is set to a part of the phrase that has no parameters.
1954 # - `Part.text` is set to a part of the phrase that you want to annotate,
1955 # and the `entity_type`, `alias`, and `user_defined` fields are all
1956 # set.
1957 { # Represents a part of a training phrase.
1958 "alias": "A String", # Optional. The parameter name for the value extracted from the
1959 # annotated part of the example.
1960 # This field is required for annotated parts of the training phrase.
1961 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
1962 # This field is required for annotated parts of the training phrase.
1963 "text": "A String", # Required. The text for this part.
1964 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
1965 # This field is set to true when the Dialogflow Console is used to
1966 # manually annotate the part. When creating an annotated part with the
1967 # API, you must set this to true.
1968 },
1969 ],
1970 "type": "A String", # Required. The type of the training phrase.
1971 "name": "A String", # Output only. The unique identifier of this training phrase.
1972 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
1973 # the intent. Each time a developer adds an existing sample by editing an
1974 # intent or training, this counter is increased.
1975 },
1976 ],
1977 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
1978 # a direct or indirect parent. We populate this field only in the output.
1979 { # Represents a single followup intent in the chain.
1980 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1981 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1982 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1983 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1984 },
1985 ],
1986 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1987 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
1988 # chain of followup intents. You can set this field when creating an intent,
1989 # for example with CreateIntent or
1990 # BatchUpdateIntents, in order to make this
1991 # intent a followup intent.
1992 #
1993 # It identifies the parent followup intent.
1994 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1995 "messages": [ # Optional. The collection of rich messages corresponding to the
1996 # `Response` field in the Dialogflow console.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1997 { # A rich response message.
1998 # Corresponds to the intent `Response` field in the Dialogflow console.
1999 # For more information, see
2000 # [Rich response
2001 # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2002 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
2003 # This message in `QueryResult.fulfillment_messages` and
2004 # `WebhookResponse.fulfillment_messages` should contain only one
2005 # `SimpleResponse`.
2006 "simpleResponses": [ # Required. The list of simple responses.
2007 { # The simple response message containing speech or text.
2008 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
2009 # speech output. Mutually exclusive with ssml.
2010 "displayText": "A String", # Optional. The text to display.
2011 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
2012 # response to the user in the SSML format. Mutually exclusive with
2013 # text_to_speech.
2014 },
2015 ],
2016 },
2017 "quickReplies": { # The quick replies response message. # The quick replies response.
2018 "quickReplies": [ # Optional. The collection of quick replies.
2019 "A String",
2020 ],
2021 "title": "A String", # Optional. The title of the collection of quick replies.
2022 },
2023 "platform": "A String", # Optional. The platform that this message is intended for.
2024 "text": { # The text response message. # The text response.
2025 "text": [ # Optional. The collection of the agent's responses.
2026 "A String",
2027 ],
2028 },
2029 "image": { # The image response message. # The image response.
2030 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2031 # e.g., screen readers.
2032 "imageUri": "A String", # Optional. The public URI to an image file.
2033 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2034 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
2035 "mediaObjects": [ # Required. List of media objects.
2036 { # Response media object for media content card.
2037 "contentUrl": "A String", # Required. Url where the media is stored.
2038 "description": "A String", # Optional. Description of media card.
2039 "name": "A String", # Required. Name of media card.
2040 "largeImage": { # The image response message. # Optional. Image to display above media content.
2041 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2042 # e.g., screen readers.
2043 "imageUri": "A String", # Optional. The public URI to an image file.
2044 },
2045 "icon": { # The image response message. # Optional. Icon to display above media content.
2046 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2047 # e.g., screen readers.
2048 "imageUri": "A String", # Optional. The public URI to an image file.
2049 },
2050 },
2051 ],
2052 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
2053 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2054 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
2055 "suggestions": [ # Required. The list of suggested replies.
2056 { # The suggestion chip message that the user can tap to quickly post a reply
2057 # to the conversation.
2058 "title": "A String", # Required. The text shown the in the suggestion chip.
2059 },
2060 ],
2061 },
2062 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
2063 # or website associated with this agent.
2064 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
2065 # suggestion chip.
2066 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
2067 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2068 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
2069 # https://developers.google.com/actions/assistant/responses#browsing_carousel
2070 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
2071 # items, maximum of ten.
2072 { # Browsing carousel tile
2073 "image": { # The image response message. # Optional. Hero image for the carousel item.
2074 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2075 # e.g., screen readers.
2076 "imageUri": "A String", # Optional. The public URI to an image file.
2077 },
2078 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
2079 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
2080 # text.
2081 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
2082 "url": "A String", # Required. URL
2083 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
2084 # the URL. Defaults to opening via web browser.
2085 },
2086 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
2087 # Card. Maximum of one line of text.
2088 },
2089 ],
2090 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
2091 # items.
2092 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2093 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
2094 "buttons": [ # Optional. The collection of card buttons.
2095 { # The button object that appears at the bottom of a card.
2096 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2097 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2098 },
2099 "title": "A String", # Required. The title of the button.
2100 },
2101 ],
2102 "subtitle": "A String", # Optional. The subtitle of the card.
2103 "image": { # The image response message. # Optional. The image for the card.
2104 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2105 # e.g., screen readers.
2106 "imageUri": "A String", # Optional. The public URI to an image file.
2107 },
2108 "formattedText": "A String", # Required, unless image is present. The body text of the card.
2109 "title": "A String", # Optional. The title of the card.
2110 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2111 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
2112 "rows": [ # Optional. Rows in this table of data.
2113 { # Row of TableCard.
2114 "cells": [ # Optional. List of cells that make up this row.
2115 { # Cell of TableCardRow.
2116 "text": "A String", # Required. Text in this cell.
2117 },
2118 ],
2119 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
2120 },
2121 ],
2122 "subtitle": "A String", # Optional. Subtitle to the title.
2123 "title": "A String", # Required. Title of the card.
2124 "image": { # The image response message. # Optional. Image which should be displayed on the card.
2125 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2126 # e.g., screen readers.
2127 "imageUri": "A String", # Optional. The public URI to an image file.
2128 },
2129 "columnProperties": [ # Optional. Display properties for the columns in this table.
2130 { # Column properties for TableCard.
2131 "header": "A String", # Required. Column heading.
2132 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
2133 },
2134 ],
2135 "buttons": [ # Optional. List of buttons for the card.
2136 { # The button object that appears at the bottom of a card.
2137 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2138 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2139 },
2140 "title": "A String", # Required. The title of the button.
2141 },
2142 ],
2143 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2144 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
2145 "items": [ # Required. Carousel items.
2146 { # An item in the carousel.
2147 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2148 # dialog.
2149 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2150 # item in dialog.
2151 "A String",
2152 ],
2153 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2154 # response is given.
2155 },
2156 "image": { # The image response message. # Optional. The image to display.
2157 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2158 # e.g., screen readers.
2159 "imageUri": "A String", # Optional. The public URI to an image file.
2160 },
2161 "description": "A String", # Optional. The body text of the card.
2162 "title": "A String", # Required. Title of the carousel item.
2163 },
2164 ],
2165 },
2166 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
2167 "items": [ # Required. List items.
2168 { # An item in the list.
2169 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
2170 # dialog.
2171 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2172 # item in dialog.
2173 "A String",
2174 ],
2175 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2176 # response is given.
2177 },
2178 "image": { # The image response message. # Optional. The image to display.
2179 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2180 # e.g., screen readers.
2181 "imageUri": "A String", # Optional. The public URI to an image file.
2182 },
2183 "description": "A String", # Optional. The main text describing the item.
2184 "title": "A String", # Required. The title of the list item.
2185 },
2186 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2187 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2188 "title": "A String", # Optional. The overall title of the list.
2189 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2190 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2191 "a_key": "", # Properties of the object.
2192 },
2193 "card": { # The card response message. # The card response.
2194 "buttons": [ # Optional. The collection of card buttons.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2195 { # Contains information about a button.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2196 "text": "A String", # Optional. The text to show on the button.
2197 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
2198 # open.
2199 },
2200 ],
2201 "title": "A String", # Optional. The title of the card.
2202 "subtitle": "A String", # Optional. The subtitle of the card.
2203 "imageUri": "A String", # Optional. The public URI to an image file for the card.
2204 },
2205 },
2206 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2207 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
2208 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
2209 "A String",
2210 ],
2211 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2212 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2213 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2214 # - If the supplied value is unspecified or 0, the service
2215 # translates the value to 500,000, which corresponds to the
2216 # `Normal` priority in the console.
2217 # - If the supplied value is negative, the intent is ignored
2218 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2219 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
2220 # followup intents. It identifies the correct followup intents chain for
2221 # this intent. We populate this field only in the output.
2222 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2223 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2224 "action": "A String", # Optional. The name of the action associated with the intent.
2225 # Note: The action name must not contain whitespaces.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2226 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
2227 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2228 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
2229 # is matched. Context messages in this collection should not set the
2230 # parameters field. Setting the `lifespan_count` to 0 will reset the context
2231 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2232 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2233 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2234 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2235 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
2236 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
2237 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2238 #
2239 # The `Context ID` is always converted to lowercase, may only contain
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2240 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
2241 #
2242 # If `Environment ID` is not specified, we assume default 'draft'
2243 # environment. If `User ID` is not specified, we assume default '-' user.
2244 #
2245 # The following context names are reserved for internal use by Dialogflow.
2246 # You should not use these contexts or create contexts with these names:
2247 #
2248 # * `__system_counters__`
2249 # * `*_id_dialog_context`
2250 # * `*_dialog_params_size`
2251 "parameters": { # Optional. The collection of parameters associated with this context.
2252 #
2253 # Depending on your protocol or client library language, this is a
2254 # map, associative array, symbol table, dictionary, or JSON object
2255 # composed of a collection of (MapKey, MapValue) pairs:
2256 #
2257 # - MapKey type: string
2258 # - MapKey value: parameter name
2259 # - MapValue type:
2260 # - If parameter's entity type is a composite entity: map
2261 # - Else: string or number, depending on parameter value type
2262 # - MapValue value:
2263 # - If parameter's entity type is a composite entity:
2264 # map from composite entity property names to property values
2265 # - Else: parameter value
2266 "a_key": "", # Properties of the object.
2267 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2268 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2269 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2270 # immediately. Contexts expire automatically after 20 minutes if there
2271 # are no matching queries.
2272 },
2273 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2274 "inputContextNames": [ # Optional. The list of context names required for this intent to be
2275 # triggered.
2276 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
2277 "A String",
2278 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2279 "events": [ # Optional. The collection of event names that trigger the intent.
2280 # If the collection of input contexts is not empty, all of the contexts must
2281 # 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^]2282 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2283 "A String",
2284 ],
2285 }</pre>
2286</div>
2287
2288<div class="method">
2289 <code class="details" id="list">list(parent, languageCode=None, pageSize=None, intentView=None, pageToken=None, x__xgafv=None)</code>
2290 <pre>Returns the list of all intents in the specified agent.
2291
2292Args:
2293 parent: string, Required. The agent to list all intents from.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2294Format: `projects/&lt;Project ID&gt;/agent`. (required)
2295 languageCode: string, Optional. The language used to access language-specific data.
2296If not specified, the agent's default language is used.
2297For more information, see
2298[Multilingual intent and entity
2299data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2300 pageSize: integer, Optional. The maximum number of items to return in a single page. By
2301default 100 and at most 1000.
2302 intentView: string, Optional. The resource view to apply to the returned intent.
2303 pageToken: string, Optional. The next_page_token value returned from a previous list request.
2304 x__xgafv: string, V1 error format.
2305 Allowed values
2306 1 - v1 error format
2307 2 - v2 error format
2308
2309Returns:
2310 An object of the form:
2311
2312 { # The response message for Intents.ListIntents.
2313 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
2314 # more results in the list.
2315 "intents": [ # The list of agent intents. There will be a maximum number of items
2316 # returned based on the page_size field in the request.
2317 { # Represents an intent.
2318 # Intents convert a number of user expressions or patterns into an action. An
2319 # action is an extraction of a user command or sentence semantics.
2320 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
2321 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2322 # Note: If `ml_disabled` setting is set to true, then this intent is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2323 # taken into account during inference in `ML ONLY` match mode. Also,
2324 # auto-markup in the UI is turned off.
2325 "displayName": "A String", # Required. The name of this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2326 "name": "A String", # Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2327 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2328 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2329 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2330 "parameters": [ # Optional. The collection of parameters associated with the intent.
2331 { # Represents intent parameters.
2332 "displayName": "A String", # Required. The name of the parameter.
2333 "name": "A String", # The unique identifier of this parameter.
2334 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
2335 # result.
2336 # Default values can be extracted from contexts by using the following
2337 # syntax: `#context_name.parameter_name`.
2338 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
2339 # describes values of the parameter. If the parameter is
2340 # required, this must be provided.
2341 "value": "A String", # Optional. The definition of the parameter value. It can be:
2342 # - a constant string,
2343 # - a parameter value defined as `$parameter_name`,
2344 # - an original parameter value defined as `$parameter_name.original`,
2345 # - a parameter value from some context defined as
2346 # `#context_name.parameter_name`.
2347 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2348 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2349 "A String",
2350 ],
2351 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
2352 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
2353 # whether the intent cannot be completed without collecting the parameter
2354 # value.
2355 },
2356 ],
2357 "trainingPhrases": [ # Optional. The collection of examples that the agent is
2358 # trained on.
2359 { # Represents an example that the agent is trained on.
2360 "parts": [ # Required. The ordered list of training phrase parts.
2361 # The parts are concatenated in order to form the training phrase.
2362 #
2363 # Note: The API does not automatically annotate training phrases like the
2364 # Dialogflow Console does.
2365 #
2366 # Note: Do not forget to include whitespace at part boundaries,
2367 # so the training phrase is well formatted when the parts are concatenated.
2368 #
2369 # If the training phrase does not need to be annotated with parameters,
2370 # you just need a single part with only the Part.text field set.
2371 #
2372 # If you want to annotate the training phrase, you must create multiple
2373 # parts, where the fields of each part are populated in one of two ways:
2374 #
2375 # - `Part.text` is set to a part of the phrase that has no parameters.
2376 # - `Part.text` is set to a part of the phrase that you want to annotate,
2377 # and the `entity_type`, `alias`, and `user_defined` fields are all
2378 # set.
2379 { # Represents a part of a training phrase.
2380 "alias": "A String", # Optional. The parameter name for the value extracted from the
2381 # annotated part of the example.
2382 # This field is required for annotated parts of the training phrase.
2383 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
2384 # This field is required for annotated parts of the training phrase.
2385 "text": "A String", # Required. The text for this part.
2386 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
2387 # This field is set to true when the Dialogflow Console is used to
2388 # manually annotate the part. When creating an annotated part with the
2389 # API, you must set this to true.
2390 },
2391 ],
2392 "type": "A String", # Required. The type of the training phrase.
2393 "name": "A String", # Output only. The unique identifier of this training phrase.
2394 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
2395 # the intent. Each time a developer adds an existing sample by editing an
2396 # intent or training, this counter is increased.
2397 },
2398 ],
2399 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
2400 # a direct or indirect parent. We populate this field only in the output.
2401 { # Represents a single followup intent in the chain.
2402 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2403 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2404 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2405 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2406 },
2407 ],
2408 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2409 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
2410 # chain of followup intents. You can set this field when creating an intent,
2411 # for example with CreateIntent or
2412 # BatchUpdateIntents, in order to make this
2413 # intent a followup intent.
2414 #
2415 # It identifies the parent followup intent.
2416 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2417 "messages": [ # Optional. The collection of rich messages corresponding to the
2418 # `Response` field in the Dialogflow console.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2419 { # A rich response message.
2420 # Corresponds to the intent `Response` field in the Dialogflow console.
2421 # For more information, see
2422 # [Rich response
2423 # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2424 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
2425 # This message in `QueryResult.fulfillment_messages` and
2426 # `WebhookResponse.fulfillment_messages` should contain only one
2427 # `SimpleResponse`.
2428 "simpleResponses": [ # Required. The list of simple responses.
2429 { # The simple response message containing speech or text.
2430 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
2431 # speech output. Mutually exclusive with ssml.
2432 "displayText": "A String", # Optional. The text to display.
2433 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
2434 # response to the user in the SSML format. Mutually exclusive with
2435 # text_to_speech.
2436 },
2437 ],
2438 },
2439 "quickReplies": { # The quick replies response message. # The quick replies response.
2440 "quickReplies": [ # Optional. The collection of quick replies.
2441 "A String",
2442 ],
2443 "title": "A String", # Optional. The title of the collection of quick replies.
2444 },
2445 "platform": "A String", # Optional. The platform that this message is intended for.
2446 "text": { # The text response message. # The text response.
2447 "text": [ # Optional. The collection of the agent's responses.
2448 "A String",
2449 ],
2450 },
2451 "image": { # The image response message. # The image response.
2452 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2453 # e.g., screen readers.
2454 "imageUri": "A String", # Optional. The public URI to an image file.
2455 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2456 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
2457 "mediaObjects": [ # Required. List of media objects.
2458 { # Response media object for media content card.
2459 "contentUrl": "A String", # Required. Url where the media is stored.
2460 "description": "A String", # Optional. Description of media card.
2461 "name": "A String", # Required. Name of media card.
2462 "largeImage": { # The image response message. # Optional. Image to display above media content.
2463 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2464 # e.g., screen readers.
2465 "imageUri": "A String", # Optional. The public URI to an image file.
2466 },
2467 "icon": { # The image response message. # Optional. Icon to display above media content.
2468 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2469 # e.g., screen readers.
2470 "imageUri": "A String", # Optional. The public URI to an image file.
2471 },
2472 },
2473 ],
2474 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
2475 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2476 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
2477 "suggestions": [ # Required. The list of suggested replies.
2478 { # The suggestion chip message that the user can tap to quickly post a reply
2479 # to the conversation.
2480 "title": "A String", # Required. The text shown the in the suggestion chip.
2481 },
2482 ],
2483 },
2484 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
2485 # or website associated with this agent.
2486 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
2487 # suggestion chip.
2488 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
2489 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2490 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
2491 # https://developers.google.com/actions/assistant/responses#browsing_carousel
2492 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
2493 # items, maximum of ten.
2494 { # Browsing carousel tile
2495 "image": { # The image response message. # Optional. Hero image for the carousel item.
2496 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2497 # e.g., screen readers.
2498 "imageUri": "A String", # Optional. The public URI to an image file.
2499 },
2500 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
2501 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
2502 # text.
2503 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
2504 "url": "A String", # Required. URL
2505 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
2506 # the URL. Defaults to opening via web browser.
2507 },
2508 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
2509 # Card. Maximum of one line of text.
2510 },
2511 ],
2512 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
2513 # items.
2514 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2515 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
2516 "buttons": [ # Optional. The collection of card buttons.
2517 { # The button object that appears at the bottom of a card.
2518 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2519 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2520 },
2521 "title": "A String", # Required. The title of the button.
2522 },
2523 ],
2524 "subtitle": "A String", # Optional. The subtitle of the card.
2525 "image": { # The image response message. # Optional. The image for the card.
2526 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2527 # e.g., screen readers.
2528 "imageUri": "A String", # Optional. The public URI to an image file.
2529 },
2530 "formattedText": "A String", # Required, unless image is present. The body text of the card.
2531 "title": "A String", # Optional. The title of the card.
2532 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2533 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
2534 "rows": [ # Optional. Rows in this table of data.
2535 { # Row of TableCard.
2536 "cells": [ # Optional. List of cells that make up this row.
2537 { # Cell of TableCardRow.
2538 "text": "A String", # Required. Text in this cell.
2539 },
2540 ],
2541 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
2542 },
2543 ],
2544 "subtitle": "A String", # Optional. Subtitle to the title.
2545 "title": "A String", # Required. Title of the card.
2546 "image": { # The image response message. # Optional. Image which should be displayed on the card.
2547 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2548 # e.g., screen readers.
2549 "imageUri": "A String", # Optional. The public URI to an image file.
2550 },
2551 "columnProperties": [ # Optional. Display properties for the columns in this table.
2552 { # Column properties for TableCard.
2553 "header": "A String", # Required. Column heading.
2554 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
2555 },
2556 ],
2557 "buttons": [ # Optional. List of buttons for the card.
2558 { # The button object that appears at the bottom of a card.
2559 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2560 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2561 },
2562 "title": "A String", # Required. The title of the button.
2563 },
2564 ],
2565 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2566 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
2567 "items": [ # Required. Carousel items.
2568 { # An item in the carousel.
2569 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2570 # dialog.
2571 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2572 # item in dialog.
2573 "A String",
2574 ],
2575 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2576 # response is given.
2577 },
2578 "image": { # The image response message. # Optional. The image to display.
2579 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2580 # e.g., screen readers.
2581 "imageUri": "A String", # Optional. The public URI to an image file.
2582 },
2583 "description": "A String", # Optional. The body text of the card.
2584 "title": "A String", # Required. Title of the carousel item.
2585 },
2586 ],
2587 },
2588 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
2589 "items": [ # Required. List items.
2590 { # An item in the list.
2591 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
2592 # dialog.
2593 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2594 # item in dialog.
2595 "A String",
2596 ],
2597 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2598 # response is given.
2599 },
2600 "image": { # The image response message. # Optional. The image to display.
2601 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2602 # e.g., screen readers.
2603 "imageUri": "A String", # Optional. The public URI to an image file.
2604 },
2605 "description": "A String", # Optional. The main text describing the item.
2606 "title": "A String", # Required. The title of the list item.
2607 },
2608 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2609 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2610 "title": "A String", # Optional. The overall title of the list.
2611 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2612 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2613 "a_key": "", # Properties of the object.
2614 },
2615 "card": { # The card response message. # The card response.
2616 "buttons": [ # Optional. The collection of card buttons.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2617 { # Contains information about a button.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2618 "text": "A String", # Optional. The text to show on the button.
2619 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
2620 # open.
2621 },
2622 ],
2623 "title": "A String", # Optional. The title of the card.
2624 "subtitle": "A String", # Optional. The subtitle of the card.
2625 "imageUri": "A String", # Optional. The public URI to an image file for the card.
2626 },
2627 },
2628 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2629 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
2630 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
2631 "A String",
2632 ],
2633 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2634 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2635 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2636 # - If the supplied value is unspecified or 0, the service
2637 # translates the value to 500,000, which corresponds to the
2638 # `Normal` priority in the console.
2639 # - If the supplied value is negative, the intent is ignored
2640 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2641 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
2642 # followup intents. It identifies the correct followup intents chain for
2643 # this intent. We populate this field only in the output.
2644 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2645 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2646 "action": "A String", # Optional. The name of the action associated with the intent.
2647 # Note: The action name must not contain whitespaces.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2648 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
2649 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2650 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
2651 # is matched. Context messages in this collection should not set the
2652 # parameters field. Setting the `lifespan_count` to 0 will reset the context
2653 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2654 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2655 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2656 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2657 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
2658 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
2659 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2660 #
2661 # The `Context ID` is always converted to lowercase, may only contain
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2662 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
2663 #
2664 # If `Environment ID` is not specified, we assume default 'draft'
2665 # environment. If `User ID` is not specified, we assume default '-' user.
2666 #
2667 # The following context names are reserved for internal use by Dialogflow.
2668 # You should not use these contexts or create contexts with these names:
2669 #
2670 # * `__system_counters__`
2671 # * `*_id_dialog_context`
2672 # * `*_dialog_params_size`
2673 "parameters": { # Optional. The collection of parameters associated with this context.
2674 #
2675 # Depending on your protocol or client library language, this is a
2676 # map, associative array, symbol table, dictionary, or JSON object
2677 # composed of a collection of (MapKey, MapValue) pairs:
2678 #
2679 # - MapKey type: string
2680 # - MapKey value: parameter name
2681 # - MapValue type:
2682 # - If parameter's entity type is a composite entity: map
2683 # - Else: string or number, depending on parameter value type
2684 # - MapValue value:
2685 # - If parameter's entity type is a composite entity:
2686 # map from composite entity property names to property values
2687 # - Else: parameter value
2688 "a_key": "", # Properties of the object.
2689 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2690 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2691 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2692 # immediately. Contexts expire automatically after 20 minutes if there
2693 # are no matching queries.
2694 },
2695 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2696 "inputContextNames": [ # Optional. The list of context names required for this intent to be
2697 # triggered.
2698 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
2699 "A String",
2700 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2701 "events": [ # Optional. The collection of event names that trigger the intent.
2702 # If the collection of input contexts is not empty, all of the contexts must
2703 # 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^]2704 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2705 "A String",
2706 ],
2707 },
2708 ],
2709 }</pre>
2710</div>
2711
2712<div class="method">
2713 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2714 <pre>Retrieves the next page of results.
2715
2716Args:
2717 previous_request: The request for the previous page. (required)
2718 previous_response: The response from the request for the previous page. (required)
2719
2720Returns:
2721 A request object that you can call 'execute()' on to request the next
2722 page. Returns None if there are no more items in the collection.
2723 </pre>
2724</div>
2725
2726<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2727 <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]2728 <pre>Updates the specified intent.
2729
2730Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2731 name: string, Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2732Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2733methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2734Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`. (required)
2735 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2736 The object takes the form of:
2737
2738{ # Represents an intent.
2739 # Intents convert a number of user expressions or patterns into an action. An
2740 # action is an extraction of a user command or sentence semantics.
2741 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
2742 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2743 # Note: If `ml_disabled` setting is set to true, then this intent is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2744 # taken into account during inference in `ML ONLY` match mode. Also,
2745 # auto-markup in the UI is turned off.
2746 "displayName": "A String", # Required. The name of this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2747 "name": "A String", # Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2748 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
2749 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2750 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2751 "parameters": [ # Optional. The collection of parameters associated with the intent.
2752 { # Represents intent parameters.
2753 "displayName": "A String", # Required. The name of the parameter.
2754 "name": "A String", # The unique identifier of this parameter.
2755 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
2756 # result.
2757 # Default values can be extracted from contexts by using the following
2758 # syntax: `#context_name.parameter_name`.
2759 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
2760 # describes values of the parameter. If the parameter is
2761 # required, this must be provided.
2762 "value": "A String", # Optional. The definition of the parameter value. It can be:
2763 # - a constant string,
2764 # - a parameter value defined as `$parameter_name`,
2765 # - an original parameter value defined as `$parameter_name.original`,
2766 # - a parameter value from some context defined as
2767 # `#context_name.parameter_name`.
2768 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2769 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2770 "A String",
2771 ],
2772 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
2773 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
2774 # whether the intent cannot be completed without collecting the parameter
2775 # value.
2776 },
2777 ],
2778 "trainingPhrases": [ # Optional. The collection of examples that the agent is
2779 # trained on.
2780 { # Represents an example that the agent is trained on.
2781 "parts": [ # Required. The ordered list of training phrase parts.
2782 # The parts are concatenated in order to form the training phrase.
2783 #
2784 # Note: The API does not automatically annotate training phrases like the
2785 # Dialogflow Console does.
2786 #
2787 # Note: Do not forget to include whitespace at part boundaries,
2788 # so the training phrase is well formatted when the parts are concatenated.
2789 #
2790 # If the training phrase does not need to be annotated with parameters,
2791 # you just need a single part with only the Part.text field set.
2792 #
2793 # If you want to annotate the training phrase, you must create multiple
2794 # parts, where the fields of each part are populated in one of two ways:
2795 #
2796 # - `Part.text` is set to a part of the phrase that has no parameters.
2797 # - `Part.text` is set to a part of the phrase that you want to annotate,
2798 # and the `entity_type`, `alias`, and `user_defined` fields are all
2799 # set.
2800 { # Represents a part of a training phrase.
2801 "alias": "A String", # Optional. The parameter name for the value extracted from the
2802 # annotated part of the example.
2803 # This field is required for annotated parts of the training phrase.
2804 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
2805 # This field is required for annotated parts of the training phrase.
2806 "text": "A String", # Required. The text for this part.
2807 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
2808 # This field is set to true when the Dialogflow Console is used to
2809 # manually annotate the part. When creating an annotated part with the
2810 # API, you must set this to true.
2811 },
2812 ],
2813 "type": "A String", # Required. The type of the training phrase.
2814 "name": "A String", # Output only. The unique identifier of this training phrase.
2815 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
2816 # the intent. Each time a developer adds an existing sample by editing an
2817 # intent or training, this counter is increased.
2818 },
2819 ],
2820 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
2821 # a direct or indirect parent. We populate this field only in the output.
2822 { # Represents a single followup intent in the chain.
2823 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2824 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2825 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2826 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2827 },
2828 ],
2829 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2830 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
2831 # chain of followup intents. You can set this field when creating an intent,
2832 # for example with CreateIntent or
2833 # BatchUpdateIntents, in order to make this
2834 # intent a followup intent.
2835 #
2836 # It identifies the parent followup intent.
2837 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2838 "messages": [ # Optional. The collection of rich messages corresponding to the
2839 # `Response` field in the Dialogflow console.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2840 { # A rich response message.
2841 # Corresponds to the intent `Response` field in the Dialogflow console.
2842 # For more information, see
2843 # [Rich response
2844 # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2845 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
2846 # This message in `QueryResult.fulfillment_messages` and
2847 # `WebhookResponse.fulfillment_messages` should contain only one
2848 # `SimpleResponse`.
2849 "simpleResponses": [ # Required. The list of simple responses.
2850 { # The simple response message containing speech or text.
2851 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
2852 # speech output. Mutually exclusive with ssml.
2853 "displayText": "A String", # Optional. The text to display.
2854 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
2855 # response to the user in the SSML format. Mutually exclusive with
2856 # text_to_speech.
2857 },
2858 ],
2859 },
2860 "quickReplies": { # The quick replies response message. # The quick replies response.
2861 "quickReplies": [ # Optional. The collection of quick replies.
2862 "A String",
2863 ],
2864 "title": "A String", # Optional. The title of the collection of quick replies.
2865 },
2866 "platform": "A String", # Optional. The platform that this message is intended for.
2867 "text": { # The text response message. # The text response.
2868 "text": [ # Optional. The collection of the agent's responses.
2869 "A String",
2870 ],
2871 },
2872 "image": { # The image response message. # The image response.
2873 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2874 # e.g., screen readers.
2875 "imageUri": "A String", # Optional. The public URI to an image file.
2876 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2877 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
2878 "mediaObjects": [ # Required. List of media objects.
2879 { # Response media object for media content card.
2880 "contentUrl": "A String", # Required. Url where the media is stored.
2881 "description": "A String", # Optional. Description of media card.
2882 "name": "A String", # Required. Name of media card.
2883 "largeImage": { # The image response message. # Optional. Image to display above media content.
2884 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2885 # e.g., screen readers.
2886 "imageUri": "A String", # Optional. The public URI to an image file.
2887 },
2888 "icon": { # The image response message. # Optional. Icon to display above media content.
2889 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2890 # e.g., screen readers.
2891 "imageUri": "A String", # Optional. The public URI to an image file.
2892 },
2893 },
2894 ],
2895 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
2896 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2897 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
2898 "suggestions": [ # Required. The list of suggested replies.
2899 { # The suggestion chip message that the user can tap to quickly post a reply
2900 # to the conversation.
2901 "title": "A String", # Required. The text shown the in the suggestion chip.
2902 },
2903 ],
2904 },
2905 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
2906 # or website associated with this agent.
2907 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
2908 # suggestion chip.
2909 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
2910 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2911 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
2912 # https://developers.google.com/actions/assistant/responses#browsing_carousel
2913 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
2914 # items, maximum of ten.
2915 { # Browsing carousel tile
2916 "image": { # The image response message. # Optional. Hero image for the carousel item.
2917 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2918 # e.g., screen readers.
2919 "imageUri": "A String", # Optional. The public URI to an image file.
2920 },
2921 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
2922 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
2923 # text.
2924 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
2925 "url": "A String", # Required. URL
2926 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
2927 # the URL. Defaults to opening via web browser.
2928 },
2929 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
2930 # Card. Maximum of one line of text.
2931 },
2932 ],
2933 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
2934 # items.
2935 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2936 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
2937 "buttons": [ # Optional. The collection of card buttons.
2938 { # The button object that appears at the bottom of a card.
2939 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2940 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2941 },
2942 "title": "A String", # Required. The title of the button.
2943 },
2944 ],
2945 "subtitle": "A String", # Optional. The subtitle of the card.
2946 "image": { # The image response message. # Optional. The image for the card.
2947 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2948 # e.g., screen readers.
2949 "imageUri": "A String", # Optional. The public URI to an image file.
2950 },
2951 "formattedText": "A String", # Required, unless image is present. The body text of the card.
2952 "title": "A String", # Optional. The title of the card.
2953 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2954 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
2955 "rows": [ # Optional. Rows in this table of data.
2956 { # Row of TableCard.
2957 "cells": [ # Optional. List of cells that make up this row.
2958 { # Cell of TableCardRow.
2959 "text": "A String", # Required. Text in this cell.
2960 },
2961 ],
2962 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
2963 },
2964 ],
2965 "subtitle": "A String", # Optional. Subtitle to the title.
2966 "title": "A String", # Required. Title of the card.
2967 "image": { # The image response message. # Optional. Image which should be displayed on the card.
2968 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
2969 # e.g., screen readers.
2970 "imageUri": "A String", # Optional. The public URI to an image file.
2971 },
2972 "columnProperties": [ # Optional. Display properties for the columns in this table.
2973 { # Column properties for TableCard.
2974 "header": "A String", # Required. Column heading.
2975 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
2976 },
2977 ],
2978 "buttons": [ # Optional. List of buttons for the card.
2979 { # The button object that appears at the bottom of a card.
2980 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
2981 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
2982 },
2983 "title": "A String", # Required. The title of the button.
2984 },
2985 ],
2986 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2987 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
2988 "items": [ # Required. Carousel items.
2989 { # An item in the carousel.
2990 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
2991 # dialog.
2992 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
2993 # item in dialog.
2994 "A String",
2995 ],
2996 "key": "A String", # Required. A unique key that will be sent back to the agent if this
2997 # response is given.
2998 },
2999 "image": { # The image response message. # Optional. The image to display.
3000 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3001 # e.g., screen readers.
3002 "imageUri": "A String", # Optional. The public URI to an image file.
3003 },
3004 "description": "A String", # Optional. The body text of the card.
3005 "title": "A String", # Required. Title of the carousel item.
3006 },
3007 ],
3008 },
3009 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
3010 "items": [ # Required. List items.
3011 { # An item in the list.
3012 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
3013 # dialog.
3014 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
3015 # item in dialog.
3016 "A String",
3017 ],
3018 "key": "A String", # Required. A unique key that will be sent back to the agent if this
3019 # response is given.
3020 },
3021 "image": { # The image response message. # Optional. The image to display.
3022 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3023 # e.g., screen readers.
3024 "imageUri": "A String", # Optional. The public URI to an image file.
3025 },
3026 "description": "A String", # Optional. The main text describing the item.
3027 "title": "A String", # Required. The title of the list item.
3028 },
3029 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3030 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3031 "title": "A String", # Optional. The overall title of the list.
3032 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3033 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3034 "a_key": "", # Properties of the object.
3035 },
3036 "card": { # The card response message. # The card response.
3037 "buttons": [ # Optional. The collection of card buttons.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3038 { # Contains information about a button.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3039 "text": "A String", # Optional. The text to show on the button.
3040 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
3041 # open.
3042 },
3043 ],
3044 "title": "A String", # Optional. The title of the card.
3045 "subtitle": "A String", # Optional. The subtitle of the card.
3046 "imageUri": "A String", # Optional. The public URI to an image file for the card.
3047 },
3048 },
3049 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3050 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
3051 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
3052 "A String",
3053 ],
3054 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3055 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3056 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3057 # - If the supplied value is unspecified or 0, the service
3058 # translates the value to 500,000, which corresponds to the
3059 # `Normal` priority in the console.
3060 # - If the supplied value is negative, the intent is ignored
3061 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3062 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
3063 # followup intents. It identifies the correct followup intents chain for
3064 # this intent. We populate this field only in the output.
3065 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3066 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3067 "action": "A String", # Optional. The name of the action associated with the intent.
3068 # Note: The action name must not contain whitespaces.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3069 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
3070 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3071 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
3072 # is matched. Context messages in this collection should not set the
3073 # parameters field. Setting the `lifespan_count` to 0 will reset the context
3074 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3075 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3076 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3077 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3078 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
3079 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
3080 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3081 #
3082 # The `Context ID` is always converted to lowercase, may only contain
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3083 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
3084 #
3085 # If `Environment ID` is not specified, we assume default 'draft'
3086 # environment. If `User ID` is not specified, we assume default '-' user.
3087 #
3088 # The following context names are reserved for internal use by Dialogflow.
3089 # You should not use these contexts or create contexts with these names:
3090 #
3091 # * `__system_counters__`
3092 # * `*_id_dialog_context`
3093 # * `*_dialog_params_size`
3094 "parameters": { # Optional. The collection of parameters associated with this context.
3095 #
3096 # Depending on your protocol or client library language, this is a
3097 # map, associative array, symbol table, dictionary, or JSON object
3098 # composed of a collection of (MapKey, MapValue) pairs:
3099 #
3100 # - MapKey type: string
3101 # - MapKey value: parameter name
3102 # - MapValue type:
3103 # - If parameter's entity type is a composite entity: map
3104 # - Else: string or number, depending on parameter value type
3105 # - MapValue value:
3106 # - If parameter's entity type is a composite entity:
3107 # map from composite entity property names to property values
3108 # - Else: parameter value
3109 "a_key": "", # Properties of the object.
3110 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3111 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3112 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3113 # immediately. Contexts expire automatically after 20 minutes if there
3114 # are no matching queries.
3115 },
3116 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3117 "inputContextNames": [ # Optional. The list of context names required for this intent to be
3118 # triggered.
3119 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
3120 "A String",
3121 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3122 "events": [ # Optional. The collection of event names that trigger the intent.
3123 # If the collection of input contexts is not empty, all of the contexts must
3124 # 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^]3125 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3126 "A String",
3127 ],
3128}
3129
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3130 languageCode: string, Optional. The language used to access language-specific data.
3131If not specified, the agent's default language is used.
3132For more information, see
3133[Multilingual intent and entity
3134data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3135 intentView: string, Optional. The resource view to apply to the returned intent.
3136 updateMask: string, Optional. The mask to control which fields get updated.
3137 x__xgafv: string, V1 error format.
3138 Allowed values
3139 1 - v1 error format
3140 2 - v2 error format
3141
3142Returns:
3143 An object of the form:
3144
3145 { # Represents an intent.
3146 # Intents convert a number of user expressions or patterns into an action. An
3147 # action is an extraction of a user command or sentence semantics.
3148 "isFallback": True or False, # Optional. Indicates whether this is a fallback intent.
3149 "mlDisabled": True or False, # Optional. Indicates whether Machine Learning is disabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3150 # Note: If `ml_disabled` setting is set to true, then this intent is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3151 # taken into account during inference in `ML ONLY` match mode. Also,
3152 # auto-markup in the UI is turned off.
3153 "displayName": "A String", # Required. The name of this intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3154 "name": "A String", # Optional. The unique identifier of this intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3155 # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents
3156 # methods.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3157 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3158 "parameters": [ # Optional. The collection of parameters associated with the intent.
3159 { # Represents intent parameters.
3160 "displayName": "A String", # Required. The name of the parameter.
3161 "name": "A String", # The unique identifier of this parameter.
3162 "defaultValue": "A String", # Optional. The default value to use when the `value` yields an empty
3163 # result.
3164 # Default values can be extracted from contexts by using the following
3165 # syntax: `#context_name.parameter_name`.
3166 "entityTypeDisplayName": "A String", # Optional. The name of the entity type, prefixed with `@`, that
3167 # describes values of the parameter. If the parameter is
3168 # required, this must be provided.
3169 "value": "A String", # Optional. The definition of the parameter value. It can be:
3170 # - a constant string,
3171 # - a parameter value defined as `$parameter_name`,
3172 # - an original parameter value defined as `$parameter_name.original`,
3173 # - a parameter value from some context defined as
3174 # `#context_name.parameter_name`.
3175 "prompts": [ # Optional. The collection of prompts that the agent can present to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3176 # user in order to collect a value for the parameter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3177 "A String",
3178 ],
3179 "isList": True or False, # Optional. Indicates whether the parameter represents a list of values.
3180 "mandatory": True or False, # Optional. Indicates whether the parameter is required. That is,
3181 # whether the intent cannot be completed without collecting the parameter
3182 # value.
3183 },
3184 ],
3185 "trainingPhrases": [ # Optional. The collection of examples that the agent is
3186 # trained on.
3187 { # Represents an example that the agent is trained on.
3188 "parts": [ # Required. The ordered list of training phrase parts.
3189 # The parts are concatenated in order to form the training phrase.
3190 #
3191 # Note: The API does not automatically annotate training phrases like the
3192 # Dialogflow Console does.
3193 #
3194 # Note: Do not forget to include whitespace at part boundaries,
3195 # so the training phrase is well formatted when the parts are concatenated.
3196 #
3197 # If the training phrase does not need to be annotated with parameters,
3198 # you just need a single part with only the Part.text field set.
3199 #
3200 # If you want to annotate the training phrase, you must create multiple
3201 # parts, where the fields of each part are populated in one of two ways:
3202 #
3203 # - `Part.text` is set to a part of the phrase that has no parameters.
3204 # - `Part.text` is set to a part of the phrase that you want to annotate,
3205 # and the `entity_type`, `alias`, and `user_defined` fields are all
3206 # set.
3207 { # Represents a part of a training phrase.
3208 "alias": "A String", # Optional. The parameter name for the value extracted from the
3209 # annotated part of the example.
3210 # This field is required for annotated parts of the training phrase.
3211 "entityType": "A String", # Optional. The entity type name prefixed with `@`.
3212 # This field is required for annotated parts of the training phrase.
3213 "text": "A String", # Required. The text for this part.
3214 "userDefined": True or False, # Optional. Indicates whether the text was manually annotated.
3215 # This field is set to true when the Dialogflow Console is used to
3216 # manually annotate the part. When creating an annotated part with the
3217 # API, you must set this to true.
3218 },
3219 ],
3220 "type": "A String", # Required. The type of the training phrase.
3221 "name": "A String", # Output only. The unique identifier of this training phrase.
3222 "timesAddedCount": 42, # Optional. Indicates how many times this example was added to
3223 # the intent. Each time a developer adds an existing sample by editing an
3224 # intent or training, this counter is increased.
3225 },
3226 ],
3227 "followupIntentInfo": [ # Read-only. Information about all followup intents that have this intent as
3228 # a direct or indirect parent. We populate this field only in the output.
3229 { # Represents a single followup intent in the chain.
3230 "followupIntentName": "A String", # The unique identifier of the followup intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3231 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3232 "parentFollowupIntentName": "A String", # The unique identifier of the followup intent's parent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3233 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3234 },
3235 ],
3236 "webhookState": "A String", # Optional. Indicates whether webhooks are enabled for the intent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3237 "parentFollowupIntentName": "A String", # Read-only after creation. The unique identifier of the parent intent in the
3238 # chain of followup intents. You can set this field when creating an intent,
3239 # for example with CreateIntent or
3240 # BatchUpdateIntents, in order to make this
3241 # intent a followup intent.
3242 #
3243 # It identifies the parent followup intent.
3244 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3245 "messages": [ # Optional. The collection of rich messages corresponding to the
3246 # `Response` field in the Dialogflow console.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3247 { # A rich response message.
3248 # Corresponds to the intent `Response` field in the Dialogflow console.
3249 # For more information, see
3250 # [Rich response
3251 # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3252 "simpleResponses": { # The collection of simple response candidates. # The voice and text-only responses for Actions on Google.
3253 # This message in `QueryResult.fulfillment_messages` and
3254 # `WebhookResponse.fulfillment_messages` should contain only one
3255 # `SimpleResponse`.
3256 "simpleResponses": [ # Required. The list of simple responses.
3257 { # The simple response message containing speech or text.
3258 "textToSpeech": "A String", # One of text_to_speech or ssml must be provided. The plain text of the
3259 # speech output. Mutually exclusive with ssml.
3260 "displayText": "A String", # Optional. The text to display.
3261 "ssml": "A String", # One of text_to_speech or ssml must be provided. Structured spoken
3262 # response to the user in the SSML format. Mutually exclusive with
3263 # text_to_speech.
3264 },
3265 ],
3266 },
3267 "quickReplies": { # The quick replies response message. # The quick replies response.
3268 "quickReplies": [ # Optional. The collection of quick replies.
3269 "A String",
3270 ],
3271 "title": "A String", # Optional. The title of the collection of quick replies.
3272 },
3273 "platform": "A String", # Optional. The platform that this message is intended for.
3274 "text": { # The text response message. # The text response.
3275 "text": [ # Optional. The collection of the agent's responses.
3276 "A String",
3277 ],
3278 },
3279 "image": { # The image response message. # The image response.
3280 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3281 # e.g., screen readers.
3282 "imageUri": "A String", # Optional. The public URI to an image file.
3283 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3284 "mediaContent": { # The media content card for Actions on Google. # The media content card for Actions on Google.
3285 "mediaObjects": [ # Required. List of media objects.
3286 { # Response media object for media content card.
3287 "contentUrl": "A String", # Required. Url where the media is stored.
3288 "description": "A String", # Optional. Description of media card.
3289 "name": "A String", # Required. Name of media card.
3290 "largeImage": { # The image response message. # Optional. Image to display above media content.
3291 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3292 # e.g., screen readers.
3293 "imageUri": "A String", # Optional. The public URI to an image file.
3294 },
3295 "icon": { # The image response message. # Optional. Icon to display above media content.
3296 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3297 # e.g., screen readers.
3298 "imageUri": "A String", # Optional. The public URI to an image file.
3299 },
3300 },
3301 ],
3302 "mediaType": "A String", # Optional. What type of media is the content (ie "audio").
3303 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3304 "suggestions": { # The collection of suggestions. # The suggestion chips for Actions on Google.
3305 "suggestions": [ # Required. The list of suggested replies.
3306 { # The suggestion chip message that the user can tap to quickly post a reply
3307 # to the conversation.
3308 "title": "A String", # Required. The text shown the in the suggestion chip.
3309 },
3310 ],
3311 },
3312 "linkOutSuggestion": { # The suggestion chip message that allows the user to jump out to the app # The link out suggestion chip for Actions on Google.
3313 # or website associated with this agent.
3314 "uri": "A String", # Required. The URI of the app or site to open when the user taps the
3315 # suggestion chip.
3316 "destinationName": "A String", # Required. The name of the app or site this chip is linking to.
3317 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3318 "browseCarouselCard": { # Browse Carousel Card for Actions on Google. # Browse carousel card for Actions on Google.
3319 # https://developers.google.com/actions/assistant/responses#browsing_carousel
3320 "items": [ # Required. List of items in the Browse Carousel Card. Minimum of two
3321 # items, maximum of ten.
3322 { # Browsing carousel tile
3323 "image": { # The image response message. # Optional. Hero image for the carousel item.
3324 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3325 # e.g., screen readers.
3326 "imageUri": "A String", # Optional. The public URI to an image file.
3327 },
3328 "title": "A String", # Required. Title of the carousel item. Maximum of two lines of text.
3329 "description": "A String", # Optional. Description of the carousel item. Maximum of four lines of
3330 # text.
3331 "openUriAction": { # Actions on Google action to open a given url. # Required. Action to present to the user.
3332 "url": "A String", # Required. URL
3333 "urlTypeHint": "A String", # Optional. Specifies the type of viewer that is used when opening
3334 # the URL. Defaults to opening via web browser.
3335 },
3336 "footer": "A String", # Optional. Text that appears at the bottom of the Browse Carousel
3337 # Card. Maximum of one line of text.
3338 },
3339 ],
3340 "imageDisplayOptions": "A String", # Optional. Settings for displaying the image. Applies to every image in
3341 # items.
3342 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3343 "basicCard": { # The basic card message. Useful for displaying information. # The basic card response for Actions on Google.
3344 "buttons": [ # Optional. The collection of card buttons.
3345 { # The button object that appears at the bottom of a card.
3346 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
3347 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
3348 },
3349 "title": "A String", # Required. The title of the button.
3350 },
3351 ],
3352 "subtitle": "A String", # Optional. The subtitle of the card.
3353 "image": { # The image response message. # Optional. The image for the card.
3354 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3355 # e.g., screen readers.
3356 "imageUri": "A String", # Optional. The public URI to an image file.
3357 },
3358 "formattedText": "A String", # Required, unless image is present. The body text of the card.
3359 "title": "A String", # Optional. The title of the card.
3360 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3361 "tableCard": { # Table card for Actions on Google. # Table card for Actions on Google.
3362 "rows": [ # Optional. Rows in this table of data.
3363 { # Row of TableCard.
3364 "cells": [ # Optional. List of cells that make up this row.
3365 { # Cell of TableCardRow.
3366 "text": "A String", # Required. Text in this cell.
3367 },
3368 ],
3369 "dividerAfter": True or False, # Optional. Whether to add a visual divider after this row.
3370 },
3371 ],
3372 "subtitle": "A String", # Optional. Subtitle to the title.
3373 "title": "A String", # Required. Title of the card.
3374 "image": { # The image response message. # Optional. Image which should be displayed on the card.
3375 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3376 # e.g., screen readers.
3377 "imageUri": "A String", # Optional. The public URI to an image file.
3378 },
3379 "columnProperties": [ # Optional. Display properties for the columns in this table.
3380 { # Column properties for TableCard.
3381 "header": "A String", # Required. Column heading.
3382 "horizontalAlignment": "A String", # Optional. Defines text alignment for all cells in this column.
3383 },
3384 ],
3385 "buttons": [ # Optional. List of buttons for the card.
3386 { # The button object that appears at the bottom of a card.
3387 "openUriAction": { # Opens the given URI. # Required. Action to take when a user taps on the button.
3388 "uri": "A String", # Required. The HTTP or HTTPS scheme URI.
3389 },
3390 "title": "A String", # Required. The title of the button.
3391 },
3392 ],
3393 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3394 "carouselSelect": { # The card for presenting a carousel of options to select from. # The carousel card response for Actions on Google.
3395 "items": [ # Required. Carousel items.
3396 { # An item in the carousel.
3397 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional info about the option item.
3398 # dialog.
3399 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
3400 # item in dialog.
3401 "A String",
3402 ],
3403 "key": "A String", # Required. A unique key that will be sent back to the agent if this
3404 # response is given.
3405 },
3406 "image": { # The image response message. # Optional. The image to display.
3407 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3408 # e.g., screen readers.
3409 "imageUri": "A String", # Optional. The public URI to an image file.
3410 },
3411 "description": "A String", # Optional. The body text of the card.
3412 "title": "A String", # Required. Title of the carousel item.
3413 },
3414 ],
3415 },
3416 "listSelect": { # The card for presenting a list of options to select from. # The list card response for Actions on Google.
3417 "items": [ # Required. List items.
3418 { # An item in the list.
3419 "info": { # Additional info about the select item for when it is triggered in a # Required. Additional information about this option.
3420 # dialog.
3421 "synonyms": [ # Optional. A list of synonyms that can also be used to trigger this
3422 # item in dialog.
3423 "A String",
3424 ],
3425 "key": "A String", # Required. A unique key that will be sent back to the agent if this
3426 # response is given.
3427 },
3428 "image": { # The image response message. # Optional. The image to display.
3429 "accessibilityText": "A String", # Optional. A text description of the image to be used for accessibility,
3430 # e.g., screen readers.
3431 "imageUri": "A String", # Optional. The public URI to an image file.
3432 },
3433 "description": "A String", # Optional. The main text describing the item.
3434 "title": "A String", # Required. The title of the list item.
3435 },
3436 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3437 "subtitle": "A String", # Optional. Subtitle of the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3438 "title": "A String", # Optional. The overall title of the list.
3439 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3440 "payload": { # A custom platform-specific response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3441 "a_key": "", # Properties of the object.
3442 },
3443 "card": { # The card response message. # The card response.
3444 "buttons": [ # Optional. The collection of card buttons.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3445 { # Contains information about a button.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3446 "text": "A String", # Optional. The text to show on the button.
3447 "postback": "A String", # Optional. The text to send back to the Dialogflow API or a URI to
3448 # open.
3449 },
3450 ],
3451 "title": "A String", # Optional. The title of the card.
3452 "subtitle": "A String", # Optional. The subtitle of the card.
3453 "imageUri": "A String", # Optional. The public URI to an image file for the card.
3454 },
3455 },
3456 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3457 "defaultResponsePlatforms": [ # Optional. The list of platforms for which the first responses will be
3458 # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
3459 "A String",
3460 ],
3461 "priority": 42, # Optional. The priority of this intent. Higher numbers represent higher
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3462 # priorities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3463 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3464 # - If the supplied value is unspecified or 0, the service
3465 # translates the value to 500,000, which corresponds to the
3466 # `Normal` priority in the console.
3467 # - If the supplied value is negative, the intent is ignored
3468 # in runtime detect intent requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3469 "rootFollowupIntentName": "A String", # Read-only. The unique identifier of the root intent in the chain of
3470 # followup intents. It identifies the correct followup intents chain for
3471 # this intent. We populate this field only in the output.
3472 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3473 # Format: `projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3474 "action": "A String", # Optional. The name of the action associated with the intent.
3475 # Note: The action name must not contain whitespaces.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3476 "resetContexts": True or False, # Optional. Indicates whether to delete all contexts in the current
3477 # session when this intent is matched.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3478 "outputContexts": [ # Optional. The collection of contexts that are activated when the intent
3479 # is matched. Context messages in this collection should not set the
3480 # parameters field. Setting the `lifespan_count` to 0 will reset the context
3481 # when the intent is matched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3482 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3483 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3484 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3485 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
3486 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
3487 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3488 #
3489 # The `Context ID` is always converted to lowercase, may only contain
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3490 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
3491 #
3492 # If `Environment ID` is not specified, we assume default 'draft'
3493 # environment. If `User ID` is not specified, we assume default '-' user.
3494 #
3495 # The following context names are reserved for internal use by Dialogflow.
3496 # You should not use these contexts or create contexts with these names:
3497 #
3498 # * `__system_counters__`
3499 # * `*_id_dialog_context`
3500 # * `*_dialog_params_size`
3501 "parameters": { # Optional. The collection of parameters associated with this context.
3502 #
3503 # Depending on your protocol or client library language, this is a
3504 # map, associative array, symbol table, dictionary, or JSON object
3505 # composed of a collection of (MapKey, MapValue) pairs:
3506 #
3507 # - MapKey type: string
3508 # - MapKey value: parameter name
3509 # - MapValue type:
3510 # - If parameter's entity type is a composite entity: map
3511 # - Else: string or number, depending on parameter value type
3512 # - MapValue value:
3513 # - If parameter's entity type is a composite entity:
3514 # map from composite entity property names to property values
3515 # - Else: parameter value
3516 "a_key": "", # Properties of the object.
3517 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3518 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3519 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3520 # immediately. Contexts expire automatically after 20 minutes if there
3521 # are no matching queries.
3522 },
3523 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3524 "inputContextNames": [ # Optional. The list of context names required for this intent to be
3525 # triggered.
3526 # Format: `projects/&lt;Project ID&gt;/agent/sessions/-/contexts/&lt;Context ID&gt;`.
3527 "A String",
3528 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3529 "events": [ # Optional. The collection of event names that trigger the intent.
3530 # If the collection of input contexts is not empty, all of the contexts must
3531 # 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^]3532 # Event names are limited to 150 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3533 "A String",
3534 ],
3535 }</pre>
3536</div>
3537
3538</body></html>