public interface ResponseMessageOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getConversationSuccess()
public abstract ResponseMessage.ConversationSuccess getConversationSuccess()
Indicates that the conversation succeeded.
.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;
Type | Description |
ResponseMessage.ConversationSuccess | The conversationSuccess. |
getConversationSuccessOrBuilder()
public abstract ResponseMessage.ConversationSuccessOrBuilder getConversationSuccessOrBuilder()
Indicates that the conversation succeeded.
.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;
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.v3.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v3.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
ResponseMessage.EndInteractionOrBuilder |
getLiveAgentHandoff()
public abstract ResponseMessage.LiveAgentHandoff getLiveAgentHandoff()
Hands off conversation to a human agent.
.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
Type | Description |
ResponseMessage.LiveAgentHandoff | The liveAgentHandoff. |
getLiveAgentHandoffOrBuilder()
public abstract ResponseMessage.LiveAgentHandoffOrBuilder getLiveAgentHandoffOrBuilder()
Hands off conversation to a human agent.
.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
Type | Description |
ResponseMessage.LiveAgentHandoffOrBuilder |
getMessageCase()
public abstract ResponseMessage.MessageCase getMessageCase()
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.v3.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v3.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v3.ResponseMessage.OutputAudioText output_audio_text = 8;
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.v3.ResponseMessage.OutputAudioText output_audio_text = 8;
Type | Description |
ResponseMessage.OutputAudioTextOrBuilder |
getPayload()
public abstract Struct getPayload()
Returns a response containing a custom, platform-specific payload.
.google.protobuf.Struct payload = 2;
Type | Description |
Struct | The payload. |
getPayloadOrBuilder()
public abstract StructOrBuilder getPayloadOrBuilder()
Returns a response containing a custom, platform-specific payload.
.google.protobuf.Struct payload = 2;
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.v3.ResponseMessage.PlayAudio play_audio = 12;
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.v3.ResponseMessage.PlayAudio play_audio = 12;
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.v3.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;
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.v3.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;
Type | Description |
ResponseMessage.TelephonyTransferCallOrBuilder |
getText()
public abstract ResponseMessage.Text getText()
Returns a text response.
.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;
Type | Description |
ResponseMessage.Text | The text. |
getTextOrBuilder()
public abstract ResponseMessage.TextOrBuilder getTextOrBuilder()
Returns a text response.
.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;
Type | Description |
ResponseMessage.TextOrBuilder |
hasConversationSuccess()
public abstract boolean hasConversationSuccess()
Indicates that the conversation succeeded.
.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;
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.v3.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
boolean | Whether the endInteraction field is set. |
hasLiveAgentHandoff()
public abstract boolean hasLiveAgentHandoff()
Hands off conversation to a human agent.
.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
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.v3.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v3.ResponseMessage.OutputAudioText output_audio_text = 8;
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;
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.v3.ResponseMessage.PlayAudio play_audio = 12;
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.v3.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;
Type | Description |
boolean | Whether the telephonyTransferCall field is set. |
hasText()
public abstract boolean hasText()
Returns a text response.
.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;
Type | Description |
boolean | Whether the text field is set. |