| 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.flows.html">flows</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="dialogflow_v3beta1.projects.locations.agents.flows.pages.html">pages()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the pages Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html">transitionRouteGroups()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the transitionRouteGroups Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="dialogflow_v3beta1.projects.locations.agents.flows.versions.html">versions()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the versions Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#close">close()</a></code></p> |
| 94 | <p class="firstline">Close httplib2 connections.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#create">create(parent, body=None, languageCode=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Creates a flow in the specified agent.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Deletes a specified flow.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#get">get(name, languageCode=None, x__xgafv=None)</a></code></p> |
| 103 | <p class="firstline">Retrieves the specified flow.</p> |
| 104 | <p class="toc_element"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 105 | <code><a href="#list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | <p class="firstline">Returns the list of all flows in the specified agent.</p> |
| 107 | <p class="toc_element"> |
| 108 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 109 | <p class="firstline">Retrieves the next page of results.</p> |
| 110 | <p class="toc_element"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 111 | <code><a href="#patch">patch(name, body=None, updateMask=None, languageCode=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 112 | <p class="firstline">Updates the specified flow.</p> |
| 113 | <p class="toc_element"> |
| 114 | <code><a href="#train">train(name, body=None, x__xgafv=None)</a></code></p> |
| 115 | <p class="firstline">Trains the specified flow. Note that only the flow in 'draft' environment is trained.</p> |
| 116 | <h3>Method Details</h3> |
| 117 | <div class="method"> |
| 118 | <code class="details" id="close">close()</code> |
| 119 | <pre>Close httplib2 connections.</pre> |
| 120 | </div> |
| 121 | |
| 122 | <div class="method"> |
| 123 | <code class="details" id="create">create(parent, body=None, languageCode=None, x__xgafv=None)</code> |
| 124 | <pre>Creates a flow in the specified agent. |
| 125 | |
| 126 | Args: |
| 127 | parent: string, Required. The agent to create a flow for. Format: `projects//locations//agents/`. (required) |
| 128 | body: object, The request body. |
| 129 | The object takes the form of: |
| 130 | |
| 131 | { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 132 | "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. |
| 133 | "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. |
| 134 | { # 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. |
| 135 | "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. |
| 136 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 137 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 138 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 139 | "cases": [ # A list of cascading if-else conditions. |
| 140 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 141 | "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). |
| 142 | "caseContent": [ # A list of case content. |
| 143 | { # The list of messages or conditional cases to activate for this case. |
| 144 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 145 | "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. |
| 146 | "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. |
| 147 | "segments": [ # Segments this audio response is composed of. |
| 148 | { # Represents one segment of audio. |
| 149 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 150 | "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. |
| 151 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 152 | }, |
| 153 | ], |
| 154 | }, |
| 155 | "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. |
| 156 | "text": "A String", # The raw text to be synthesized. |
| 157 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 158 | "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. |
| 159 | }, |
| 160 | "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. |
| 161 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 162 | "a_key": "", # Properties of the object. |
| 163 | }, |
| 164 | }, |
| 165 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 166 | "a_key": "", # Properties of the object. |
| 167 | }, |
| 168 | "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. |
| 169 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 170 | "a_key": "", # Properties of the object. |
| 171 | }, |
| 172 | }, |
| 173 | "text": { # The text response message. # Returns a text response. |
| 174 | "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. |
| 175 | "text": [ # Required. A collection of text responses. |
| 176 | "A String", |
| 177 | ], |
| 178 | }, |
| 179 | "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. |
| 180 | "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. |
| 181 | "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. |
| 182 | }, |
| 183 | "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. |
| 184 | }, |
| 185 | }, |
| 186 | }, |
| 187 | ], |
| 188 | }, |
| 189 | ], |
| 190 | }, |
| 191 | ], |
| 192 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 193 | "messages": [ # The list of rich message responses to present to the user. |
| 194 | { # 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. |
| 195 | "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. |
| 196 | "segments": [ # Segments this audio response is composed of. |
| 197 | { # Represents one segment of audio. |
| 198 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 199 | "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. |
| 200 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 201 | }, |
| 202 | ], |
| 203 | }, |
| 204 | "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. |
| 205 | "text": "A String", # The raw text to be synthesized. |
| 206 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 207 | "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. |
| 208 | }, |
| 209 | "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. |
| 210 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 211 | "a_key": "", # Properties of the object. |
| 212 | }, |
| 213 | }, |
| 214 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 215 | "a_key": "", # Properties of the object. |
| 216 | }, |
| 217 | "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. |
| 218 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 219 | "a_key": "", # Properties of the object. |
| 220 | }, |
| 221 | }, |
| 222 | "text": { # The text response message. # Returns a text response. |
| 223 | "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. |
| 224 | "text": [ # Required. A collection of text responses. |
| 225 | "A String", |
| 226 | ], |
| 227 | }, |
| 228 | "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. |
| 229 | "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. |
| 230 | "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. |
| 231 | }, |
| 232 | "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. |
| 233 | }, |
| 234 | }, |
| 235 | ], |
| 236 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 237 | { # Setting a parameter value. |
| 238 | "parameter": "A String", # Display name of the parameter. |
| 239 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 240 | }, |
| 241 | ], |
| 242 | }, |
| 243 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 244 | "event": "A String", # Required. The name of the event to handle. |
| 245 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 246 | "name": "A String", # Output only. The unique identifier of this event handler. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 247 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 248 | ], |
| 249 | "displayName": "A String", # Required. The human-readable name of the flow. |
| 250 | "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. |
| 251 | "modelTrainingMode": "A String", # Indicates NLU model training mode. |
| 252 | "modelType": "A String", # Indicates the type of NLU model. |
| 253 | "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. |
| 254 | }, |
| 255 | "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. |
| 256 | "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified.. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. |
| 257 | { # 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. |
| 258 | "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. |
| 259 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 260 | "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. |
| 261 | "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. |
| 262 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 263 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 264 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 265 | "cases": [ # A list of cascading if-else conditions. |
| 266 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 267 | "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). |
| 268 | "caseContent": [ # A list of case content. |
| 269 | { # The list of messages or conditional cases to activate for this case. |
| 270 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 271 | "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. |
| 272 | "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. |
| 273 | "segments": [ # Segments this audio response is composed of. |
| 274 | { # Represents one segment of audio. |
| 275 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 276 | "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. |
| 277 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 278 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 279 | ], |
| 280 | }, |
| 281 | "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. |
| 282 | "text": "A String", # The raw text to be synthesized. |
| 283 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 284 | "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. |
| 285 | }, |
| 286 | "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. |
| 287 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 288 | "a_key": "", # Properties of the object. |
| 289 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 290 | }, |
| 291 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 292 | "a_key": "", # Properties of the object. |
| 293 | }, |
| 294 | "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. |
| 295 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 296 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 297 | }, |
| 298 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 299 | "text": { # The text response message. # Returns a text response. |
| 300 | "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. |
| 301 | "text": [ # Required. A collection of text responses. |
| 302 | "A String", |
| 303 | ], |
| 304 | }, |
| 305 | "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. |
| 306 | "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. |
| 307 | "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. |
| 308 | }, |
| 309 | "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. |
| 310 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 311 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 312 | }, |
| 313 | ], |
| 314 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 315 | ], |
| 316 | }, |
| 317 | ], |
| 318 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 319 | "messages": [ # The list of rich message responses to present to the user. |
| 320 | { # 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. |
| 321 | "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. |
| 322 | "segments": [ # Segments this audio response is composed of. |
| 323 | { # Represents one segment of audio. |
| 324 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 325 | "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. |
| 326 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 327 | }, |
| 328 | ], |
| 329 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 330 | "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. |
| 331 | "text": "A String", # The raw text to be synthesized. |
| 332 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 333 | "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 | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 334 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 335 | "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. |
| 336 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 337 | "a_key": "", # Properties of the object. |
| 338 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 339 | }, |
| 340 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 341 | "a_key": "", # Properties of the object. |
| 342 | }, |
| 343 | "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. |
| 344 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 345 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 346 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 347 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 348 | "text": { # The text response message. # Returns a text response. |
| 349 | "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. |
| 350 | "text": [ # Required. A collection of text responses. |
| 351 | "A String", |
| 352 | ], |
| 353 | }, |
| 354 | "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. |
| 355 | "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. |
| 356 | "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. |
| 357 | }, |
| 358 | "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. |
| 359 | }, |
| 360 | }, |
| 361 | ], |
| 362 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 363 | { # Setting a parameter value. |
| 364 | "parameter": "A String", # Display name of the parameter. |
| 365 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 366 | }, |
| 367 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 368 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 369 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 370 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 371 | }, |
| 372 | ], |
| 373 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 374 | |
| 375 | languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. |
| 376 | x__xgafv: string, V1 error format. |
| 377 | Allowed values |
| 378 | 1 - v1 error format |
| 379 | 2 - v2 error format |
| 380 | |
| 381 | Returns: |
| 382 | An object of the form: |
| 383 | |
| 384 | { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 385 | "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. |
| 386 | "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. |
| 387 | { # 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. |
| 388 | "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. |
| 389 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 390 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 391 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 392 | "cases": [ # A list of cascading if-else conditions. |
| 393 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 394 | "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). |
| 395 | "caseContent": [ # A list of case content. |
| 396 | { # The list of messages or conditional cases to activate for this case. |
| 397 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 398 | "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. |
| 399 | "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. |
| 400 | "segments": [ # Segments this audio response is composed of. |
| 401 | { # Represents one segment of audio. |
| 402 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 403 | "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. |
| 404 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 405 | }, |
| 406 | ], |
| 407 | }, |
| 408 | "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. |
| 409 | "text": "A String", # The raw text to be synthesized. |
| 410 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 411 | "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. |
| 412 | }, |
| 413 | "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. |
| 414 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 415 | "a_key": "", # Properties of the object. |
| 416 | }, |
| 417 | }, |
| 418 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 419 | "a_key": "", # Properties of the object. |
| 420 | }, |
| 421 | "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. |
| 422 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 423 | "a_key": "", # Properties of the object. |
| 424 | }, |
| 425 | }, |
| 426 | "text": { # The text response message. # Returns a text response. |
| 427 | "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. |
| 428 | "text": [ # Required. A collection of text responses. |
| 429 | "A String", |
| 430 | ], |
| 431 | }, |
| 432 | "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. |
| 433 | "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. |
| 434 | "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. |
| 435 | }, |
| 436 | "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. |
| 437 | }, |
| 438 | }, |
| 439 | }, |
| 440 | ], |
| 441 | }, |
| 442 | ], |
| 443 | }, |
| 444 | ], |
| 445 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 446 | "messages": [ # The list of rich message responses to present to the user. |
| 447 | { # 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. |
| 448 | "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. |
| 449 | "segments": [ # Segments this audio response is composed of. |
| 450 | { # Represents one segment of audio. |
| 451 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 452 | "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. |
| 453 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 454 | }, |
| 455 | ], |
| 456 | }, |
| 457 | "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. |
| 458 | "text": "A String", # The raw text to be synthesized. |
| 459 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 460 | "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. |
| 461 | }, |
| 462 | "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. |
| 463 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 464 | "a_key": "", # Properties of the object. |
| 465 | }, |
| 466 | }, |
| 467 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 468 | "a_key": "", # Properties of the object. |
| 469 | }, |
| 470 | "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. |
| 471 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 472 | "a_key": "", # Properties of the object. |
| 473 | }, |
| 474 | }, |
| 475 | "text": { # The text response message. # Returns a text response. |
| 476 | "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. |
| 477 | "text": [ # Required. A collection of text responses. |
| 478 | "A String", |
| 479 | ], |
| 480 | }, |
| 481 | "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. |
| 482 | "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. |
| 483 | "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. |
| 484 | }, |
| 485 | "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. |
| 486 | }, |
| 487 | }, |
| 488 | ], |
| 489 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 490 | { # Setting a parameter value. |
| 491 | "parameter": "A String", # Display name of the parameter. |
| 492 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 493 | }, |
| 494 | ], |
| 495 | }, |
| 496 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 497 | "event": "A String", # Required. The name of the event to handle. |
| 498 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 499 | "name": "A String", # Output only. The unique identifier of this event handler. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 500 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 501 | ], |
| 502 | "displayName": "A String", # Required. The human-readable name of the flow. |
| 503 | "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. |
| 504 | "modelTrainingMode": "A String", # Indicates NLU model training mode. |
| 505 | "modelType": "A String", # Indicates the type of NLU model. |
| 506 | "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. |
| 507 | }, |
| 508 | "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. |
| 509 | "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified.. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. |
| 510 | { # 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. |
| 511 | "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. |
| 512 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 513 | "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. |
| 514 | "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. |
| 515 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 516 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 517 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 518 | "cases": [ # A list of cascading if-else conditions. |
| 519 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 520 | "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). |
| 521 | "caseContent": [ # A list of case content. |
| 522 | { # The list of messages or conditional cases to activate for this case. |
| 523 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 524 | "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. |
| 525 | "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. |
| 526 | "segments": [ # Segments this audio response is composed of. |
| 527 | { # Represents one segment of audio. |
| 528 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 529 | "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. |
| 530 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 531 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 532 | ], |
| 533 | }, |
| 534 | "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. |
| 535 | "text": "A String", # The raw text to be synthesized. |
| 536 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 537 | "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. |
| 538 | }, |
| 539 | "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. |
| 540 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 541 | "a_key": "", # Properties of the object. |
| 542 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 543 | }, |
| 544 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 545 | "a_key": "", # Properties of the object. |
| 546 | }, |
| 547 | "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. |
| 548 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 549 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 550 | }, |
| 551 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 552 | "text": { # The text response message. # Returns a text response. |
| 553 | "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. |
| 554 | "text": [ # Required. A collection of text responses. |
| 555 | "A String", |
| 556 | ], |
| 557 | }, |
| 558 | "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. |
| 559 | "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. |
| 560 | "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. |
| 561 | }, |
| 562 | "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. |
| 563 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 564 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 565 | }, |
| 566 | ], |
| 567 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 568 | ], |
| 569 | }, |
| 570 | ], |
| 571 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 572 | "messages": [ # The list of rich message responses to present to the user. |
| 573 | { # 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. |
| 574 | "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. |
| 575 | "segments": [ # Segments this audio response is composed of. |
| 576 | { # Represents one segment of audio. |
| 577 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 578 | "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. |
| 579 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 580 | }, |
| 581 | ], |
| 582 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 583 | "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. |
| 584 | "text": "A String", # The raw text to be synthesized. |
| 585 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 586 | "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 | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 587 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 588 | "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. |
| 589 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 590 | "a_key": "", # Properties of the object. |
| 591 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 592 | }, |
| 593 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 594 | "a_key": "", # Properties of the object. |
| 595 | }, |
| 596 | "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. |
| 597 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 598 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 599 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 600 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 601 | "text": { # The text response message. # Returns a text response. |
| 602 | "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. |
| 603 | "text": [ # Required. A collection of text responses. |
| 604 | "A String", |
| 605 | ], |
| 606 | }, |
| 607 | "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. |
| 608 | "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. |
| 609 | "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. |
| 610 | }, |
| 611 | "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. |
| 612 | }, |
| 613 | }, |
| 614 | ], |
| 615 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 616 | { # Setting a parameter value. |
| 617 | "parameter": "A String", # Display name of the parameter. |
| 618 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 619 | }, |
| 620 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 621 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 622 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 623 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 624 | }, |
| 625 | ], |
| 626 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 627 | </div> |
| 628 | |
| 629 | <div class="method"> |
| 630 | <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code> |
| 631 | <pre>Deletes a specified flow. |
| 632 | |
| 633 | Args: |
| 634 | name: string, Required. The name of the flow to delete. Format: `projects//locations//agents//flows/`. (required) |
| 635 | force: boolean, This field has no effect for flows with no incoming transitions. For flows with incoming transitions: * If `force` is set to false, an error will be returned with message indicating the incoming transitions. * If `force` is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared). |
| 636 | x__xgafv: string, V1 error format. |
| 637 | Allowed values |
| 638 | 1 - v1 error format |
| 639 | 2 - v2 error format |
| 640 | |
| 641 | Returns: |
| 642 | An object of the form: |
| 643 | |
| 644 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| 645 | }</pre> |
| 646 | </div> |
| 647 | |
| 648 | <div class="method"> |
| 649 | <code class="details" id="get">get(name, languageCode=None, x__xgafv=None)</code> |
| 650 | <pre>Retrieves the specified flow. |
| 651 | |
| 652 | Args: |
| 653 | name: string, Required. The name of the flow to get. Format: `projects//locations//agents//flows/`. (required) |
| 654 | languageCode: string, The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. |
| 655 | x__xgafv: string, V1 error format. |
| 656 | Allowed values |
| 657 | 1 - v1 error format |
| 658 | 2 - v2 error format |
| 659 | |
| 660 | Returns: |
| 661 | An object of the form: |
| 662 | |
| 663 | { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 664 | "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. |
| 665 | "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. |
| 666 | { # 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. |
| 667 | "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. |
| 668 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 669 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 670 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 671 | "cases": [ # A list of cascading if-else conditions. |
| 672 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 673 | "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). |
| 674 | "caseContent": [ # A list of case content. |
| 675 | { # The list of messages or conditional cases to activate for this case. |
| 676 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 677 | "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. |
| 678 | "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. |
| 679 | "segments": [ # Segments this audio response is composed of. |
| 680 | { # Represents one segment of audio. |
| 681 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 682 | "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. |
| 683 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 684 | }, |
| 685 | ], |
| 686 | }, |
| 687 | "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. |
| 688 | "text": "A String", # The raw text to be synthesized. |
| 689 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 690 | "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. |
| 691 | }, |
| 692 | "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. |
| 693 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 694 | "a_key": "", # Properties of the object. |
| 695 | }, |
| 696 | }, |
| 697 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 698 | "a_key": "", # Properties of the object. |
| 699 | }, |
| 700 | "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. |
| 701 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 702 | "a_key": "", # Properties of the object. |
| 703 | }, |
| 704 | }, |
| 705 | "text": { # The text response message. # Returns a text response. |
| 706 | "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. |
| 707 | "text": [ # Required. A collection of text responses. |
| 708 | "A String", |
| 709 | ], |
| 710 | }, |
| 711 | "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. |
| 712 | "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. |
| 713 | "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. |
| 714 | }, |
| 715 | "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. |
| 716 | }, |
| 717 | }, |
| 718 | }, |
| 719 | ], |
| 720 | }, |
| 721 | ], |
| 722 | }, |
| 723 | ], |
| 724 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 725 | "messages": [ # The list of rich message responses to present to the user. |
| 726 | { # 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. |
| 727 | "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. |
| 728 | "segments": [ # Segments this audio response is composed of. |
| 729 | { # Represents one segment of audio. |
| 730 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 731 | "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. |
| 732 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 733 | }, |
| 734 | ], |
| 735 | }, |
| 736 | "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. |
| 737 | "text": "A String", # The raw text to be synthesized. |
| 738 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 739 | "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. |
| 740 | }, |
| 741 | "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. |
| 742 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 743 | "a_key": "", # Properties of the object. |
| 744 | }, |
| 745 | }, |
| 746 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 747 | "a_key": "", # Properties of the object. |
| 748 | }, |
| 749 | "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. |
| 750 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 751 | "a_key": "", # Properties of the object. |
| 752 | }, |
| 753 | }, |
| 754 | "text": { # The text response message. # Returns a text response. |
| 755 | "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. |
| 756 | "text": [ # Required. A collection of text responses. |
| 757 | "A String", |
| 758 | ], |
| 759 | }, |
| 760 | "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. |
| 761 | "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. |
| 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 | }, |
| 764 | "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. |
| 765 | }, |
| 766 | }, |
| 767 | ], |
| 768 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 769 | { # Setting a parameter value. |
| 770 | "parameter": "A String", # Display name of the parameter. |
| 771 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 772 | }, |
| 773 | ], |
| 774 | }, |
| 775 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 776 | "event": "A String", # Required. The name of the event to handle. |
| 777 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 778 | "name": "A String", # Output only. The unique identifier of this event handler. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 779 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 780 | ], |
| 781 | "displayName": "A String", # Required. The human-readable name of the flow. |
| 782 | "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. |
| 783 | "modelTrainingMode": "A String", # Indicates NLU model training mode. |
| 784 | "modelType": "A String", # Indicates the type of NLU model. |
| 785 | "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. |
| 786 | }, |
| 787 | "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. |
| 788 | "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified.. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. |
| 789 | { # 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. |
| 790 | "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. |
| 791 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 792 | "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. |
| 793 | "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. |
| 794 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 795 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 796 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 797 | "cases": [ # A list of cascading if-else conditions. |
| 798 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 799 | "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). |
| 800 | "caseContent": [ # A list of case content. |
| 801 | { # The list of messages or conditional cases to activate for this case. |
| 802 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 803 | "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. |
| 804 | "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. |
| 805 | "segments": [ # Segments this audio response is composed of. |
| 806 | { # Represents one segment of audio. |
| 807 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 808 | "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. |
| 809 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 810 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 811 | ], |
| 812 | }, |
| 813 | "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. |
| 814 | "text": "A String", # The raw text to be synthesized. |
| 815 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 816 | "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. |
| 817 | }, |
| 818 | "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. |
| 819 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 820 | "a_key": "", # Properties of the object. |
| 821 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 822 | }, |
| 823 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 824 | "a_key": "", # Properties of the object. |
| 825 | }, |
| 826 | "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. |
| 827 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 828 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 829 | }, |
| 830 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 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 | "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. |
| 838 | "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. |
| 839 | "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. |
| 840 | }, |
| 841 | "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. |
| 842 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 843 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 844 | }, |
| 845 | ], |
| 846 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 847 | ], |
| 848 | }, |
| 849 | ], |
| 850 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 851 | "messages": [ # The list of rich message responses to present to the user. |
| 852 | { # 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. |
| 853 | "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. |
| 854 | "segments": [ # Segments this audio response is composed of. |
| 855 | { # Represents one segment of audio. |
| 856 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 857 | "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. |
| 858 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 859 | }, |
| 860 | ], |
| 861 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 862 | "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. |
| 863 | "text": "A String", # The raw text to be synthesized. |
| 864 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 865 | "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 | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 866 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 867 | "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. |
| 868 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 869 | "a_key": "", # Properties of the object. |
| 870 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 871 | }, |
| 872 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 873 | "a_key": "", # Properties of the object. |
| 874 | }, |
| 875 | "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. |
| 876 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 877 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 878 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 879 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 880 | "text": { # The text response message. # Returns a text response. |
| 881 | "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. |
| 882 | "text": [ # Required. A collection of text responses. |
| 883 | "A String", |
| 884 | ], |
| 885 | }, |
| 886 | "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. |
| 887 | "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. |
| 888 | "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. |
| 889 | }, |
| 890 | "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. |
| 891 | }, |
| 892 | }, |
| 893 | ], |
| 894 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 895 | { # Setting a parameter value. |
| 896 | "parameter": "A String", # Display name of the parameter. |
| 897 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 898 | }, |
| 899 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 900 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 901 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 902 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 903 | }, |
| 904 | ], |
| 905 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 906 | </div> |
| 907 | |
| 908 | <div class="method"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 909 | <code class="details" id="list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 910 | <pre>Returns the list of all flows in the specified agent. |
| 911 | |
| 912 | Args: |
| 913 | parent: string, Required. The agent containing the flows. Format: `projects//locations//agents/`. (required) |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 914 | languageCode: string, The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 915 | pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 916 | pageToken: string, The next_page_token value returned from a previous list request. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 917 | x__xgafv: string, V1 error format. |
| 918 | Allowed values |
| 919 | 1 - v1 error format |
| 920 | 2 - v2 error format |
| 921 | |
| 922 | Returns: |
| 923 | An object of the form: |
| 924 | |
| 925 | { # The response message for Flows.ListFlows. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 926 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 927 | "flows": [ # The list of flows. There will be a maximum number of items returned based on the page_size field in the request. |
| 928 | { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 929 | "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. |
| 930 | "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. |
| 931 | { # 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. |
| 932 | "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. |
| 933 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 934 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 935 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 936 | "cases": [ # A list of cascading if-else conditions. |
| 937 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 938 | "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). |
| 939 | "caseContent": [ # A list of case content. |
| 940 | { # The list of messages or conditional cases to activate for this case. |
| 941 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 942 | "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. |
| 943 | "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. |
| 944 | "segments": [ # Segments this audio response is composed of. |
| 945 | { # Represents one segment of audio. |
| 946 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 947 | "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. |
| 948 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 949 | }, |
| 950 | ], |
| 951 | }, |
| 952 | "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. |
| 953 | "text": "A String", # The raw text to be synthesized. |
| 954 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 955 | "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. |
| 956 | }, |
| 957 | "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. |
| 958 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 959 | "a_key": "", # Properties of the object. |
| 960 | }, |
| 961 | }, |
| 962 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 963 | "a_key": "", # Properties of the object. |
| 964 | }, |
| 965 | "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. |
| 966 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 967 | "a_key": "", # Properties of the object. |
| 968 | }, |
| 969 | }, |
| 970 | "text": { # The text response message. # Returns a text response. |
| 971 | "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. |
| 972 | "text": [ # Required. A collection of text responses. |
| 973 | "A String", |
| 974 | ], |
| 975 | }, |
| 976 | "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. |
| 977 | "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. |
| 978 | "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. |
| 979 | }, |
| 980 | "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. |
| 981 | }, |
| 982 | }, |
| 983 | }, |
| 984 | ], |
| 985 | }, |
| 986 | ], |
| 987 | }, |
| 988 | ], |
| 989 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 990 | "messages": [ # The list of rich message responses to present to the user. |
| 991 | { # 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. |
| 992 | "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. |
| 993 | "segments": [ # Segments this audio response is composed of. |
| 994 | { # Represents one segment of audio. |
| 995 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 996 | "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. |
| 997 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 998 | }, |
| 999 | ], |
| 1000 | }, |
| 1001 | "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. |
| 1002 | "text": "A String", # The raw text to be synthesized. |
| 1003 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1004 | "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. |
| 1005 | }, |
| 1006 | "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. |
| 1007 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1008 | "a_key": "", # Properties of the object. |
| 1009 | }, |
| 1010 | }, |
| 1011 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1012 | "a_key": "", # Properties of the object. |
| 1013 | }, |
| 1014 | "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. |
| 1015 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1016 | "a_key": "", # Properties of the object. |
| 1017 | }, |
| 1018 | }, |
| 1019 | "text": { # The text response message. # Returns a text response. |
| 1020 | "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. |
| 1021 | "text": [ # Required. A collection of text responses. |
| 1022 | "A String", |
| 1023 | ], |
| 1024 | }, |
| 1025 | "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. |
| 1026 | "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. |
| 1027 | "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. |
| 1028 | }, |
| 1029 | "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. |
| 1030 | }, |
| 1031 | }, |
| 1032 | ], |
| 1033 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1034 | { # Setting a parameter value. |
| 1035 | "parameter": "A String", # Display name of the parameter. |
| 1036 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1037 | }, |
| 1038 | ], |
| 1039 | }, |
| 1040 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1041 | "event": "A String", # Required. The name of the event to handle. |
| 1042 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1043 | "name": "A String", # Output only. The unique identifier of this event handler. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1044 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1045 | ], |
| 1046 | "displayName": "A String", # Required. The human-readable name of the flow. |
| 1047 | "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. |
| 1048 | "modelTrainingMode": "A String", # Indicates NLU model training mode. |
| 1049 | "modelType": "A String", # Indicates the type of NLU model. |
| 1050 | "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1051 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1052 | "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. |
| 1053 | "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified.. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. |
| 1054 | { # 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. |
| 1055 | "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. |
| 1056 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 1057 | "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. |
| 1058 | "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. |
| 1059 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1060 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1061 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1062 | "cases": [ # A list of cascading if-else conditions. |
| 1063 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1064 | "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). |
| 1065 | "caseContent": [ # A list of case content. |
| 1066 | { # The list of messages or conditional cases to activate for this case. |
| 1067 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1068 | "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. |
| 1069 | "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. |
| 1070 | "segments": [ # Segments this audio response is composed of. |
| 1071 | { # Represents one segment of audio. |
| 1072 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1073 | "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. |
| 1074 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1075 | }, |
| 1076 | ], |
| 1077 | }, |
| 1078 | "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. |
| 1079 | "text": "A String", # The raw text to be synthesized. |
| 1080 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1081 | "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. |
| 1082 | }, |
| 1083 | "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. |
| 1084 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1085 | "a_key": "", # Properties of the object. |
| 1086 | }, |
| 1087 | }, |
| 1088 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1089 | "a_key": "", # Properties of the object. |
| 1090 | }, |
| 1091 | "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. |
| 1092 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1093 | "a_key": "", # Properties of the object. |
| 1094 | }, |
| 1095 | }, |
| 1096 | "text": { # The text response message. # Returns a text response. |
| 1097 | "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. |
| 1098 | "text": [ # Required. A collection of text responses. |
| 1099 | "A String", |
| 1100 | ], |
| 1101 | }, |
| 1102 | "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. |
| 1103 | "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. |
| 1104 | "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. |
| 1105 | }, |
| 1106 | "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. |
| 1107 | }, |
| 1108 | }, |
| 1109 | }, |
| 1110 | ], |
| 1111 | }, |
| 1112 | ], |
| 1113 | }, |
| 1114 | ], |
| 1115 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1116 | "messages": [ # The list of rich message responses to present to the user. |
| 1117 | { # 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. |
| 1118 | "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. |
| 1119 | "segments": [ # Segments this audio response is composed of. |
| 1120 | { # Represents one segment of audio. |
| 1121 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1122 | "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. |
| 1123 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1124 | }, |
| 1125 | ], |
| 1126 | }, |
| 1127 | "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. |
| 1128 | "text": "A String", # The raw text to be synthesized. |
| 1129 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1130 | "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. |
| 1131 | }, |
| 1132 | "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. |
| 1133 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1134 | "a_key": "", # Properties of the object. |
| 1135 | }, |
| 1136 | }, |
| 1137 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1138 | "a_key": "", # Properties of the object. |
| 1139 | }, |
| 1140 | "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. |
| 1141 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1142 | "a_key": "", # Properties of the object. |
| 1143 | }, |
| 1144 | }, |
| 1145 | "text": { # The text response message. # Returns a text response. |
| 1146 | "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. |
| 1147 | "text": [ # Required. A collection of text responses. |
| 1148 | "A String", |
| 1149 | ], |
| 1150 | }, |
| 1151 | "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. |
| 1152 | "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. |
| 1153 | "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. |
| 1154 | }, |
| 1155 | "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. |
| 1156 | }, |
| 1157 | }, |
| 1158 | ], |
| 1159 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1160 | { # Setting a parameter value. |
| 1161 | "parameter": "A String", # Display name of the parameter. |
| 1162 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1163 | }, |
| 1164 | ], |
| 1165 | }, |
| 1166 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1167 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1168 | }, |
| 1169 | ], |
| 1170 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1171 | ], |
| 1172 | }</pre> |
| 1173 | </div> |
| 1174 | |
| 1175 | <div class="method"> |
| 1176 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1177 | <pre>Retrieves the next page of results. |
| 1178 | |
| 1179 | Args: |
| 1180 | previous_request: The request for the previous page. (required) |
| 1181 | previous_response: The response from the request for the previous page. (required) |
| 1182 | |
| 1183 | Returns: |
| 1184 | A request object that you can call 'execute()' on to request the next |
| 1185 | page. Returns None if there are no more items in the collection. |
| 1186 | </pre> |
| 1187 | </div> |
| 1188 | |
| 1189 | <div class="method"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1190 | <code class="details" id="patch">patch(name, body=None, updateMask=None, languageCode=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1191 | <pre>Updates the specified flow. |
| 1192 | |
| 1193 | Args: |
| 1194 | name: string, The unique identifier of the flow. Format: `projects//locations//agents//flows/`. (required) |
| 1195 | body: object, The request body. |
| 1196 | The object takes the form of: |
| 1197 | |
| 1198 | { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1199 | "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. |
| 1200 | "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. |
| 1201 | { # 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. |
| 1202 | "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. |
| 1203 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1204 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1205 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1206 | "cases": [ # A list of cascading if-else conditions. |
| 1207 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1208 | "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). |
| 1209 | "caseContent": [ # A list of case content. |
| 1210 | { # The list of messages or conditional cases to activate for this case. |
| 1211 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1212 | "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. |
| 1213 | "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. |
| 1214 | "segments": [ # Segments this audio response is composed of. |
| 1215 | { # Represents one segment of audio. |
| 1216 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1217 | "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. |
| 1218 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1219 | }, |
| 1220 | ], |
| 1221 | }, |
| 1222 | "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. |
| 1223 | "text": "A String", # The raw text to be synthesized. |
| 1224 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1225 | "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. |
| 1226 | }, |
| 1227 | "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. |
| 1228 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1229 | "a_key": "", # Properties of the object. |
| 1230 | }, |
| 1231 | }, |
| 1232 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1233 | "a_key": "", # Properties of the object. |
| 1234 | }, |
| 1235 | "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. |
| 1236 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1237 | "a_key": "", # Properties of the object. |
| 1238 | }, |
| 1239 | }, |
| 1240 | "text": { # The text response message. # Returns a text response. |
| 1241 | "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. |
| 1242 | "text": [ # Required. A collection of text responses. |
| 1243 | "A String", |
| 1244 | ], |
| 1245 | }, |
| 1246 | "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. |
| 1247 | "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. |
| 1248 | "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. |
| 1249 | }, |
| 1250 | "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. |
| 1251 | }, |
| 1252 | }, |
| 1253 | }, |
| 1254 | ], |
| 1255 | }, |
| 1256 | ], |
| 1257 | }, |
| 1258 | ], |
| 1259 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1260 | "messages": [ # The list of rich message responses to present to the user. |
| 1261 | { # 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. |
| 1262 | "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. |
| 1263 | "segments": [ # Segments this audio response is composed of. |
| 1264 | { # Represents one segment of audio. |
| 1265 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1266 | "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. |
| 1267 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1268 | }, |
| 1269 | ], |
| 1270 | }, |
| 1271 | "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. |
| 1272 | "text": "A String", # The raw text to be synthesized. |
| 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 | }, |
| 1276 | "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. |
| 1277 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1278 | "a_key": "", # Properties of the object. |
| 1279 | }, |
| 1280 | }, |
| 1281 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1282 | "a_key": "", # Properties of the object. |
| 1283 | }, |
| 1284 | "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. |
| 1285 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1286 | "a_key": "", # Properties of the object. |
| 1287 | }, |
| 1288 | }, |
| 1289 | "text": { # The text response message. # Returns a text response. |
| 1290 | "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. |
| 1291 | "text": [ # Required. A collection of text responses. |
| 1292 | "A String", |
| 1293 | ], |
| 1294 | }, |
| 1295 | "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. |
| 1296 | "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. |
| 1297 | "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. |
| 1298 | }, |
| 1299 | "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. |
| 1300 | }, |
| 1301 | }, |
| 1302 | ], |
| 1303 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1304 | { # Setting a parameter value. |
| 1305 | "parameter": "A String", # Display name of the parameter. |
| 1306 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1307 | }, |
| 1308 | ], |
| 1309 | }, |
| 1310 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1311 | "event": "A String", # Required. The name of the event to handle. |
| 1312 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1313 | "name": "A String", # Output only. The unique identifier of this event handler. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1314 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1315 | ], |
| 1316 | "displayName": "A String", # Required. The human-readable name of the flow. |
| 1317 | "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. |
| 1318 | "modelTrainingMode": "A String", # Indicates NLU model training mode. |
| 1319 | "modelType": "A String", # Indicates the type of NLU model. |
| 1320 | "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. |
| 1321 | }, |
| 1322 | "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. |
| 1323 | "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified.. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. |
| 1324 | { # 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. |
| 1325 | "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. |
| 1326 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 1327 | "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. |
| 1328 | "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. |
| 1329 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1330 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1331 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1332 | "cases": [ # A list of cascading if-else conditions. |
| 1333 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1334 | "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). |
| 1335 | "caseContent": [ # A list of case content. |
| 1336 | { # The list of messages or conditional cases to activate for this case. |
| 1337 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1338 | "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. |
| 1339 | "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. |
| 1340 | "segments": [ # Segments this audio response is composed of. |
| 1341 | { # Represents one segment of audio. |
| 1342 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1343 | "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. |
| 1344 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1345 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1346 | ], |
| 1347 | }, |
| 1348 | "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. |
| 1349 | "text": "A String", # The raw text to be synthesized. |
| 1350 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1351 | "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. |
| 1352 | }, |
| 1353 | "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. |
| 1354 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1355 | "a_key": "", # Properties of the object. |
| 1356 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1357 | }, |
| 1358 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1359 | "a_key": "", # Properties of the object. |
| 1360 | }, |
| 1361 | "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. |
| 1362 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1363 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1364 | }, |
| 1365 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 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 | "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. |
| 1373 | "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. |
| 1374 | "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. |
| 1375 | }, |
| 1376 | "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. |
| 1377 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1378 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1379 | }, |
| 1380 | ], |
| 1381 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1382 | ], |
| 1383 | }, |
| 1384 | ], |
| 1385 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1386 | "messages": [ # The list of rich message responses to present to the user. |
| 1387 | { # 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. |
| 1388 | "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. |
| 1389 | "segments": [ # Segments this audio response is composed of. |
| 1390 | { # Represents one segment of audio. |
| 1391 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1392 | "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. |
| 1393 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1394 | }, |
| 1395 | ], |
| 1396 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1397 | "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. |
| 1398 | "text": "A String", # The raw text to be synthesized. |
| 1399 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1400 | "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 | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1401 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1402 | "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. |
| 1403 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1404 | "a_key": "", # Properties of the object. |
| 1405 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1406 | }, |
| 1407 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1408 | "a_key": "", # Properties of the object. |
| 1409 | }, |
| 1410 | "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. |
| 1411 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1412 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1413 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1414 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1415 | "text": { # The text response message. # Returns a text response. |
| 1416 | "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. |
| 1417 | "text": [ # Required. A collection of text responses. |
| 1418 | "A String", |
| 1419 | ], |
| 1420 | }, |
| 1421 | "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. |
| 1422 | "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. |
| 1423 | "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. |
| 1424 | }, |
| 1425 | "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. |
| 1426 | }, |
| 1427 | }, |
| 1428 | ], |
| 1429 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1430 | { # Setting a parameter value. |
| 1431 | "parameter": "A String", # Display name of the parameter. |
| 1432 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1433 | }, |
| 1434 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1435 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1436 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1437 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1438 | }, |
| 1439 | ], |
| 1440 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1441 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1442 | updateMask: string, Required. The mask to control which fields get updated. If `update_mask` is not specified, an error will be returned. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1443 | languageCode: string, The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1444 | x__xgafv: string, V1 error format. |
| 1445 | Allowed values |
| 1446 | 1 - v1 error format |
| 1447 | 2 - v2 error format |
| 1448 | |
| 1449 | Returns: |
| 1450 | An object of the form: |
| 1451 | |
| 1452 | { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1453 | "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. |
| 1454 | "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. |
| 1455 | { # 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. |
| 1456 | "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. |
| 1457 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1458 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1459 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1460 | "cases": [ # A list of cascading if-else conditions. |
| 1461 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1462 | "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). |
| 1463 | "caseContent": [ # A list of case content. |
| 1464 | { # The list of messages or conditional cases to activate for this case. |
| 1465 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1466 | "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. |
| 1467 | "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. |
| 1468 | "segments": [ # Segments this audio response is composed of. |
| 1469 | { # Represents one segment of audio. |
| 1470 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1471 | "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. |
| 1472 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1473 | }, |
| 1474 | ], |
| 1475 | }, |
| 1476 | "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. |
| 1477 | "text": "A String", # The raw text to be synthesized. |
| 1478 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1479 | "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. |
| 1480 | }, |
| 1481 | "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. |
| 1482 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1483 | "a_key": "", # Properties of the object. |
| 1484 | }, |
| 1485 | }, |
| 1486 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1487 | "a_key": "", # Properties of the object. |
| 1488 | }, |
| 1489 | "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. |
| 1490 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1491 | "a_key": "", # Properties of the object. |
| 1492 | }, |
| 1493 | }, |
| 1494 | "text": { # The text response message. # Returns a text response. |
| 1495 | "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. |
| 1496 | "text": [ # Required. A collection of text responses. |
| 1497 | "A String", |
| 1498 | ], |
| 1499 | }, |
| 1500 | "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. |
| 1501 | "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. |
| 1502 | "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. |
| 1503 | }, |
| 1504 | "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. |
| 1505 | }, |
| 1506 | }, |
| 1507 | }, |
| 1508 | ], |
| 1509 | }, |
| 1510 | ], |
| 1511 | }, |
| 1512 | ], |
| 1513 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1514 | "messages": [ # The list of rich message responses to present to the user. |
| 1515 | { # 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. |
| 1516 | "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. |
| 1517 | "segments": [ # Segments this audio response is composed of. |
| 1518 | { # Represents one segment of audio. |
| 1519 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1520 | "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. |
| 1521 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| 1522 | }, |
| 1523 | ], |
| 1524 | }, |
| 1525 | "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. |
| 1526 | "text": "A String", # The raw text to be synthesized. |
| 1527 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1528 | "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. |
| 1529 | }, |
| 1530 | "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. |
| 1531 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| 1532 | "a_key": "", # Properties of the object. |
| 1533 | }, |
| 1534 | }, |
| 1535 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1536 | "a_key": "", # Properties of the object. |
| 1537 | }, |
| 1538 | "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. |
| 1539 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1540 | "a_key": "", # Properties of the object. |
| 1541 | }, |
| 1542 | }, |
| 1543 | "text": { # The text response message. # Returns a text response. |
| 1544 | "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. |
| 1545 | "text": [ # Required. A collection of text responses. |
| 1546 | "A String", |
| 1547 | ], |
| 1548 | }, |
| 1549 | "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. |
| 1550 | "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. |
| 1551 | "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. |
| 1552 | }, |
| 1553 | "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. |
| 1554 | }, |
| 1555 | }, |
| 1556 | ], |
| 1557 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1558 | { # Setting a parameter value. |
| 1559 | "parameter": "A String", # Display name of the parameter. |
| 1560 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1561 | }, |
| 1562 | ], |
| 1563 | }, |
| 1564 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1565 | "event": "A String", # Required. The name of the event to handle. |
| 1566 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1567 | "name": "A String", # Output only. The unique identifier of this event handler. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1568 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1569 | ], |
| 1570 | "displayName": "A String", # Required. The human-readable name of the flow. |
| 1571 | "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. |
| 1572 | "modelTrainingMode": "A String", # Indicates NLU model training mode. |
| 1573 | "modelType": "A String", # Indicates the type of NLU model. |
| 1574 | "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. |
| 1575 | }, |
| 1576 | "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. |
| 1577 | "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified.. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. |
| 1578 | { # 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. |
| 1579 | "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. |
| 1580 | "name": "A String", # Output only. The unique identifier of this transition route. |
| 1581 | "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. |
| 1582 | "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. |
| 1583 | "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| 1584 | "conditionalCases": [ # Conditional cases for this fulfillment. |
| 1585 | { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| 1586 | "cases": [ # A list of cascading if-else conditions. |
| 1587 | { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| 1588 | "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). |
| 1589 | "caseContent": [ # A list of case content. |
| 1590 | { # The list of messages or conditional cases to activate for this case. |
| 1591 | "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. |
| 1592 | "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. |
| 1593 | "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. |
| 1594 | "segments": [ # Segments this audio response is composed of. |
| 1595 | { # Represents one segment of audio. |
| 1596 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 1597 | "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. |
| 1598 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1599 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1600 | ], |
| 1601 | }, |
| 1602 | "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. |
| 1603 | "text": "A String", # The raw text to be synthesized. |
| 1604 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1605 | "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. |
| 1606 | }, |
| 1607 | "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. |
| 1608 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1609 | "a_key": "", # Properties of the object. |
| 1610 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1611 | }, |
| 1612 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1613 | "a_key": "", # Properties of the object. |
| 1614 | }, |
| 1615 | "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. |
| 1616 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1617 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1618 | }, |
| 1619 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1620 | "text": { # The text response message. # Returns a text response. |
| 1621 | "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. |
| 1622 | "text": [ # Required. A collection of text responses. |
| 1623 | "A String", |
| 1624 | ], |
| 1625 | }, |
| 1626 | "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. |
| 1627 | "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. |
| 1628 | "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. |
| 1629 | }, |
| 1630 | "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. |
| 1631 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1632 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1633 | }, |
| 1634 | ], |
| 1635 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1636 | ], |
| 1637 | }, |
| 1638 | ], |
| 1639 | "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| 1640 | "messages": [ # The list of rich message responses to present to the user. |
| 1641 | { # 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. |
| 1642 | "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. |
| 1643 | "segments": [ # Segments this audio response is composed of. |
| 1644 | { # Represents one segment of audio. |
| 1645 | "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| 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 | "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1648 | }, |
| 1649 | ], |
| 1650 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1651 | "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. |
| 1652 | "text": "A String", # The raw text to be synthesized. |
| 1653 | "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| 1654 | "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 | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1655 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1656 | "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. |
| 1657 | "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1658 | "a_key": "", # Properties of the object. |
| 1659 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1660 | }, |
| 1661 | "payload": { # Returns a response containing a custom, platform-specific payload. |
| 1662 | "a_key": "", # Properties of the object. |
| 1663 | }, |
| 1664 | "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. |
| 1665 | "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| 1666 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1667 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1668 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1669 | "text": { # The text response message. # Returns a text response. |
| 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": [ # Required. A collection of text responses. |
| 1672 | "A String", |
| 1673 | ], |
| 1674 | }, |
| 1675 | "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. |
| 1676 | "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. |
| 1677 | "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. |
| 1678 | }, |
| 1679 | "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. |
| 1680 | }, |
| 1681 | }, |
| 1682 | ], |
| 1683 | "setParameterActions": [ # Set parameter values before executing the webhook. |
| 1684 | { # Setting a parameter value. |
| 1685 | "parameter": "A String", # Display name of the parameter. |
| 1686 | "value": "", # The new value of the parameter. A null value clears the parameter. |
| 1687 | }, |
| 1688 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1689 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1690 | "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| 1691 | "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| 1692 | }, |
| 1693 | ], |
| 1694 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1695 | </div> |
| 1696 | |
| 1697 | <div class="method"> |
| 1698 | <code class="details" id="train">train(name, body=None, x__xgafv=None)</code> |
| 1699 | <pre>Trains the specified flow. Note that only the flow in 'draft' environment is trained. |
| 1700 | |
| 1701 | Args: |
| 1702 | name: string, Required. The flow to train. Format: `projects//locations//agents//flows/`. (required) |
| 1703 | body: object, The request body. |
| 1704 | The object takes the form of: |
| 1705 | |
| 1706 | { # The request message for Flows.TrainFlow. |
| 1707 | } |
| 1708 | |
| 1709 | x__xgafv: string, V1 error format. |
| 1710 | Allowed values |
| 1711 | 1 - v1 error format |
| 1712 | 2 - v2 error format |
| 1713 | |
| 1714 | Returns: |
| 1715 | An object of the form: |
| 1716 | |
| 1717 | { # This resource represents a long-running operation that is the result of a network API call. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1718 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1719 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1720 | { |
| 1721 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1722 | }, |
| 1723 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1724 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1725 | "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. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1726 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1727 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 1728 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1729 | }, |
| 1730 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 1731 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1732 | }, |
| 1733 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 1734 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1735 | }</pre> |
| 1736 | </div> |
| 1737 | |
| 1738 | </body></html> |