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