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