public sealed class ResponseMessage : IMessage<ResponseMessage>, IEquatable<ResponseMessage>, IDeepCloneable<ResponseMessage>, IBufferMessage, IMessageReference documentation and code samples for the Dialogflow v3 API class ResponseMessage.
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.
Implements
IMessageResponseMessage, IEquatableResponseMessage, IDeepCloneableResponseMessage, IBufferMessage, IMessageNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
ResponseMessage()
public ResponseMessage()ResponseMessage(ResponseMessage)
public ResponseMessage(ResponseMessage other)| Parameter | |
|---|---|
| Name | Description |
other | ResponseMessage |
Properties
Channel
public string Channel { get; set; }The channel which the response is associated with. Clients can specify the channel via [QueryParameters.channel][google.cloud.dialogflow.cx.v3.QueryParameters.channel], and only associated channel response will be returned.
| Property Value | |
|---|---|
| Type | Description |
string | |
ConversationSuccess
public ResponseMessage.Types.ConversationSuccess ConversationSuccess { get; set; }Indicates that the conversation succeeded.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesConversationSuccess | |
EndInteraction
public ResponseMessage.Types.EndInteraction EndInteraction { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesEndInteraction | |
LiveAgentHandoff
public ResponseMessage.Types.LiveAgentHandoff LiveAgentHandoff { get; set; }Hands off conversation to a human agent.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesLiveAgentHandoff | |
MessageCase
public ResponseMessage.MessageOneofCase MessageCase { get; }| Property Value | |
|---|---|
| Type | Description |
ResponseMessageMessageOneofCase | |
MixedAudio
public ResponseMessage.Types.MixedAudio MixedAudio { get; set; }Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via [play_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio]. This message is generated by Dialogflow only and not supposed to be defined by the user.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesMixedAudio | |
OutputAudioText
public ResponseMessage.Types.OutputAudioText OutputAudioText { get; set; }A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesOutputAudioText | |
Payload
public Struct Payload { get; set; }Returns a response containing a custom, platform-specific payload.
| Property Value | |
|---|---|
| Type | Description |
Struct | |
PlayAudio
public ResponseMessage.Types.PlayAudio PlayAudio { get; set; }Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct [mixed_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.mixed_audio]. However, Dialogflow itself does not try to read or process the URI in any way.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesPlayAudio | |
ResponseType
public ResponseMessage.Types.ResponseType ResponseType { get; set; }Response type.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesResponseType | |
TelephonyTransferCall
public ResponseMessage.Types.TelephonyTransferCall TelephonyTransferCall { get; set; }A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesTelephonyTransferCall | |
Text
public ResponseMessage.Types.Text Text { get; set; }Returns a text response.
| Property Value | |
|---|---|
| Type | Description |
ResponseMessageTypesText | |