Class GoogleCloudDialogflowCxV3ResponseMessage

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.
Inheritance
object
GoogleCloudDialogflowCxV3ResponseMessage
Implements
Inherited Members
Namespace: Google.Apis.Dialogflow.v3.Data
Assembly: Google.Apis.Dialogflow.v3.dll
Syntax
public class GoogleCloudDialogflowCxV3ResponseMessage : IDirectResponseSchema

Properties

Channel

The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

Declaration
[JsonProperty("channel")]
public virtual string Channel { get; set; }
Property Value
Type Description
string

ConversationSuccess

Indicates that the conversation succeeded.

Declaration
[JsonProperty("conversationSuccess")]
public virtual GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess ConversationSuccess { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndInteraction

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.

Declaration
[JsonProperty("endInteraction")]
public virtual GoogleCloudDialogflowCxV3ResponseMessageEndInteraction EndInteraction { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessageEndInteraction

KnowledgeInfoCard

Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.

Declaration
[JsonProperty("knowledgeInfoCard")]
public virtual GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard KnowledgeInfoCard { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard

LiveAgentHandoff

Hands off conversation to a human agent.

Declaration
[JsonProperty("liveAgentHandoff")]
public virtual GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff LiveAgentHandoff { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff

MixedAudio

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.

Declaration
[JsonProperty("mixedAudio")]
public virtual GoogleCloudDialogflowCxV3ResponseMessageMixedAudio MixedAudio { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessageMixedAudio

OutputAudioText

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

Declaration
[JsonProperty("outputAudioText")]
public virtual GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText OutputAudioText { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText

Payload

Returns a response containing a custom, platform-specific payload.

Declaration
[JsonProperty("payload")]
public virtual IDictionary<string, object> Payload { get; set; }
Property Value
Type Description
IDictionary<string, object>

PlayAudio

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.

Declaration
[JsonProperty("playAudio")]
public virtual GoogleCloudDialogflowCxV3ResponseMessagePlayAudio PlayAudio { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessagePlayAudio

ResponseType

Response type.

Declaration
[JsonProperty("responseType")]
public virtual string ResponseType { get; set; }
Property Value
Type Description
string

TelephonyTransferCall

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

Declaration
[JsonProperty("telephonyTransferCall")]
public virtual GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall TelephonyTransferCall { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall

Text

Returns a text response.

Declaration
[JsonProperty("text")]
public virtual GoogleCloudDialogflowCxV3ResponseMessageText Text { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ResponseMessageText

ToolCall

Returns the definition of a tool call that should be executed by the client.

Declaration
[JsonProperty("toolCall")]
public virtual GoogleCloudDialogflowCxV3ToolCall ToolCall { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3ToolCall

Implements