GoogleCloudDialogflowCxV3ResponseMessageResponse class

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.

Constructors

GoogleCloudDialogflowCxV3ResponseMessageResponse({required Input<String> channel, required Input<GoogleCloudDialogflowCxV3ResponseMessageConversationSuccessResponse> conversationSuccess, required Input<Map<String, dynamic>> endInteraction, required Input<Map<String, dynamic>> knowledgeInfoCard, required Input<GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoffResponse> liveAgentHandoff, required Input<GoogleCloudDialogflowCxV3ResponseMessageMixedAudioResponse> mixedAudio, required Input<GoogleCloudDialogflowCxV3ResponseMessageOutputAudioTextResponse> outputAudioText, required Input<Map<String, String>> payload, required Input<GoogleCloudDialogflowCxV3ResponseMessagePlayAudioResponse> playAudio, required Input<String> responseType, required Input<GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCallResponse> telephonyTransferCall, required Input<GoogleCloudDialogflowCxV3ResponseMessageTextResponse> text})
Creates a new GoogleCloudDialogflowCxV3ResponseMessageResponse. 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. conversationSuccess Indicates that the conversation succeeded. endInteraction 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. knowledgeInfoCard Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. liveAgentHandoff Hands off conversation to a human agent. mixedAudio 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. outputAudioText A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. payload Returns a response containing a custom, platform-specific payload. 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. responseType Response type. telephonyTransferCall A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. text Returns a text response.
const
GoogleCloudDialogflowCxV3ResponseMessageResponse.fromMap(Map<String, dynamic> map)
factory

Properties

channel → Input<String>
The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
final
conversationSuccess → Input<GoogleCloudDialogflowCxV3ResponseMessageConversationSuccessResponse>
Indicates that the conversation succeeded.
final
endInteraction → Input<Map<String, dynamic>>
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.
final
hashCode → int
The hash code for this object.
no setterinherited
knowledgeInfoCard → Input<Map<String, dynamic>>
Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
final
liveAgentHandoff → Input<GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoffResponse>
Hands off conversation to a human agent.
final
mixedAudio → Input<GoogleCloudDialogflowCxV3ResponseMessageMixedAudioResponse>
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.
final
outputAudioText → Input<GoogleCloudDialogflowCxV3ResponseMessageOutputAudioTextResponse>
A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
final
payload → Input<Map<String, String>>
Returns a response containing a custom, platform-specific payload.
final
playAudio → Input<GoogleCloudDialogflowCxV3ResponseMessagePlayAudioResponse>
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.
final
responseType → Input<String>
Response type.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
telephonyTransferCall → Input<GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCallResponse>
A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
final
text → Input<GoogleCloudDialogflowCxV3ResponseMessageTextResponse>
Returns a text response.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited