| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -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_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.environments.html">environments</a> . <a href="dialogflow_v3beta1.projects.locations.agents.environments.sessions.html">sessions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="dialogflow_v3beta1.projects.locations.agents.environments.sessions.entityTypes.html">entityTypes()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the entityTypes Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#detectIntent">detectIntent(session, body=None, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#fulfillIntent">fulfillIntent(session, body=None, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#matchIntent">matchIntent(session, body=None, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Returns preliminary intent match results, doesn't change the session status.</p> |
| 94 | <h3>Method Details</h3> |
| 95 | <div class="method"> |
| 96 | <code class="details" id="close">close()</code> |
| 97 | <pre>Close httplib2 connections.</pre> |
| 98 | </div> |
| 99 | |
| 100 | <div class="method"> |
| 101 | <code class="details" id="detectIntent">detectIntent(session, body=None, x__xgafv=None)</code> |
| 102 | <pre>Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. |
| 103 | |
| 104 | Args: |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 105 | session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | body: object, The request body. |
| 107 | The object takes the form of: |
| 108 | |
| 109 | { # The request to detect user's intent. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 110 | "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 111 | "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 112 | "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
| 113 | "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 114 | "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 115 | "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
| 116 | "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 117 | "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. |
| 118 | "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. |
| 119 | "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. |
| 120 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 121 | "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
| 122 | "A String", |
| 123 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 124 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 125 | }, |
| 126 | "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. # Required. The input specification. |
| 127 | "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled. |
| 128 | "digits": "A String", # The dtmf digits. |
| 129 | "finishDigit": "A String", # The finish digit (if any). |
| 130 | }, |
| 131 | "event": { # Represents the event to trigger. # The event to be triggered. |
| 132 | "event": "A String", # Name of the event. |
| 133 | }, |
| 134 | "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
| 135 | "text": { # Represents the natural language text to be processed. # The natural language text to be processed. |
| 136 | "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. |
| 137 | }, |
| 138 | "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed. |
| 139 | "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests. |
| 140 | "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. |
| 141 | "modelVariant": "A String", # Optional. Which variant of the Speech model to use. |
| 142 | "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. |
| 143 | "model": "A String", # Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. |
| 144 | "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. |
| 145 | "A String", |
| 146 | ], |
| 147 | "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. |
| 148 | "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. |
| 149 | "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. |
| 150 | }, |
| 151 | }, |
| 152 | "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered. |
| 153 | "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`. |
| 154 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 155 | }, |
| 156 | "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. |
| 157 | "timeZone": "A String", # The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 158 | "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. |
| 159 | "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 160 | "a_key": "", # Properties of the object. |
| 161 | }, |
| 162 | "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. |
| 163 | { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview). |
| 164 | "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 165 | "entities": [ # Required. The collection of entities to override or supplement the custom entity type. |
| 166 | { # An **entity entry** for an associated entity type. Next Id = 8 |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 167 | "value": "A String", # Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 168 | "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. |
| 169 | "A String", |
| 170 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 171 | }, |
| 172 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 173 | "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 174 | }, |
| 175 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 176 | "geoLocation": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. |
| 177 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 178 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 179 | }, |
| 180 | "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 181 | "a_key": "", # Properties of the object. |
| 182 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 183 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | x__xgafv: string, V1 error format. |
| 187 | Allowed values |
| 188 | 1 - v1 error format |
| 189 | 2 - v2 error format |
| 190 | |
| 191 | Returns: |
| 192 | An object of the form: |
| 193 | |
| 194 | { # The message returned from the DetectIntent method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 195 | "queryResult": { # Represents the result of a conversational query. # The result of the conversational query. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 196 | "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 197 | "a_key": "", # Properties of the object. |
| 198 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 199 | "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 200 | "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. |
| 201 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 202 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 203 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 204 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 205 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 206 | "a_key": "", # Properties of the object. |
| 207 | }, |
| 208 | }, |
| 209 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 210 | "segments": [ # Segments this audio response is composed of. |
| 211 | { # Represents one segment of audio. |
| 212 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 213 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 214 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 215 | }, |
| 216 | ], |
| 217 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 218 | "text": { # The text response message. # Returns a text response. |
| 219 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 220 | "text": [ # Required. A collection of text responses. |
| 221 | "A String", |
| 222 | ], |
| 223 | }, |
| 224 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 225 | "a_key": "", # Properties of the object. |
| 226 | }, |
| 227 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 228 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 229 | "a_key": "", # Properties of the object. |
| 230 | }, |
| 231 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 232 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 233 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 234 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 235 | }, |
| 236 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 237 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 238 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 239 | "text": "A String", # The raw text to be synthesized. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 240 | }, |
| 241 | }, |
| 242 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 243 | "webhookStatuses": [ # The list of webhook call status in the order of call sequence. |
| 244 | { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 245 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 246 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 247 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 248 | { |
| 249 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 250 | }, |
| 251 | ], |
| 252 | }, |
| 253 | ], |
| 254 | "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. |
| 255 | "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
| 256 | "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
| 257 | "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. |
| 258 | "priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| 259 | "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. |
| 260 | "parameters": [ # The collection of parameters associated with the intent. |
| 261 | { # Represents an intent parameter. |
| 262 | "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
| 263 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| 264 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false. |
| 265 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| 266 | }, |
| 267 | ], |
| 268 | "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. |
| 269 | { # Represents an example that the agent is trained on to identify the intent. |
| 270 | "repeatCount": 42, # Indicates how many times this example was added to the intent. |
| 271 | "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set. |
| 272 | { # Represents a part of a training phrase. |
| 273 | "text": "A String", # Required. The text for this part. |
| 274 | "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. |
| 275 | }, |
| 276 | ], |
| 277 | "id": "A String", # Output only. The unique identifier of the training phrase. |
| 278 | }, |
| 279 | ], |
| 280 | "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. |
| 281 | "a_key": "A String", |
| 282 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 283 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 284 | "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 285 | "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. |
| 286 | { |
| 287 | "a_key": "", # Properties of the object. |
| 288 | }, |
| 289 | ], |
| 290 | "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 291 | "parameters": { # The collected session parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 292 | "a_key": "", # Properties of the object. |
| 293 | }, |
| 294 | "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the trascript for the audio. |
| 295 | "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. |
| 296 | "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. |
| 297 | "confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. |
| 298 | "matchType": "A String", # Type of this Match. |
| 299 | "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. |
| 300 | "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. |
| 301 | "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
| 302 | "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
| 303 | "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. |
| 304 | "priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| 305 | "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. |
| 306 | "parameters": [ # The collection of parameters associated with the intent. |
| 307 | { # Represents an intent parameter. |
| 308 | "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
| 309 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| 310 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false. |
| 311 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| 312 | }, |
| 313 | ], |
| 314 | "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. |
| 315 | { # Represents an example that the agent is trained on to identify the intent. |
| 316 | "repeatCount": 42, # Indicates how many times this example was added to the intent. |
| 317 | "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set. |
| 318 | { # Represents a part of a training phrase. |
| 319 | "text": "A String", # Required. The text for this part. |
| 320 | "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. |
| 321 | }, |
| 322 | ], |
| 323 | "id": "A String", # Output only. The unique identifier of the training phrase. |
| 324 | }, |
| 325 | ], |
| 326 | "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. |
| 327 | "a_key": "A String", |
| 328 | }, |
| 329 | }, |
| 330 | "parameters": { # The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 331 | "a_key": "", # Properties of the object. |
| 332 | }, |
| 333 | }, |
| 334 | "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. |
| 335 | "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. |
| 336 | "parameters": [ # Parameters to collect from the user. |
| 337 | { # Represents a form parameter. |
| 338 | "required": True or False, # Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes. |
| 339 | "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. |
| 340 | "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. |
| 341 | "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. |
| 342 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 343 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 344 | "cases": [ # A list of cascading if-else conditions. |
| 345 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 346 | "caseContent": [ # A list of case content. |
| 347 | { # The list of messages or conditional cases to activate for this case. |
| 348 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 349 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 350 | }, |
| 351 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 352 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 353 | "a_key": "", # Properties of the object. |
| 354 | }, |
| 355 | }, |
| 356 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 357 | "segments": [ # Segments this audio response is composed of. |
| 358 | { # Represents one segment of audio. |
| 359 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 360 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 361 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 362 | }, |
| 363 | ], |
| 364 | }, |
| 365 | "text": { # The text response message. # Returns a text response. |
| 366 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 367 | "text": [ # Required. A collection of text responses. |
| 368 | "A String", |
| 369 | ], |
| 370 | }, |
| 371 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 372 | "a_key": "", # Properties of the object. |
| 373 | }, |
| 374 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 375 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 376 | "a_key": "", # Properties of the object. |
| 377 | }, |
| 378 | }, |
| 379 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 380 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 381 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 382 | }, |
| 383 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 384 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 385 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 386 | "text": "A String", # The raw text to be synthesized. |
| 387 | }, |
| 388 | }, |
| 389 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 390 | }, |
| 391 | ], |
| 392 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 393 | }, |
| 394 | ], |
| 395 | }, |
| 396 | ], |
| 397 | "messages": [ # The list of rich message responses to present to the user. |
| 398 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 399 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 400 | }, |
| 401 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 402 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 403 | "a_key": "", # Properties of the object. |
| 404 | }, |
| 405 | }, |
| 406 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 407 | "segments": [ # Segments this audio response is composed of. |
| 408 | { # Represents one segment of audio. |
| 409 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 410 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 411 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 412 | }, |
| 413 | ], |
| 414 | }, |
| 415 | "text": { # The text response message. # Returns a text response. |
| 416 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 417 | "text": [ # Required. A collection of text responses. |
| 418 | "A String", |
| 419 | ], |
| 420 | }, |
| 421 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 422 | "a_key": "", # Properties of the object. |
| 423 | }, |
| 424 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 425 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 426 | "a_key": "", # Properties of the object. |
| 427 | }, |
| 428 | }, |
| 429 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 430 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 431 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 432 | }, |
| 433 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 434 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 435 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 436 | "text": "A String", # The raw text to be synthesized. |
| 437 | }, |
| 438 | }, |
| 439 | ], |
| 440 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 441 | { # Setting a parameter value. |
| 442 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 443 | "parameter": "A String", # Display name of the parameter. |
| 444 | }, |
| 445 | ], |
| 446 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 447 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 448 | }, |
| 449 | "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. |
| 450 | { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. |
| 451 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 452 | "event": "A String", # Required. The name of the event to handle. |
| 453 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. |
| 454 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 455 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 456 | "cases": [ # A list of cascading if-else conditions. |
| 457 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 458 | "caseContent": [ # A list of case content. |
| 459 | { # The list of messages or conditional cases to activate for this case. |
| 460 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 461 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 462 | }, |
| 463 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 464 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 465 | "a_key": "", # Properties of the object. |
| 466 | }, |
| 467 | }, |
| 468 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 469 | "segments": [ # Segments this audio response is composed of. |
| 470 | { # Represents one segment of audio. |
| 471 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 472 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 473 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 474 | }, |
| 475 | ], |
| 476 | }, |
| 477 | "text": { # The text response message. # Returns a text response. |
| 478 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 479 | "text": [ # Required. A collection of text responses. |
| 480 | "A String", |
| 481 | ], |
| 482 | }, |
| 483 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 484 | "a_key": "", # Properties of the object. |
| 485 | }, |
| 486 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 487 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 488 | "a_key": "", # Properties of the object. |
| 489 | }, |
| 490 | }, |
| 491 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 492 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 493 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 494 | }, |
| 495 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 496 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 497 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 498 | "text": "A String", # The raw text to be synthesized. |
| 499 | }, |
| 500 | }, |
| 501 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 502 | }, |
| 503 | ], |
| 504 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 505 | }, |
| 506 | ], |
| 507 | }, |
| 508 | ], |
| 509 | "messages": [ # The list of rich message responses to present to the user. |
| 510 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 511 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 512 | }, |
| 513 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 514 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 515 | "a_key": "", # Properties of the object. |
| 516 | }, |
| 517 | }, |
| 518 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 519 | "segments": [ # Segments this audio response is composed of. |
| 520 | { # Represents one segment of audio. |
| 521 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 522 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 523 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 524 | }, |
| 525 | ], |
| 526 | }, |
| 527 | "text": { # The text response message. # Returns a text response. |
| 528 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 529 | "text": [ # Required. A collection of text responses. |
| 530 | "A String", |
| 531 | ], |
| 532 | }, |
| 533 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 534 | "a_key": "", # Properties of the object. |
| 535 | }, |
| 536 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 537 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 538 | "a_key": "", # Properties of the object. |
| 539 | }, |
| 540 | }, |
| 541 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 542 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 543 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 544 | }, |
| 545 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 546 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 547 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 548 | "text": "A String", # The raw text to be synthesized. |
| 549 | }, |
| 550 | }, |
| 551 | ], |
| 552 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 553 | { # Setting a parameter value. |
| 554 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 555 | "parameter": "A String", # Display name of the parameter. |
| 556 | }, |
| 557 | ], |
| 558 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 559 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 560 | }, |
| 561 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 562 | "name": "A String", # Output only. The unique identifier of this event handler. |
| 563 | }, |
| 564 | ], |
| 565 | }, |
| 566 | "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. |
| 567 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| 568 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| 569 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter name in both request and response. The default value is false. |
| 570 | }, |
| 571 | ], |
| 572 | }, |
| 573 | "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`. |
| 574 | "A String", |
| 575 | ], |
| 576 | "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. |
| 577 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 578 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 579 | "cases": [ # A list of cascading if-else conditions. |
| 580 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 581 | "caseContent": [ # A list of case content. |
| 582 | { # The list of messages or conditional cases to activate for this case. |
| 583 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 584 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 585 | }, |
| 586 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 587 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 588 | "a_key": "", # Properties of the object. |
| 589 | }, |
| 590 | }, |
| 591 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 592 | "segments": [ # Segments this audio response is composed of. |
| 593 | { # Represents one segment of audio. |
| 594 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 595 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 596 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 597 | }, |
| 598 | ], |
| 599 | }, |
| 600 | "text": { # The text response message. # Returns a text response. |
| 601 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 602 | "text": [ # Required. A collection of text responses. |
| 603 | "A String", |
| 604 | ], |
| 605 | }, |
| 606 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 607 | "a_key": "", # Properties of the object. |
| 608 | }, |
| 609 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 610 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 611 | "a_key": "", # Properties of the object. |
| 612 | }, |
| 613 | }, |
| 614 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 615 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 616 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 617 | }, |
| 618 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 619 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 620 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 621 | "text": "A String", # The raw text to be synthesized. |
| 622 | }, |
| 623 | }, |
| 624 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 625 | }, |
| 626 | ], |
| 627 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 628 | }, |
| 629 | ], |
| 630 | }, |
| 631 | ], |
| 632 | "messages": [ # The list of rich message responses to present to the user. |
| 633 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 634 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 635 | }, |
| 636 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 637 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 638 | "a_key": "", # Properties of the object. |
| 639 | }, |
| 640 | }, |
| 641 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 642 | "segments": [ # Segments this audio response is composed of. |
| 643 | { # Represents one segment of audio. |
| 644 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 645 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 646 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 647 | }, |
| 648 | ], |
| 649 | }, |
| 650 | "text": { # The text response message. # Returns a text response. |
| 651 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 652 | "text": [ # Required. A collection of text responses. |
| 653 | "A String", |
| 654 | ], |
| 655 | }, |
| 656 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 657 | "a_key": "", # Properties of the object. |
| 658 | }, |
| 659 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 660 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 661 | "a_key": "", # Properties of the object. |
| 662 | }, |
| 663 | }, |
| 664 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 665 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 666 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 667 | }, |
| 668 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 669 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 670 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 671 | "text": "A String", # The raw text to be synthesized. |
| 672 | }, |
| 673 | }, |
| 674 | ], |
| 675 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 676 | { # Setting a parameter value. |
| 677 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 678 | "parameter": "A String", # Display name of the parameter. |
| 679 | }, |
| 680 | ], |
| 681 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 682 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 683 | }, |
| 684 | "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the page with only condition specified. |
| 685 | { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. |
| 686 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 687 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. |
| 688 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 689 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 690 | "cases": [ # A list of cascading if-else conditions. |
| 691 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 692 | "caseContent": [ # A list of case content. |
| 693 | { # The list of messages or conditional cases to activate for this case. |
| 694 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 695 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 696 | }, |
| 697 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 698 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 699 | "a_key": "", # Properties of the object. |
| 700 | }, |
| 701 | }, |
| 702 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 703 | "segments": [ # Segments this audio response is composed of. |
| 704 | { # Represents one segment of audio. |
| 705 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 706 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 707 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 708 | }, |
| 709 | ], |
| 710 | }, |
| 711 | "text": { # The text response message. # Returns a text response. |
| 712 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 713 | "text": [ # Required. A collection of text responses. |
| 714 | "A String", |
| 715 | ], |
| 716 | }, |
| 717 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 718 | "a_key": "", # Properties of the object. |
| 719 | }, |
| 720 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 721 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 722 | "a_key": "", # Properties of the object. |
| 723 | }, |
| 724 | }, |
| 725 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 726 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 727 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 728 | }, |
| 729 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 730 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 731 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 732 | "text": "A String", # The raw text to be synthesized. |
| 733 | }, |
| 734 | }, |
| 735 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 736 | }, |
| 737 | ], |
| 738 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 739 | }, |
| 740 | ], |
| 741 | }, |
| 742 | ], |
| 743 | "messages": [ # The list of rich message responses to present to the user. |
| 744 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 745 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 746 | }, |
| 747 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 748 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 749 | "a_key": "", # Properties of the object. |
| 750 | }, |
| 751 | }, |
| 752 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 753 | "segments": [ # Segments this audio response is composed of. |
| 754 | { # Represents one segment of audio. |
| 755 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 756 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 757 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 758 | }, |
| 759 | ], |
| 760 | }, |
| 761 | "text": { # The text response message. # Returns a text response. |
| 762 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 763 | "text": [ # Required. A collection of text responses. |
| 764 | "A String", |
| 765 | ], |
| 766 | }, |
| 767 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 768 | "a_key": "", # Properties of the object. |
| 769 | }, |
| 770 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 771 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 772 | "a_key": "", # Properties of the object. |
| 773 | }, |
| 774 | }, |
| 775 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 776 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 777 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 778 | }, |
| 779 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 780 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 781 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 782 | "text": "A String", # The raw text to be synthesized. |
| 783 | }, |
| 784 | }, |
| 785 | ], |
| 786 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 787 | { # Setting a parameter value. |
| 788 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 789 | "parameter": "A String", # Display name of the parameter. |
| 790 | }, |
| 791 | ], |
| 792 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 793 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 794 | }, |
| 795 | "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. |
| 796 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 797 | "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. |
| 798 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 799 | }, |
| 800 | ], |
| 801 | "displayName": "A String", # Required. The human-readable name of the page, unique within the agent. |
| 802 | "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. |
| 803 | "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. |
| 804 | { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. |
| 805 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 806 | "event": "A String", # Required. The name of the event to handle. |
| 807 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. |
| 808 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 809 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 810 | "cases": [ # A list of cascading if-else conditions. |
| 811 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 812 | "caseContent": [ # A list of case content. |
| 813 | { # The list of messages or conditional cases to activate for this case. |
| 814 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 815 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 816 | }, |
| 817 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 818 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 819 | "a_key": "", # Properties of the object. |
| 820 | }, |
| 821 | }, |
| 822 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 823 | "segments": [ # Segments this audio response is composed of. |
| 824 | { # Represents one segment of audio. |
| 825 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 826 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 827 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 828 | }, |
| 829 | ], |
| 830 | }, |
| 831 | "text": { # The text response message. # Returns a text response. |
| 832 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 833 | "text": [ # Required. A collection of text responses. |
| 834 | "A String", |
| 835 | ], |
| 836 | }, |
| 837 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 838 | "a_key": "", # Properties of the object. |
| 839 | }, |
| 840 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 841 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 842 | "a_key": "", # Properties of the object. |
| 843 | }, |
| 844 | }, |
| 845 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 846 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 847 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 848 | }, |
| 849 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 850 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 851 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 852 | "text": "A String", # The raw text to be synthesized. |
| 853 | }, |
| 854 | }, |
| 855 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 856 | }, |
| 857 | ], |
| 858 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 859 | }, |
| 860 | ], |
| 861 | }, |
| 862 | ], |
| 863 | "messages": [ # The list of rich message responses to present to the user. |
| 864 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 865 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 866 | }, |
| 867 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 868 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 869 | "a_key": "", # Properties of the object. |
| 870 | }, |
| 871 | }, |
| 872 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 873 | "segments": [ # Segments this audio response is composed of. |
| 874 | { # Represents one segment of audio. |
| 875 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 876 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 877 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 878 | }, |
| 879 | ], |
| 880 | }, |
| 881 | "text": { # The text response message. # Returns a text response. |
| 882 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 883 | "text": [ # Required. A collection of text responses. |
| 884 | "A String", |
| 885 | ], |
| 886 | }, |
| 887 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 888 | "a_key": "", # Properties of the object. |
| 889 | }, |
| 890 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 891 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 892 | "a_key": "", # Properties of the object. |
| 893 | }, |
| 894 | }, |
| 895 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 896 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 897 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 898 | }, |
| 899 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 900 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 901 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 902 | "text": "A String", # The raw text to be synthesized. |
| 903 | }, |
| 904 | }, |
| 905 | ], |
| 906 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 907 | { # Setting a parameter value. |
| 908 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 909 | "parameter": "A String", # Display name of the parameter. |
| 910 | }, |
| 911 | ], |
| 912 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 913 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 914 | }, |
| 915 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 916 | "name": "A String", # Output only. The unique identifier of this event handler. |
| 917 | }, |
| 918 | ], |
| 919 | }, |
| 920 | "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. |
| 921 | "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead. |
| 922 | "sentimentAnalysisResult": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. |
| 923 | "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). |
| 924 | "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). |
| 925 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 926 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 927 | "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio. |
| 928 | "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. |
| 929 | "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
| 930 | "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. |
| 931 | "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
| 932 | "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
| 933 | "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
| 934 | "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. |
| 935 | "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. |
| 936 | "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. |
| 937 | }, |
| 938 | "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
| 939 | "A String", |
| 940 | ], |
| 941 | }, |
| 942 | }, |
| 943 | "outputAudio": "A String", # The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.response_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content. |
| 944 | "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 945 | }</pre> |
| 946 | </div> |
| 947 | |
| 948 | <div class="method"> |
| 949 | <code class="details" id="fulfillIntent">fulfillIntent(session, body=None, x__xgafv=None)</code> |
| 950 | <pre>Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined. |
| 951 | |
| 952 | Args: |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 953 | session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 954 | body: object, The request body. |
| 955 | The object takes the form of: |
| 956 | |
| 957 | { # Request of FulfillIntent |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 958 | "match": { # Represents one match result of MatchIntent. # The matched intent/event to fulfill. |
| 959 | "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 960 | "confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. |
| 961 | "matchType": "A String", # Type of this Match. |
| 962 | "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 963 | "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 964 | "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 965 | "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
| 966 | "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. |
| 967 | "priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| 968 | "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 969 | "parameters": [ # The collection of parameters associated with the intent. |
| 970 | { # Represents an intent parameter. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 971 | "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 972 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 973 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false. |
| 974 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 975 | }, |
| 976 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 977 | "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. |
| 978 | { # Represents an example that the agent is trained on to identify the intent. |
| 979 | "repeatCount": 42, # Indicates how many times this example was added to the intent. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 980 | "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set. |
| 981 | { # Represents a part of a training phrase. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 982 | "text": "A String", # Required. The text for this part. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 983 | "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 984 | }, |
| 985 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 986 | "id": "A String", # Output only. The unique identifier of the training phrase. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 987 | }, |
| 988 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 989 | "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. |
| 990 | "a_key": "A String", |
| 991 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 992 | }, |
| 993 | "parameters": { # The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 994 | "a_key": "", # Properties of the object. |
| 995 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 996 | }, |
| 997 | "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate output audio. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 998 | "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 999 | "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
| 1000 | "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1001 | "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1002 | "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
| 1003 | "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1004 | "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. |
| 1005 | "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. |
| 1006 | "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. |
| 1007 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1008 | "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
| 1009 | "A String", |
| 1010 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1011 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1012 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1013 | "matchIntentRequest": { # Request of MatchIntent. # Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1014 | "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. # Required. The input specification. |
| 1015 | "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled. |
| 1016 | "digits": "A String", # The dtmf digits. |
| 1017 | "finishDigit": "A String", # The finish digit (if any). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1018 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1019 | "event": { # Represents the event to trigger. # The event to be triggered. |
| 1020 | "event": "A String", # Name of the event. |
| 1021 | }, |
| 1022 | "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
| 1023 | "text": { # Represents the natural language text to be processed. # The natural language text to be processed. |
| 1024 | "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. |
| 1025 | }, |
| 1026 | "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed. |
| 1027 | "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests. |
| 1028 | "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. |
| 1029 | "modelVariant": "A String", # Optional. Which variant of the Speech model to use. |
| 1030 | "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. |
| 1031 | "model": "A String", # Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. |
| 1032 | "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. |
| 1033 | "A String", |
| 1034 | ], |
| 1035 | "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. |
| 1036 | "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. |
| 1037 | "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1038 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1039 | }, |
| 1040 | "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered. |
| 1041 | "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1042 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1043 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1044 | "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. |
| 1045 | "timeZone": "A String", # The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used. |
| 1046 | "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. |
| 1047 | "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 1048 | "a_key": "", # Properties of the object. |
| 1049 | }, |
| 1050 | "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. |
| 1051 | { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview). |
| 1052 | "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. |
| 1053 | "entities": [ # Required. The collection of entities to override or supplement the custom entity type. |
| 1054 | { # An **entity entry** for an associated entity type. Next Id = 8 |
| 1055 | "value": "A String", # Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). |
| 1056 | "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. |
| 1057 | "A String", |
| 1058 | ], |
| 1059 | }, |
| 1060 | ], |
| 1061 | "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition. |
| 1062 | }, |
| 1063 | ], |
| 1064 | "geoLocation": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. |
| 1065 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 1066 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 1067 | }, |
| 1068 | "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. |
| 1069 | "a_key": "", # Properties of the object. |
| 1070 | }, |
| 1071 | }, |
| 1072 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1073 | } |
| 1074 | |
| 1075 | x__xgafv: string, V1 error format. |
| 1076 | Allowed values |
| 1077 | 1 - v1 error format |
| 1078 | 2 - v2 error format |
| 1079 | |
| 1080 | Returns: |
| 1081 | An object of the form: |
| 1082 | |
| 1083 | { # Response of FulfillIntent |
| 1084 | "queryResult": { # Represents the result of a conversational query. # The result of the conversational query. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1085 | "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1086 | "a_key": "", # Properties of the object. |
| 1087 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1088 | "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1089 | "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. |
| 1090 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1091 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1092 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1093 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1094 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1095 | "a_key": "", # Properties of the object. |
| 1096 | }, |
| 1097 | }, |
| 1098 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1099 | "segments": [ # Segments this audio response is composed of. |
| 1100 | { # Represents one segment of audio. |
| 1101 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1102 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1103 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1104 | }, |
| 1105 | ], |
| 1106 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1107 | "text": { # The text response message. # Returns a text response. |
| 1108 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1109 | "text": [ # Required. A collection of text responses. |
| 1110 | "A String", |
| 1111 | ], |
| 1112 | }, |
| 1113 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1114 | "a_key": "", # Properties of the object. |
| 1115 | }, |
| 1116 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1117 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1118 | "a_key": "", # Properties of the object. |
| 1119 | }, |
| 1120 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1121 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1122 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1123 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1124 | }, |
| 1125 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1126 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1127 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1128 | "text": "A String", # The raw text to be synthesized. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1129 | }, |
| 1130 | }, |
| 1131 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1132 | "webhookStatuses": [ # The list of webhook call status in the order of call sequence. |
| 1133 | { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 1134 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 1135 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1136 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1137 | { |
| 1138 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1139 | }, |
| 1140 | ], |
| 1141 | }, |
| 1142 | ], |
| 1143 | "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. |
| 1144 | "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
| 1145 | "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
| 1146 | "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. |
| 1147 | "priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| 1148 | "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. |
| 1149 | "parameters": [ # The collection of parameters associated with the intent. |
| 1150 | { # Represents an intent parameter. |
| 1151 | "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
| 1152 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| 1153 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false. |
| 1154 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| 1155 | }, |
| 1156 | ], |
| 1157 | "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. |
| 1158 | { # Represents an example that the agent is trained on to identify the intent. |
| 1159 | "repeatCount": 42, # Indicates how many times this example was added to the intent. |
| 1160 | "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set. |
| 1161 | { # Represents a part of a training phrase. |
| 1162 | "text": "A String", # Required. The text for this part. |
| 1163 | "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. |
| 1164 | }, |
| 1165 | ], |
| 1166 | "id": "A String", # Output only. The unique identifier of the training phrase. |
| 1167 | }, |
| 1168 | ], |
| 1169 | "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. |
| 1170 | "a_key": "A String", |
| 1171 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1172 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1173 | "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1174 | "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. |
| 1175 | { |
| 1176 | "a_key": "", # Properties of the object. |
| 1177 | }, |
| 1178 | ], |
| 1179 | "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1180 | "parameters": { # The collected session parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 1181 | "a_key": "", # Properties of the object. |
| 1182 | }, |
| 1183 | "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the trascript for the audio. |
| 1184 | "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. |
| 1185 | "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. |
| 1186 | "confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. |
| 1187 | "matchType": "A String", # Type of this Match. |
| 1188 | "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. |
| 1189 | "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. |
| 1190 | "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
| 1191 | "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
| 1192 | "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. |
| 1193 | "priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| 1194 | "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. |
| 1195 | "parameters": [ # The collection of parameters associated with the intent. |
| 1196 | { # Represents an intent parameter. |
| 1197 | "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
| 1198 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| 1199 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false. |
| 1200 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| 1201 | }, |
| 1202 | ], |
| 1203 | "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. |
| 1204 | { # Represents an example that the agent is trained on to identify the intent. |
| 1205 | "repeatCount": 42, # Indicates how many times this example was added to the intent. |
| 1206 | "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set. |
| 1207 | { # Represents a part of a training phrase. |
| 1208 | "text": "A String", # Required. The text for this part. |
| 1209 | "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. |
| 1210 | }, |
| 1211 | ], |
| 1212 | "id": "A String", # Output only. The unique identifier of the training phrase. |
| 1213 | }, |
| 1214 | ], |
| 1215 | "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. |
| 1216 | "a_key": "A String", |
| 1217 | }, |
| 1218 | }, |
| 1219 | "parameters": { # The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 1220 | "a_key": "", # Properties of the object. |
| 1221 | }, |
| 1222 | }, |
| 1223 | "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. |
| 1224 | "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. |
| 1225 | "parameters": [ # Parameters to collect from the user. |
| 1226 | { # Represents a form parameter. |
| 1227 | "required": True or False, # Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes. |
| 1228 | "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. |
| 1229 | "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. |
| 1230 | "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. |
| 1231 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1232 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1233 | "cases": [ # A list of cascading if-else conditions. |
| 1234 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1235 | "caseContent": [ # A list of case content. |
| 1236 | { # The list of messages or conditional cases to activate for this case. |
| 1237 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 1238 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1239 | }, |
| 1240 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1241 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1242 | "a_key": "", # Properties of the object. |
| 1243 | }, |
| 1244 | }, |
| 1245 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1246 | "segments": [ # Segments this audio response is composed of. |
| 1247 | { # Represents one segment of audio. |
| 1248 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1249 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1250 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1251 | }, |
| 1252 | ], |
| 1253 | }, |
| 1254 | "text": { # The text response message. # Returns a text response. |
| 1255 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1256 | "text": [ # Required. A collection of text responses. |
| 1257 | "A String", |
| 1258 | ], |
| 1259 | }, |
| 1260 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1261 | "a_key": "", # Properties of the object. |
| 1262 | }, |
| 1263 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1264 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1265 | "a_key": "", # Properties of the object. |
| 1266 | }, |
| 1267 | }, |
| 1268 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1269 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1270 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1271 | }, |
| 1272 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1273 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1274 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1275 | "text": "A String", # The raw text to be synthesized. |
| 1276 | }, |
| 1277 | }, |
| 1278 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1279 | }, |
| 1280 | ], |
| 1281 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 1282 | }, |
| 1283 | ], |
| 1284 | }, |
| 1285 | ], |
| 1286 | "messages": [ # The list of rich message responses to present to the user. |
| 1287 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 1288 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1289 | }, |
| 1290 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1291 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1292 | "a_key": "", # Properties of the object. |
| 1293 | }, |
| 1294 | }, |
| 1295 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1296 | "segments": [ # Segments this audio response is composed of. |
| 1297 | { # Represents one segment of audio. |
| 1298 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1299 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1300 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1301 | }, |
| 1302 | ], |
| 1303 | }, |
| 1304 | "text": { # The text response message. # Returns a text response. |
| 1305 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1306 | "text": [ # Required. A collection of text responses. |
| 1307 | "A String", |
| 1308 | ], |
| 1309 | }, |
| 1310 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1311 | "a_key": "", # Properties of the object. |
| 1312 | }, |
| 1313 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1314 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1315 | "a_key": "", # Properties of the object. |
| 1316 | }, |
| 1317 | }, |
| 1318 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1319 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1320 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1321 | }, |
| 1322 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1323 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1324 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1325 | "text": "A String", # The raw text to be synthesized. |
| 1326 | }, |
| 1327 | }, |
| 1328 | ], |
| 1329 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1330 | { # Setting a parameter value. |
| 1331 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1332 | "parameter": "A String", # Display name of the parameter. |
| 1333 | }, |
| 1334 | ], |
| 1335 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1336 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1337 | }, |
| 1338 | "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. |
| 1339 | { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. |
| 1340 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1341 | "event": "A String", # Required. The name of the event to handle. |
| 1342 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. |
| 1343 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1344 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1345 | "cases": [ # A list of cascading if-else conditions. |
| 1346 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1347 | "caseContent": [ # A list of case content. |
| 1348 | { # The list of messages or conditional cases to activate for this case. |
| 1349 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 1350 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1351 | }, |
| 1352 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1353 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1354 | "a_key": "", # Properties of the object. |
| 1355 | }, |
| 1356 | }, |
| 1357 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1358 | "segments": [ # Segments this audio response is composed of. |
| 1359 | { # Represents one segment of audio. |
| 1360 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1361 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1362 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1363 | }, |
| 1364 | ], |
| 1365 | }, |
| 1366 | "text": { # The text response message. # Returns a text response. |
| 1367 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1368 | "text": [ # Required. A collection of text responses. |
| 1369 | "A String", |
| 1370 | ], |
| 1371 | }, |
| 1372 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1373 | "a_key": "", # Properties of the object. |
| 1374 | }, |
| 1375 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1376 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1377 | "a_key": "", # Properties of the object. |
| 1378 | }, |
| 1379 | }, |
| 1380 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1381 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1382 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1383 | }, |
| 1384 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1385 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1386 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1387 | "text": "A String", # The raw text to be synthesized. |
| 1388 | }, |
| 1389 | }, |
| 1390 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1391 | }, |
| 1392 | ], |
| 1393 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 1394 | }, |
| 1395 | ], |
| 1396 | }, |
| 1397 | ], |
| 1398 | "messages": [ # The list of rich message responses to present to the user. |
| 1399 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 1400 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1401 | }, |
| 1402 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1403 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1404 | "a_key": "", # Properties of the object. |
| 1405 | }, |
| 1406 | }, |
| 1407 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1408 | "segments": [ # Segments this audio response is composed of. |
| 1409 | { # Represents one segment of audio. |
| 1410 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1411 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1412 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1413 | }, |
| 1414 | ], |
| 1415 | }, |
| 1416 | "text": { # The text response message. # Returns a text response. |
| 1417 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1418 | "text": [ # Required. A collection of text responses. |
| 1419 | "A String", |
| 1420 | ], |
| 1421 | }, |
| 1422 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1423 | "a_key": "", # Properties of the object. |
| 1424 | }, |
| 1425 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1426 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1427 | "a_key": "", # Properties of the object. |
| 1428 | }, |
| 1429 | }, |
| 1430 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1431 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1432 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1433 | }, |
| 1434 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1435 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1436 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1437 | "text": "A String", # The raw text to be synthesized. |
| 1438 | }, |
| 1439 | }, |
| 1440 | ], |
| 1441 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1442 | { # Setting a parameter value. |
| 1443 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1444 | "parameter": "A String", # Display name of the parameter. |
| 1445 | }, |
| 1446 | ], |
| 1447 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1448 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1449 | }, |
| 1450 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1451 | "name": "A String", # Output only. The unique identifier of this event handler. |
| 1452 | }, |
| 1453 | ], |
| 1454 | }, |
| 1455 | "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. |
| 1456 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| 1457 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| 1458 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter name in both request and response. The default value is false. |
| 1459 | }, |
| 1460 | ], |
| 1461 | }, |
| 1462 | "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`. |
| 1463 | "A String", |
| 1464 | ], |
| 1465 | "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. |
| 1466 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1467 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1468 | "cases": [ # A list of cascading if-else conditions. |
| 1469 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1470 | "caseContent": [ # A list of case content. |
| 1471 | { # The list of messages or conditional cases to activate for this case. |
| 1472 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 1473 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1474 | }, |
| 1475 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1476 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1477 | "a_key": "", # Properties of the object. |
| 1478 | }, |
| 1479 | }, |
| 1480 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1481 | "segments": [ # Segments this audio response is composed of. |
| 1482 | { # Represents one segment of audio. |
| 1483 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1484 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1485 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1486 | }, |
| 1487 | ], |
| 1488 | }, |
| 1489 | "text": { # The text response message. # Returns a text response. |
| 1490 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1491 | "text": [ # Required. A collection of text responses. |
| 1492 | "A String", |
| 1493 | ], |
| 1494 | }, |
| 1495 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1496 | "a_key": "", # Properties of the object. |
| 1497 | }, |
| 1498 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1499 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1500 | "a_key": "", # Properties of the object. |
| 1501 | }, |
| 1502 | }, |
| 1503 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1504 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1505 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1506 | }, |
| 1507 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1508 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1509 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1510 | "text": "A String", # The raw text to be synthesized. |
| 1511 | }, |
| 1512 | }, |
| 1513 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1514 | }, |
| 1515 | ], |
| 1516 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 1517 | }, |
| 1518 | ], |
| 1519 | }, |
| 1520 | ], |
| 1521 | "messages": [ # The list of rich message responses to present to the user. |
| 1522 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 1523 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1524 | }, |
| 1525 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1526 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1527 | "a_key": "", # Properties of the object. |
| 1528 | }, |
| 1529 | }, |
| 1530 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1531 | "segments": [ # Segments this audio response is composed of. |
| 1532 | { # Represents one segment of audio. |
| 1533 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1534 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1535 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1536 | }, |
| 1537 | ], |
| 1538 | }, |
| 1539 | "text": { # The text response message. # Returns a text response. |
| 1540 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1541 | "text": [ # Required. A collection of text responses. |
| 1542 | "A String", |
| 1543 | ], |
| 1544 | }, |
| 1545 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1546 | "a_key": "", # Properties of the object. |
| 1547 | }, |
| 1548 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1549 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1550 | "a_key": "", # Properties of the object. |
| 1551 | }, |
| 1552 | }, |
| 1553 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1554 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1555 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1556 | }, |
| 1557 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1558 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1559 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1560 | "text": "A String", # The raw text to be synthesized. |
| 1561 | }, |
| 1562 | }, |
| 1563 | ], |
| 1564 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1565 | { # Setting a parameter value. |
| 1566 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1567 | "parameter": "A String", # Display name of the parameter. |
| 1568 | }, |
| 1569 | ], |
| 1570 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1571 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1572 | }, |
| 1573 | "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the page with only condition specified. |
| 1574 | { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. |
| 1575 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1576 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. |
| 1577 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1578 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1579 | "cases": [ # A list of cascading if-else conditions. |
| 1580 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1581 | "caseContent": [ # A list of case content. |
| 1582 | { # The list of messages or conditional cases to activate for this case. |
| 1583 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 1584 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1585 | }, |
| 1586 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1587 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1588 | "a_key": "", # Properties of the object. |
| 1589 | }, |
| 1590 | }, |
| 1591 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1592 | "segments": [ # Segments this audio response is composed of. |
| 1593 | { # Represents one segment of audio. |
| 1594 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1595 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1596 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1597 | }, |
| 1598 | ], |
| 1599 | }, |
| 1600 | "text": { # The text response message. # Returns a text response. |
| 1601 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1602 | "text": [ # Required. A collection of text responses. |
| 1603 | "A String", |
| 1604 | ], |
| 1605 | }, |
| 1606 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1607 | "a_key": "", # Properties of the object. |
| 1608 | }, |
| 1609 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1610 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1611 | "a_key": "", # Properties of the object. |
| 1612 | }, |
| 1613 | }, |
| 1614 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1615 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1616 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1617 | }, |
| 1618 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1619 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1620 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1621 | "text": "A String", # The raw text to be synthesized. |
| 1622 | }, |
| 1623 | }, |
| 1624 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1625 | }, |
| 1626 | ], |
| 1627 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 1628 | }, |
| 1629 | ], |
| 1630 | }, |
| 1631 | ], |
| 1632 | "messages": [ # The list of rich message responses to present to the user. |
| 1633 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 1634 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1635 | }, |
| 1636 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1637 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1638 | "a_key": "", # Properties of the object. |
| 1639 | }, |
| 1640 | }, |
| 1641 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1642 | "segments": [ # Segments this audio response is composed of. |
| 1643 | { # Represents one segment of audio. |
| 1644 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1645 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1646 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1647 | }, |
| 1648 | ], |
| 1649 | }, |
| 1650 | "text": { # The text response message. # Returns a text response. |
| 1651 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1652 | "text": [ # Required. A collection of text responses. |
| 1653 | "A String", |
| 1654 | ], |
| 1655 | }, |
| 1656 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1657 | "a_key": "", # Properties of the object. |
| 1658 | }, |
| 1659 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1660 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1661 | "a_key": "", # Properties of the object. |
| 1662 | }, |
| 1663 | }, |
| 1664 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1665 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1666 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1667 | }, |
| 1668 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1669 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1670 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1671 | "text": "A String", # The raw text to be synthesized. |
| 1672 | }, |
| 1673 | }, |
| 1674 | ], |
| 1675 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1676 | { # Setting a parameter value. |
| 1677 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1678 | "parameter": "A String", # Display name of the parameter. |
| 1679 | }, |
| 1680 | ], |
| 1681 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1682 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1683 | }, |
| 1684 | "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. |
| 1685 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1686 | "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. |
| 1687 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 1688 | }, |
| 1689 | ], |
| 1690 | "displayName": "A String", # Required. The human-readable name of the page, unique within the agent. |
| 1691 | "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. |
| 1692 | "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. |
| 1693 | { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. |
| 1694 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1695 | "event": "A String", # Required. The name of the event to handle. |
| 1696 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. |
| 1697 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1698 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1699 | "cases": [ # A list of cascading if-else conditions. |
| 1700 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1701 | "caseContent": [ # A list of case content. |
| 1702 | { # The list of messages or conditional cases to activate for this case. |
| 1703 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 1704 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1705 | }, |
| 1706 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1707 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1708 | "a_key": "", # Properties of the object. |
| 1709 | }, |
| 1710 | }, |
| 1711 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1712 | "segments": [ # Segments this audio response is composed of. |
| 1713 | { # Represents one segment of audio. |
| 1714 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1715 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1716 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1717 | }, |
| 1718 | ], |
| 1719 | }, |
| 1720 | "text": { # The text response message. # Returns a text response. |
| 1721 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1722 | "text": [ # Required. A collection of text responses. |
| 1723 | "A String", |
| 1724 | ], |
| 1725 | }, |
| 1726 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1727 | "a_key": "", # Properties of the object. |
| 1728 | }, |
| 1729 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1730 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1731 | "a_key": "", # Properties of the object. |
| 1732 | }, |
| 1733 | }, |
| 1734 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1735 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1736 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1737 | }, |
| 1738 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1739 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1740 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1741 | "text": "A String", # The raw text to be synthesized. |
| 1742 | }, |
| 1743 | }, |
| 1744 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1745 | }, |
| 1746 | ], |
| 1747 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 1748 | }, |
| 1749 | ], |
| 1750 | }, |
| 1751 | ], |
| 1752 | "messages": [ # The list of rich message responses to present to the user. |
| 1753 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 1754 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1755 | }, |
| 1756 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1757 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1758 | "a_key": "", # Properties of the object. |
| 1759 | }, |
| 1760 | }, |
| 1761 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1762 | "segments": [ # Segments this audio response is composed of. |
| 1763 | { # Represents one segment of audio. |
| 1764 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1765 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1766 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1767 | }, |
| 1768 | ], |
| 1769 | }, |
| 1770 | "text": { # The text response message. # Returns a text response. |
| 1771 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1772 | "text": [ # Required. A collection of text responses. |
| 1773 | "A String", |
| 1774 | ], |
| 1775 | }, |
| 1776 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1777 | "a_key": "", # Properties of the object. |
| 1778 | }, |
| 1779 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1780 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1781 | "a_key": "", # Properties of the object. |
| 1782 | }, |
| 1783 | }, |
| 1784 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1785 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1786 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1787 | }, |
| 1788 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1789 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1790 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1791 | "text": "A String", # The raw text to be synthesized. |
| 1792 | }, |
| 1793 | }, |
| 1794 | ], |
| 1795 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1796 | { # Setting a parameter value. |
| 1797 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1798 | "parameter": "A String", # Display name of the parameter. |
| 1799 | }, |
| 1800 | ], |
| 1801 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1802 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1803 | }, |
| 1804 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1805 | "name": "A String", # Output only. The unique identifier of this event handler. |
| 1806 | }, |
| 1807 | ], |
| 1808 | }, |
| 1809 | "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. |
| 1810 | "intentDetectionConfidence": 3.14, # The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead. |
| 1811 | "sentimentAnalysisResult": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. |
| 1812 | "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). |
| 1813 | "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). |
| 1814 | }, |
| 1815 | }, |
| 1816 | "outputAudio": "A String", # The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.response_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content. |
| 1817 | "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio. |
| 1818 | "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. |
| 1819 | "sampleRateHertz": 42, # Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). |
| 1820 | "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. |
| 1821 | "speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. |
| 1822 | "pitch": 3.14, # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. |
| 1823 | "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
| 1824 | "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. |
| 1825 | "name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. |
| 1826 | "ssmlGender": "A String", # Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. |
| 1827 | }, |
| 1828 | "effectsProfileId": [ # Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. |
| 1829 | "A String", |
| 1830 | ], |
| 1831 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1832 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1833 | "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1834 | }</pre> |
| 1835 | </div> |
| 1836 | |
| 1837 | <div class="method"> |
| 1838 | <code class="details" id="matchIntent">matchIntent(session, body=None, x__xgafv=None)</code> |
| 1839 | <pre>Returns preliminary intent match results, doesn't change the session status. |
| 1840 | |
| 1841 | Args: |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1842 | session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1843 | body: object, The request body. |
| 1844 | The object takes the form of: |
| 1845 | |
| 1846 | { # Request of MatchIntent. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1847 | "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. # Required. The input specification. |
| 1848 | "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled. |
| 1849 | "digits": "A String", # The dtmf digits. |
| 1850 | "finishDigit": "A String", # The finish digit (if any). |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1851 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1852 | "event": { # Represents the event to trigger. # The event to be triggered. |
| 1853 | "event": "A String", # Name of the event. |
| 1854 | }, |
| 1855 | "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
| 1856 | "text": { # Represents the natural language text to be processed. # The natural language text to be processed. |
| 1857 | "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. |
| 1858 | }, |
| 1859 | "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed. |
| 1860 | "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests. |
| 1861 | "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. |
| 1862 | "modelVariant": "A String", # Optional. Which variant of the Speech model to use. |
| 1863 | "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. |
| 1864 | "model": "A String", # Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. |
| 1865 | "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. |
| 1866 | "A String", |
| 1867 | ], |
| 1868 | "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. |
| 1869 | "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. |
| 1870 | "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1871 | }, |
| 1872 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1873 | "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered. |
| 1874 | "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`. |
| 1875 | }, |
| 1876 | }, |
| 1877 | "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. |
| 1878 | "timeZone": "A String", # The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used. |
| 1879 | "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. |
| 1880 | "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 1881 | "a_key": "", # Properties of the object. |
| 1882 | }, |
| 1883 | "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. |
| 1884 | { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview). |
| 1885 | "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. |
| 1886 | "entities": [ # Required. The collection of entities to override or supplement the custom entity type. |
| 1887 | { # An **entity entry** for an associated entity type. Next Id = 8 |
| 1888 | "value": "A String", # Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). |
| 1889 | "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. |
| 1890 | "A String", |
| 1891 | ], |
| 1892 | }, |
| 1893 | ], |
| 1894 | "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition. |
| 1895 | }, |
| 1896 | ], |
| 1897 | "geoLocation": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # The geo location of this conversational query. |
| 1898 | "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. |
| 1899 | "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. |
| 1900 | }, |
| 1901 | "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. |
| 1902 | "a_key": "", # Properties of the object. |
| 1903 | }, |
| 1904 | }, |
| 1905 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1906 | |
| 1907 | x__xgafv: string, V1 error format. |
| 1908 | Allowed values |
| 1909 | 1 - v1 error format |
| 1910 | 2 - v2 error format |
| 1911 | |
| 1912 | Returns: |
| 1913 | An object of the form: |
| 1914 | |
| 1915 | { # Response of MatchIntent. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1916 | "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1917 | "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. |
| 1918 | "parameters": [ # Parameters to collect from the user. |
| 1919 | { # Represents a form parameter. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1920 | "required": True or False, # Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes. |
| 1921 | "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1922 | "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1923 | "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. |
| 1924 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1925 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1926 | "cases": [ # A list of cascading if-else conditions. |
| 1927 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1928 | "caseContent": [ # A list of case content. |
| 1929 | { # The list of messages or conditional cases to activate for this case. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1930 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1931 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1932 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1933 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1934 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1935 | "a_key": "", # Properties of the object. |
| 1936 | }, |
| 1937 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1938 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1939 | "segments": [ # Segments this audio response is composed of. |
| 1940 | { # Represents one segment of audio. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1941 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1942 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1943 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1944 | }, |
| 1945 | ], |
| 1946 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1947 | "text": { # The text response message. # Returns a text response. |
| 1948 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1949 | "text": [ # Required. A collection of text responses. |
| 1950 | "A String", |
| 1951 | ], |
| 1952 | }, |
| 1953 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1954 | "a_key": "", # Properties of the object. |
| 1955 | }, |
| 1956 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 1957 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1958 | "a_key": "", # Properties of the object. |
| 1959 | }, |
| 1960 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1961 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 1962 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 1963 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1964 | }, |
| 1965 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 1966 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1967 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1968 | "text": "A String", # The raw text to be synthesized. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1969 | }, |
| 1970 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1971 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1972 | }, |
| 1973 | ], |
| 1974 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1975 | }, |
| 1976 | ], |
| 1977 | }, |
| 1978 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1979 | "messages": [ # The list of rich message responses to present to the user. |
| 1980 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 1981 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 1982 | }, |
| 1983 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 1984 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1985 | "a_key": "", # Properties of the object. |
| 1986 | }, |
| 1987 | }, |
| 1988 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 1989 | "segments": [ # Segments this audio response is composed of. |
| 1990 | { # Represents one segment of audio. |
| 1991 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1992 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1993 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 1994 | }, |
| 1995 | ], |
| 1996 | }, |
| 1997 | "text": { # The text response message. # Returns a text response. |
| 1998 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 1999 | "text": [ # Required. A collection of text responses. |
| 2000 | "A String", |
| 2001 | ], |
| 2002 | }, |
| 2003 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2004 | "a_key": "", # Properties of the object. |
| 2005 | }, |
| 2006 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2007 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2008 | "a_key": "", # Properties of the object. |
| 2009 | }, |
| 2010 | }, |
| 2011 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2012 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2013 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2014 | }, |
| 2015 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2016 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 2017 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2018 | "text": "A String", # The raw text to be synthesized. |
| 2019 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2020 | }, |
| 2021 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2022 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 2023 | { # Setting a parameter value. |
| 2024 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 2025 | "parameter": "A String", # Display name of the parameter. |
| 2026 | }, |
| 2027 | ], |
| 2028 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 2029 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 2030 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2031 | "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. |
| 2032 | { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. |
| 2033 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 2034 | "event": "A String", # Required. The name of the event to handle. |
| 2035 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. |
| 2036 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 2037 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 2038 | "cases": [ # A list of cascading if-else conditions. |
| 2039 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 2040 | "caseContent": [ # A list of case content. |
| 2041 | { # The list of messages or conditional cases to activate for this case. |
| 2042 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 2043 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 2044 | }, |
| 2045 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 2046 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 2047 | "a_key": "", # Properties of the object. |
| 2048 | }, |
| 2049 | }, |
| 2050 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 2051 | "segments": [ # Segments this audio response is composed of. |
| 2052 | { # Represents one segment of audio. |
| 2053 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 2054 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 2055 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 2056 | }, |
| 2057 | ], |
| 2058 | }, |
| 2059 | "text": { # The text response message. # Returns a text response. |
| 2060 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2061 | "text": [ # Required. A collection of text responses. |
| 2062 | "A String", |
| 2063 | ], |
| 2064 | }, |
| 2065 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2066 | "a_key": "", # Properties of the object. |
| 2067 | }, |
| 2068 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2069 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2070 | "a_key": "", # Properties of the object. |
| 2071 | }, |
| 2072 | }, |
| 2073 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2074 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2075 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2076 | }, |
| 2077 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2078 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 2079 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2080 | "text": "A String", # The raw text to be synthesized. |
| 2081 | }, |
| 2082 | }, |
| 2083 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 2084 | }, |
| 2085 | ], |
| 2086 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 2087 | }, |
| 2088 | ], |
| 2089 | }, |
| 2090 | ], |
| 2091 | "messages": [ # The list of rich message responses to present to the user. |
| 2092 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 2093 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 2094 | }, |
| 2095 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 2096 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 2097 | "a_key": "", # Properties of the object. |
| 2098 | }, |
| 2099 | }, |
| 2100 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 2101 | "segments": [ # Segments this audio response is composed of. |
| 2102 | { # Represents one segment of audio. |
| 2103 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 2104 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 2105 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 2106 | }, |
| 2107 | ], |
| 2108 | }, |
| 2109 | "text": { # The text response message. # Returns a text response. |
| 2110 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2111 | "text": [ # Required. A collection of text responses. |
| 2112 | "A String", |
| 2113 | ], |
| 2114 | }, |
| 2115 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2116 | "a_key": "", # Properties of the object. |
| 2117 | }, |
| 2118 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2119 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2120 | "a_key": "", # Properties of the object. |
| 2121 | }, |
| 2122 | }, |
| 2123 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2124 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2125 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2126 | }, |
| 2127 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2128 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 2129 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2130 | "text": "A String", # The raw text to be synthesized. |
| 2131 | }, |
| 2132 | }, |
| 2133 | ], |
| 2134 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 2135 | { # Setting a parameter value. |
| 2136 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 2137 | "parameter": "A String", # Display name of the parameter. |
| 2138 | }, |
| 2139 | ], |
| 2140 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 2141 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 2142 | }, |
| 2143 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 2144 | "name": "A String", # Output only. The unique identifier of this event handler. |
| 2145 | }, |
| 2146 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2147 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2148 | "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2149 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| 2150 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2151 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter name in both request and response. The default value is false. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 2152 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2153 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 2154 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2155 | "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`. |
| 2156 | "A String", |
| 2157 | ], |
| 2158 | "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2159 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 2160 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 2161 | "cases": [ # A list of cascading if-else conditions. |
| 2162 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 2163 | "caseContent": [ # A list of case content. |
| 2164 | { # The list of messages or conditional cases to activate for this case. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2165 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2166 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 2167 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2168 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 2169 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 2170 | "a_key": "", # Properties of the object. |
| 2171 | }, |
| 2172 | }, |
| 2173 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 2174 | "segments": [ # Segments this audio response is composed of. |
| 2175 | { # Represents one segment of audio. |
| 2176 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2177 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2178 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2179 | }, |
| 2180 | ], |
| 2181 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2182 | "text": { # The text response message. # Returns a text response. |
| 2183 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2184 | "text": [ # Required. A collection of text responses. |
| 2185 | "A String", |
| 2186 | ], |
| 2187 | }, |
| 2188 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2189 | "a_key": "", # Properties of the object. |
| 2190 | }, |
| 2191 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2192 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2193 | "a_key": "", # Properties of the object. |
| 2194 | }, |
| 2195 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2196 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2197 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2198 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2199 | }, |
| 2200 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2201 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2202 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2203 | "text": "A String", # The raw text to be synthesized. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2204 | }, |
| 2205 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2206 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2207 | }, |
| 2208 | ], |
| 2209 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 2210 | }, |
| 2211 | ], |
| 2212 | }, |
| 2213 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2214 | "messages": [ # The list of rich message responses to present to the user. |
| 2215 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 2216 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 2217 | }, |
| 2218 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 2219 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 2220 | "a_key": "", # Properties of the object. |
| 2221 | }, |
| 2222 | }, |
| 2223 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 2224 | "segments": [ # Segments this audio response is composed of. |
| 2225 | { # Represents one segment of audio. |
| 2226 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 2227 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 2228 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 2229 | }, |
| 2230 | ], |
| 2231 | }, |
| 2232 | "text": { # The text response message. # Returns a text response. |
| 2233 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2234 | "text": [ # Required. A collection of text responses. |
| 2235 | "A String", |
| 2236 | ], |
| 2237 | }, |
| 2238 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2239 | "a_key": "", # Properties of the object. |
| 2240 | }, |
| 2241 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2242 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2243 | "a_key": "", # Properties of the object. |
| 2244 | }, |
| 2245 | }, |
| 2246 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2247 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2248 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2249 | }, |
| 2250 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2251 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 2252 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2253 | "text": "A String", # The raw text to be synthesized. |
| 2254 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2255 | }, |
| 2256 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2257 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 2258 | { # Setting a parameter value. |
| 2259 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 2260 | "parameter": "A String", # Display name of the parameter. |
| 2261 | }, |
| 2262 | ], |
| 2263 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 2264 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2265 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2266 | "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the page with only condition specified. |
| 2267 | { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. |
| 2268 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 2269 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. |
| 2270 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 2271 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 2272 | "cases": [ # A list of cascading if-else conditions. |
| 2273 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 2274 | "caseContent": [ # A list of case content. |
| 2275 | { # The list of messages or conditional cases to activate for this case. |
| 2276 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 2277 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 2278 | }, |
| 2279 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 2280 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 2281 | "a_key": "", # Properties of the object. |
| 2282 | }, |
| 2283 | }, |
| 2284 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 2285 | "segments": [ # Segments this audio response is composed of. |
| 2286 | { # Represents one segment of audio. |
| 2287 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 2288 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 2289 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 2290 | }, |
| 2291 | ], |
| 2292 | }, |
| 2293 | "text": { # The text response message. # Returns a text response. |
| 2294 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2295 | "text": [ # Required. A collection of text responses. |
| 2296 | "A String", |
| 2297 | ], |
| 2298 | }, |
| 2299 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2300 | "a_key": "", # Properties of the object. |
| 2301 | }, |
| 2302 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2303 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2304 | "a_key": "", # Properties of the object. |
| 2305 | }, |
| 2306 | }, |
| 2307 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2308 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2309 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2310 | }, |
| 2311 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2312 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 2313 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2314 | "text": "A String", # The raw text to be synthesized. |
| 2315 | }, |
| 2316 | }, |
| 2317 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 2318 | }, |
| 2319 | ], |
| 2320 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 2321 | }, |
| 2322 | ], |
| 2323 | }, |
| 2324 | ], |
| 2325 | "messages": [ # The list of rich message responses to present to the user. |
| 2326 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 2327 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 2328 | }, |
| 2329 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 2330 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 2331 | "a_key": "", # Properties of the object. |
| 2332 | }, |
| 2333 | }, |
| 2334 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 2335 | "segments": [ # Segments this audio response is composed of. |
| 2336 | { # Represents one segment of audio. |
| 2337 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 2338 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 2339 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 2340 | }, |
| 2341 | ], |
| 2342 | }, |
| 2343 | "text": { # The text response message. # Returns a text response. |
| 2344 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2345 | "text": [ # Required. A collection of text responses. |
| 2346 | "A String", |
| 2347 | ], |
| 2348 | }, |
| 2349 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2350 | "a_key": "", # Properties of the object. |
| 2351 | }, |
| 2352 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2353 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2354 | "a_key": "", # Properties of the object. |
| 2355 | }, |
| 2356 | }, |
| 2357 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2358 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2359 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2360 | }, |
| 2361 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2362 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 2363 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2364 | "text": "A String", # The raw text to be synthesized. |
| 2365 | }, |
| 2366 | }, |
| 2367 | ], |
| 2368 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 2369 | { # Setting a parameter value. |
| 2370 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 2371 | "parameter": "A String", # Display name of the parameter. |
| 2372 | }, |
| 2373 | ], |
| 2374 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 2375 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 2376 | }, |
| 2377 | "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. |
| 2378 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 2379 | "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. |
| 2380 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 2381 | }, |
| 2382 | ], |
| 2383 | "displayName": "A String", # Required. The human-readable name of the page, unique within the agent. |
| 2384 | "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. |
| 2385 | "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. |
| 2386 | { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. |
| 2387 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 2388 | "event": "A String", # Required. The name of the event to handle. |
| 2389 | "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. |
| 2390 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 2391 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 2392 | "cases": [ # A list of cascading if-else conditions. |
| 2393 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 2394 | "caseContent": [ # A list of case content. |
| 2395 | { # The list of messages or conditional cases to activate for this case. |
| 2396 | "message": { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message. |
| 2397 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 2398 | }, |
| 2399 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 2400 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 2401 | "a_key": "", # Properties of the object. |
| 2402 | }, |
| 2403 | }, |
| 2404 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 2405 | "segments": [ # Segments this audio response is composed of. |
| 2406 | { # Represents one segment of audio. |
| 2407 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 2408 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 2409 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 2410 | }, |
| 2411 | ], |
| 2412 | }, |
| 2413 | "text": { # The text response message. # Returns a text response. |
| 2414 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2415 | "text": [ # Required. A collection of text responses. |
| 2416 | "A String", |
| 2417 | ], |
| 2418 | }, |
| 2419 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2420 | "a_key": "", # Properties of the object. |
| 2421 | }, |
| 2422 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2423 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2424 | "a_key": "", # Properties of the object. |
| 2425 | }, |
| 2426 | }, |
| 2427 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2428 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2429 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2430 | }, |
| 2431 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2432 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 2433 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2434 | "text": "A String", # The raw text to be synthesized. |
| 2435 | }, |
| 2436 | }, |
| 2437 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 2438 | }, |
| 2439 | ], |
| 2440 | "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). |
| 2441 | }, |
| 2442 | ], |
| 2443 | }, |
| 2444 | ], |
| 2445 | "messages": [ # The list of rich message responses to present to the user. |
| 2446 | { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. |
| 2447 | "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. |
| 2448 | }, |
| 2449 | "conversationSuccess": { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded. |
| 2450 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 2451 | "a_key": "", # Properties of the object. |
| 2452 | }, |
| 2453 | }, |
| 2454 | "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. |
| 2455 | "segments": [ # Segments this audio response is composed of. |
| 2456 | { # Represents one segment of audio. |
| 2457 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 2458 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 2459 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. |
| 2460 | }, |
| 2461 | ], |
| 2462 | }, |
| 2463 | "text": { # The text response message. # Returns a text response. |
| 2464 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2465 | "text": [ # Required. A collection of text responses. |
| 2466 | "A String", |
| 2467 | ], |
| 2468 | }, |
| 2469 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 2470 | "a_key": "", # Properties of the object. |
| 2471 | }, |
| 2472 | "liveAgentHandoff": { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent. |
| 2473 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 2474 | "a_key": "", # Properties of the object. |
| 2475 | }, |
| 2476 | }, |
| 2477 | "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. |
| 2478 | "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. |
| 2479 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2480 | }, |
| 2481 | "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. |
| 2482 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 2483 | "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. |
| 2484 | "text": "A String", # The raw text to be synthesized. |
| 2485 | }, |
| 2486 | }, |
| 2487 | ], |
| 2488 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 2489 | { # Setting a parameter value. |
| 2490 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 2491 | "parameter": "A String", # Display name of the parameter. |
| 2492 | }, |
| 2493 | ], |
| 2494 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 2495 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 2496 | }, |
| 2497 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 2498 | "name": "A String", # Output only. The unique identifier of this event handler. |
| 2499 | }, |
| 2500 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2501 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2502 | "triggerEvent": "A String", # If an event was provided as input, this field will contain a copy of the event name. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2503 | "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the trascript for the audio. |
| 2504 | "matches": [ # Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query. |
| 2505 | { # Represents one match result of MatchIntent. |
| 2506 | "event": "A String", # The event that matched the query. Only filled for `EVENT` match type. |
| 2507 | "confidence": 3.14, # The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. |
| 2508 | "matchType": "A String", # Type of this Match. |
| 2509 | "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. |
| 2510 | "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. |
| 2511 | "description": "A String", # Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
| 2512 | "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
| 2513 | "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. |
| 2514 | "priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| 2515 | "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. |
| 2516 | "parameters": [ # The collection of parameters associated with the intent. |
| 2517 | { # Represents an intent parameter. |
| 2518 | "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
| 2519 | "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| 2520 | "redact": True or False, # Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false. |
| 2521 | "isList": True or False, # Indicates whether the parameter represents a list of values. |
| 2522 | }, |
| 2523 | ], |
| 2524 | "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. |
| 2525 | { # Represents an example that the agent is trained on to identify the intent. |
| 2526 | "repeatCount": 42, # Indicates how many times this example was added to the intent. |
| 2527 | "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set. |
| 2528 | { # Represents a part of a training phrase. |
| 2529 | "text": "A String", # Required. The text for this part. |
| 2530 | "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. |
| 2531 | }, |
| 2532 | ], |
| 2533 | "id": "A String", # Output only. The unique identifier of the training phrase. |
| 2534 | }, |
| 2535 | ], |
| 2536 | "labels": { # Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. |
| 2537 | "a_key": "A String", |
| 2538 | }, |
| 2539 | }, |
| 2540 | "parameters": { # The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
| 2541 | "a_key": "", # Properties of the object. |
| 2542 | }, |
| 2543 | }, |
| 2544 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2545 | "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 2546 | "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 2547 | }</pre> |
| 2548 | </div> |
| 2549 | |
| 2550 | </body></html> |