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