Dialogflow v3 API - Class ResponseMessage (2.17.0)

public sealed class ResponseMessage : IMessage<ResponseMessage>, IEquatable<ResponseMessage>, IDeepCloneable<ResponseMessage>, IBufferMessage, IMessage

Reference 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.

Inheritance

object > ResponseMessage

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

ResponseMessage()

public ResponseMessage()

ResponseMessage(ResponseMessage)

public ResponseMessage(ResponseMessage other)
Parameter
NameDescription
otherResponseMessage

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
TypeDescription
string

ConversationSuccess

public ResponseMessage.Types.ConversationSuccess ConversationSuccess { get; set; }

Indicates that the conversation succeeded.

Property Value
TypeDescription
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
TypeDescription
ResponseMessageTypesEndInteraction

KnowledgeInfoCard

public ResponseMessage.Types.KnowledgeInfoCard KnowledgeInfoCard { get; set; }

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

Property Value
TypeDescription
ResponseMessageTypesKnowledgeInfoCard

LiveAgentHandoff

public ResponseMessage.Types.LiveAgentHandoff LiveAgentHandoff { get; set; }

Hands off conversation to a human agent.

Property Value
TypeDescription
ResponseMessageTypesLiveAgentHandoff

MessageCase

public ResponseMessage.MessageOneofCase MessageCase { get; }
Property Value
TypeDescription
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
TypeDescription
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
TypeDescription
ResponseMessageTypesOutputAudioText

Payload

public Struct Payload { get; set; }

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

Property Value
TypeDescription
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
TypeDescription
ResponseMessageTypesPlayAudio

ResponseType

public ResponseMessage.Types.ResponseType ResponseType { get; set; }

Response type.

Property Value
TypeDescription
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
TypeDescription
ResponseMessageTypesTelephonyTransferCall

Text

public ResponseMessage.Types.Text Text { get; set; }

Returns a text response.

Property Value
TypeDescription
ResponseMessageTypesText