| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="dialogflow_v3.html">Dialogflow API</a> . <a href="dialogflow_v3.projects.html">projects</a> . <a href="dialogflow_v3.projects.locations.html">locations</a> . <a href="dialogflow_v3.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3.projects.locations.agents.testCases.html">testCases</a> . <a href="dialogflow_v3.projects.locations.agents.testCases.results.html">results</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a test case result.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Fetches a list of results for a given test case.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a test case result. |
| |
| Args: |
| name: string, Required. The name of the testcase. Format: `projects//locations//agents//testCases//results/`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a result from running a test case in an agent environment. |
| "conversationTurns": [ # The conversation turns uttered during the test case replay in chronological order. |
| { # One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response. |
| "userInput": { # The input from the human user. # The user input. |
| "enableSentimentAnalysis": True or False, # Whether sentiment analysis is enabled. |
| "injectedParameters": { # Parameters that need to be injected into the conversation during intent detection. |
| "a_key": "", # Properties of the object. |
| }, |
| "input": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. # Supports text input, event input, dtmf input in the test case. |
| "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed. |
| "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests. |
| "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. |
| "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. |
| "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. |
| "model": "A String", # Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. |
| "modelVariant": "A String", # Optional. Which variant of the Speech model to use. |
| "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. |
| "A String", |
| ], |
| "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. |
| "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. |
| }, |
| }, |
| "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled. |
| "digits": "A String", # The dtmf digits. |
| "finishDigit": "A String", # The finish digit (if any). |
| }, |
| "event": { # Represents the event to trigger. # The event to be triggered. |
| "event": "A String", # Name of the event. |
| }, |
| "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered. |
| "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`. |
| }, |
| "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
| "text": { # Represents the natural language text to be processed. # The natural language text to be processed. |
| "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. |
| }, |
| }, |
| "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. |
| }, |
| "virtualAgentOutput": { # The output from the virtual agent. # The virtual agent output. |
| "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The Page on which the utterance was spoken. Only name and displayName will be set. |
| "displayName": "A String", # Required. The human-readable name of the page, unique within the agent. |
| "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. |
| { # 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. |
| "event": "A String", # Required. The name of the event to handle. |
| "name": "A String", # Output only. The unique identifier of this event handler. |
| "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| "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. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| }, |
| ], |
| "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. |
| "parameters": [ # Parameters to collect from the user. |
| { # Represents a form parameter. |
| "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. |
| "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. |
| "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. |
| "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. |
| { # 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. |
| "event": "A String", # Required. The name of the event to handle. |
| "name": "A String", # Output only. The unique identifier of this event handler. |
| "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| "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. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| }, |
| ], |
| }, |
| "isList": True or False, # Indicates whether the parameter represents a list of values. |
| "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. |
| "required": True or False, # Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes. |
| }, |
| ], |
| }, |
| "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. |
| "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`. |
| "A String", |
| ], |
| "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. |
| { # 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. |
| "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. |
| "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. |
| "name": "A String", # Output only. The unique identifier of this transition route. |
| "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| "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. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| }, |
| ], |
| }, |
| "diagnosticInfo": { # Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage. |
| "a_key": "", # Properties of the object. |
| }, |
| "differences": [ # Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any. |
| { # The description of differences between original and replayed agent output. |
| "description": "A String", # A description of the diff, showing the actual output vs expected output. |
| "type": "A String", # The type of diff. |
| }, |
| ], |
| "sessionParameters": { # The session parameters available to the bot at this point. |
| "a_key": "", # Properties of the object. |
| }, |
| "status": { # 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). # Response error from the agent in the test result. If set, other output is empty. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| "textResponses": [ # The text responses from the agent for the turn. |
| { # The text response message. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| ], |
| "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. |
| "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
| "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. |
| "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
| "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. |
| "a_key": "A String", |
| }, |
| "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. |
| "parameters": [ # The collection of parameters associated with the intent. |
| { # Represents an intent parameter. |
| "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
| "isList": True or False, # Indicates whether the parameter represents a list of values. |
| "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. |
| }, |
| ], |
| "priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. |
| { # Represents an example that the agent is trained on to identify the intent. |
| "id": "A String", # Output only. The unique identifier of the training phrase. |
| "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set. |
| { # Represents a part of a training phrase. |
| "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. |
| "text": "A String", # Required. The text for this part. |
| }, |
| ], |
| "repeatCount": 42, # Indicates how many times this example was added to the intent. |
| }, |
| ], |
| }, |
| }, |
| }, |
| ], |
| "environment": "A String", # Environment where the test was run. If not set, it indicates the draft environment. |
| "name": "A String", # The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. |
| "testResult": "A String", # Whether the test case passed in the agent environment. |
| "testTime": "A String", # The time that the test was run. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Fetches a list of results for a given test case. |
| |
| Args: |
| parent: string, Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. (required) |
| filter: string, The filter expression used to filter test case results. See [API Filtering](https://aip.dev/160). The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator `environment` `=`, `IN` (Use value `draft` for draft environment) `test_time` `>`, `<` `latest` only returns the latest test result in all results for each test case. Examples: * "environment=draft AND latest" matches the latest test result for each test case in the draft environment. * "environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2". * "test_time > 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713. |
| pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000. |
| pageToken: string, The next_page_token value returned from a previous list request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response message for TestCases.ListTestCaseResults. |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| "testCaseResults": [ # The list of test case results. |
| { # Represents a result from running a test case in an agent environment. |
| "conversationTurns": [ # The conversation turns uttered during the test case replay in chronological order. |
| { # One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response. |
| "userInput": { # The input from the human user. # The user input. |
| "enableSentimentAnalysis": True or False, # Whether sentiment analysis is enabled. |
| "injectedParameters": { # Parameters that need to be injected into the conversation during intent detection. |
| "a_key": "", # Properties of the object. |
| }, |
| "input": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. # Supports text input, event input, dtmf input in the test case. |
| "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed. |
| "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests. |
| "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. |
| "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. |
| "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. |
| "model": "A String", # Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. |
| "modelVariant": "A String", # Optional. Which variant of the Speech model to use. |
| "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. |
| "A String", |
| ], |
| "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. |
| "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. |
| }, |
| }, |
| "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled. |
| "digits": "A String", # The dtmf digits. |
| "finishDigit": "A String", # The finish digit (if any). |
| }, |
| "event": { # Represents the event to trigger. # The event to be triggered. |
| "event": "A String", # Name of the event. |
| }, |
| "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered. |
| "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`. |
| }, |
| "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. |
| "text": { # Represents the natural language text to be processed. # The natural language text to be processed. |
| "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. |
| }, |
| }, |
| "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. |
| }, |
| "virtualAgentOutput": { # The output from the virtual agent. # The virtual agent output. |
| "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The Page on which the utterance was spoken. Only name and displayName will be set. |
| "displayName": "A String", # Required. The human-readable name of the page, unique within the agent. |
| "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. |
| { # 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. |
| "event": "A String", # Required. The name of the event to handle. |
| "name": "A String", # Output only. The unique identifier of this event handler. |
| "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| "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. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| }, |
| ], |
| "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. |
| "parameters": [ # Parameters to collect from the user. |
| { # Represents a form parameter. |
| "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. |
| "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. |
| "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. |
| "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. |
| { # 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. |
| "event": "A String", # Required. The name of the event to handle. |
| "name": "A String", # Output only. The unique identifier of this event handler. |
| "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| "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. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| }, |
| ], |
| }, |
| "isList": True or False, # Indicates whether the parameter represents a list of values. |
| "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. |
| "required": True or False, # Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes. |
| }, |
| ], |
| }, |
| "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. |
| "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`. |
| "A String", |
| ], |
| "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. |
| { # 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. |
| "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. |
| "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. |
| "name": "A String", # Output only. The unique identifier of this transition route. |
| "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. |
| "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. |
| "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. |
| "conditionalCases": [ # Conditional cases for this fulfillment. |
| { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. |
| "cases": [ # A list of cascading if-else conditions. |
| { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. |
| "caseContent": [ # A list of case content. |
| { # The list of messages or conditional cases to activate for this case. |
| "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3FulfillmentConditionalCases # Additional cases to be evaluated. |
| "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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| ], |
| "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). |
| }, |
| ], |
| }, |
| ], |
| "messages": [ # The list of rich message responses to present to the user. |
| { # 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. |
| "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. |
| "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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` 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. |
| }, |
| "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. |
| "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "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. |
| "segments": [ # Segments this audio response is composed of. |
| { # Represents one segment of audio. |
| "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. |
| "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. |
| "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). |
| "text": "A String", # The raw text to be synthesized. |
| }, |
| "payload": { # Returns a response containing a custom, platform-specific payload. |
| "a_key": "", # Properties of the object. |
| }, |
| "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. |
| "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. |
| "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. |
| }, |
| "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
| "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). |
| }, |
| "text": { # The text response message. # Returns a text response. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. |
| "setParameterActions": [ # Set parameter values before executing the webhook. |
| { # Setting a parameter value. |
| "parameter": "A String", # Display name of the parameter. |
| "value": "", # The new value of the parameter. A null value clears the parameter. |
| }, |
| ], |
| "tag": "A String", # The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified. |
| "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. |
| }, |
| }, |
| ], |
| }, |
| "diagnosticInfo": { # Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage. |
| "a_key": "", # Properties of the object. |
| }, |
| "differences": [ # Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any. |
| { # The description of differences between original and replayed agent output. |
| "description": "A String", # A description of the diff, showing the actual output vs expected output. |
| "type": "A String", # The type of diff. |
| }, |
| ], |
| "sessionParameters": { # The session parameters available to the bot at this point. |
| "a_key": "", # Properties of the object. |
| }, |
| "status": { # 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). # Response error from the agent in the test result. If set, other output is empty. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| "textResponses": [ # The text responses from the agent for the turn. |
| { # The text response message. |
| "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. |
| "text": [ # Required. A collection of text responses. |
| "A String", |
| ], |
| }, |
| ], |
| "triggeredIntent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that triggered the response. Only name and displayName will be set. |
| "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. |
| "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. |
| "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. |
| "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. |
| "a_key": "A String", |
| }, |
| "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. |
| "parameters": [ # The collection of parameters associated with the intent. |
| { # Represents an intent parameter. |
| "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. |
| "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
| "isList": True or False, # Indicates whether the parameter represents a list of values. |
| "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. |
| }, |
| ], |
| "priority": 42, # The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. |
| "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. |
| { # Represents an example that the agent is trained on to identify the intent. |
| "id": "A String", # Output only. The unique identifier of the training phrase. |
| "parts": [ # Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set. |
| { # Represents a part of a training phrase. |
| "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. |
| "text": "A String", # Required. The text for this part. |
| }, |
| ], |
| "repeatCount": 42, # Indicates how many times this example was added to the intent. |
| }, |
| ], |
| }, |
| }, |
| }, |
| ], |
| "environment": "A String", # Environment where the test was run. If not set, it indicates the draft environment. |
| "name": "A String", # The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. |
| "testResult": "A String", # Whether the test case passed in the agent environment. |
| "testTime": "A String", # The time that the test was run. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
