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

Properties

channel ↔ String?
The channel which the response is associated with.
getter/setter pair
conversationSuccess ↔ GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess?
Indicates that the conversation succeeded.
getter/setter pair
endInteraction ↔ GoogleCloudDialogflowCxV3ResponseMessageEndInteraction?
A signal that indicates the interaction with the Dialogflow agent has ended.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
knowledgeInfoCard ↔ GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard?
Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
getter/setter pair
liveAgentHandoff ↔ GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff?
Hands off conversation to a human agent.
getter/setter pair
mixedAudio ↔ GoogleCloudDialogflowCxV3ResponseMessageMixedAudio?
An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio.
getter/setter pair
outputAudioText ↔ GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText?
A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
getter/setter pair
payload ↔ Map<String, Object?>?
Returns a response containing a custom, platform-specific payload.
getter/setter pair
playAudio ↔ GoogleCloudDialogflowCxV3ResponseMessagePlayAudio?
Signal that the client should play an audio clip hosted at a client-specific URI.
getter/setter pair
responseType ↔ String?
Response type. Possible string values are:
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
telephonyTransferCall ↔ GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall?
A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
getter/setter pair
text ↔ GoogleCloudDialogflowCxV3ResponseMessageText?
Returns a text response.
getter/setter pair

Methods

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

Operators

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