Interface ResponseMessageOrBuilder (0.63.0)

Version 0.63.0

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public interface ResponseMessageOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChannel()

public abstract String getChannel()

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

string channel = 19;

Returns
Type	Description
String	The channel.

getChannelBytes()

public abstract ByteString getChannelBytes()

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

string channel = 19;

Returns
Type	Description
ByteString	The bytes for channel.

getConversationSuccess()

public abstract ResponseMessage.ConversationSuccess getConversationSuccess()

Indicates that the conversation succeeded.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;

Returns
Type	Description
ResponseMessage.ConversationSuccess	The conversationSuccess.

getConversationSuccessOrBuilder()

public abstract ResponseMessage.ConversationSuccessOrBuilder getConversationSuccessOrBuilder()

Indicates that the conversation succeeded.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;

Returns
Type	Description
ResponseMessage.ConversationSuccessOrBuilder

getEndInteraction()

public abstract ResponseMessage.EndInteraction getEndInteraction()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ResponseMessage.EndInteraction	The endInteraction.

getEndInteractionOrBuilder()

public abstract ResponseMessage.EndInteractionOrBuilder getEndInteractionOrBuilder()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ResponseMessage.EndInteractionOrBuilder

getKnowledgeInfoCard()

public abstract ResponseMessage.KnowledgeInfoCard getKnowledgeInfoCard()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;

Returns
Type	Description
ResponseMessage.KnowledgeInfoCard	The knowledgeInfoCard.

getKnowledgeInfoCardOrBuilder()

public abstract ResponseMessage.KnowledgeInfoCardOrBuilder getKnowledgeInfoCardOrBuilder()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;

Returns
Type	Description
ResponseMessage.KnowledgeInfoCardOrBuilder

getLiveAgentHandoff()

public abstract ResponseMessage.LiveAgentHandoff getLiveAgentHandoff()

Hands off conversation to a human agent.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;

Returns
Type	Description
ResponseMessage.LiveAgentHandoff	The liveAgentHandoff.

getLiveAgentHandoffOrBuilder()

public abstract ResponseMessage.LiveAgentHandoffOrBuilder getLiveAgentHandoffOrBuilder()

Hands off conversation to a human agent.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;

Returns
Type	Description
ResponseMessage.LiveAgentHandoffOrBuilder

getMessageCase()

public abstract ResponseMessage.MessageCase getMessageCase()

Returns
Type	Description
ResponseMessage.MessageCase

getMixedAudio()

public abstract ResponseMessage.MixedAudio getMixedAudio()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ResponseMessage.MixedAudio	The mixedAudio.

getMixedAudioOrBuilder()

public abstract ResponseMessage.MixedAudioOrBuilder getMixedAudioOrBuilder()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ResponseMessage.MixedAudioOrBuilder

getOutputAudioText()

public abstract ResponseMessage.OutputAudioText getOutputAudioText()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.OutputAudioText output_audio_text = 8;

Returns
Type	Description
ResponseMessage.OutputAudioText	The outputAudioText.

getOutputAudioTextOrBuilder()

public abstract ResponseMessage.OutputAudioTextOrBuilder getOutputAudioTextOrBuilder()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.OutputAudioText output_audio_text = 8;

Returns
Type	Description
ResponseMessage.OutputAudioTextOrBuilder

getPayload()

public abstract Struct getPayload()

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

.google.protobuf.Struct payload = 2;

Returns
Type	Description
Struct	The payload.

getPayloadOrBuilder()

public abstract StructOrBuilder getPayloadOrBuilder()

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

.google.protobuf.Struct payload = 2;

Returns
Type	Description
StructOrBuilder

getPlayAudio()

public abstract ResponseMessage.PlayAudio getPlayAudio()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.PlayAudio play_audio = 12;

Returns
Type	Description
ResponseMessage.PlayAudio	The playAudio.

getPlayAudioOrBuilder()

public abstract ResponseMessage.PlayAudioOrBuilder getPlayAudioOrBuilder()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.PlayAudio play_audio = 12;

Returns
Type	Description
ResponseMessage.PlayAudioOrBuilder

getTelephonyTransferCall()

public abstract ResponseMessage.TelephonyTransferCall getTelephonyTransferCall()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;

Returns
Type	Description
ResponseMessage.TelephonyTransferCall	The telephonyTransferCall.

getTelephonyTransferCallOrBuilder()

public abstract ResponseMessage.TelephonyTransferCallOrBuilder getTelephonyTransferCallOrBuilder()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;

Returns
Type	Description
ResponseMessage.TelephonyTransferCallOrBuilder

getText()

public abstract ResponseMessage.Text getText()

Returns a text response.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;

Returns
Type	Description
ResponseMessage.Text	The text.

getTextOrBuilder()

public abstract ResponseMessage.TextOrBuilder getTextOrBuilder()

Returns a text response.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;

Returns
Type	Description
ResponseMessage.TextOrBuilder

getToolCall()

public abstract ToolCall getToolCall()

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

.google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;

Returns
Type	Description
ToolCall	The toolCall.

getToolCallOrBuilder()

public abstract ToolCallOrBuilder getToolCallOrBuilder()

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

.google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;

Returns
Type	Description
ToolCallOrBuilder

hasConversationSuccess()

public abstract boolean hasConversationSuccess()

Indicates that the conversation succeeded.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;

Returns
Type	Description
boolean	Whether the conversationSuccess field is set.

hasEndInteraction()

public abstract boolean hasEndInteraction()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the endInteraction field is set.

hasKnowledgeInfoCard()

public abstract boolean hasKnowledgeInfoCard()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;

Returns
Type	Description
boolean	Whether the knowledgeInfoCard field is set.

hasLiveAgentHandoff()

public abstract boolean hasLiveAgentHandoff()

Hands off conversation to a human agent.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;

Returns
Type	Description
boolean	Whether the liveAgentHandoff field is set.

hasMixedAudio()

public abstract boolean hasMixedAudio()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the mixedAudio field is set.

hasOutputAudioText()

public abstract boolean hasOutputAudioText()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.OutputAudioText output_audio_text = 8;

Returns
Type	Description
boolean	Whether the outputAudioText field is set.

hasPayload()

public abstract boolean hasPayload()

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

.google.protobuf.Struct payload = 2;

Returns
Type	Description
boolean	Whether the payload field is set.

hasPlayAudio()

public abstract boolean hasPlayAudio()

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.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.PlayAudio play_audio = 12;

Returns
Type	Description
boolean	Whether the playAudio field is set.

hasTelephonyTransferCall()

public abstract boolean hasTelephonyTransferCall()

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

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;

Returns
Type	Description
boolean	Whether the telephonyTransferCall field is set.

hasText()

public abstract boolean hasText()

Returns a text response.

.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;

Returns
Type	Description
boolean	Whether the text field is set.

hasToolCall()

public abstract boolean hasToolCall()

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

.google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;

Returns
Type	Description
boolean	Whether the toolCall field is set.