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