public final class ResponseMessage extends GeneratedMessageV3 implements ResponseMessageOrBuilder
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.
Protobuf type google.cloud.dialogflow.cx.v3.ResponseMessage
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CHANNEL_FIELD_NUMBER
public static final int CHANNEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONVERSATION_SUCCESS_FIELD_NUMBER
public static final int CONVERSATION_SUCCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
END_INTERACTION_FIELD_NUMBER
public static final int END_INTERACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
KNOWLEDGE_INFO_CARD_FIELD_NUMBER
public static final int KNOWLEDGE_INFO_CARD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LIVE_AGENT_HANDOFF_FIELD_NUMBER
public static final int LIVE_AGENT_HANDOFF_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MIXED_AUDIO_FIELD_NUMBER
public static final int MIXED_AUDIO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUT_AUDIO_TEXT_FIELD_NUMBER
public static final int OUTPUT_AUDIO_TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAYLOAD_FIELD_NUMBER
public static final int PAYLOAD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PLAY_AUDIO_FIELD_NUMBER
public static final int PLAY_AUDIO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESPONSE_TYPE_FIELD_NUMBER
public static final int RESPONSE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TELEPHONY_TRANSFER_CALL_FIELD_NUMBER
public static final int TELEPHONY_TRANSFER_CALL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ResponseMessage getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ResponseMessage.Builder newBuilder()
newBuilder(ResponseMessage prototype)
public static ResponseMessage.Builder newBuilder(ResponseMessage prototype)
public static ResponseMessage parseDelimitedFrom(InputStream input)
public static ResponseMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ResponseMessage parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ResponseMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ResponseMessage parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ResponseMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ResponseMessage parseFrom(CodedInputStream input)
public static ResponseMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ResponseMessage parseFrom(InputStream input)
public static ResponseMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ResponseMessage parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ResponseMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ResponseMessage> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getChannel()
public 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 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 ResponseMessage.ConversationSuccess getConversationSuccess()
Indicates that the conversation succeeded.
.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;
getConversationSuccessOrBuilder()
public ResponseMessage.ConversationSuccessOrBuilder getConversationSuccessOrBuilder()
Indicates that the conversation succeeded.
.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;
getDefaultInstanceForType()
public ResponseMessage getDefaultInstanceForType()
getEndInteraction()
public 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];
getEndInteractionOrBuilder()
public 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];
getKnowledgeInfoCard()
public ResponseMessage.KnowledgeInfoCard getKnowledgeInfoCard()
Represents info card for knowledge answers, to be better rendered in
Dialogflow Messenger.
.google.cloud.dialogflow.cx.v3.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;
getKnowledgeInfoCardOrBuilder()
public ResponseMessage.KnowledgeInfoCardOrBuilder getKnowledgeInfoCardOrBuilder()
Represents info card for knowledge answers, to be better rendered in
Dialogflow Messenger.
.google.cloud.dialogflow.cx.v3.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;
getLiveAgentHandoff()
public ResponseMessage.LiveAgentHandoff getLiveAgentHandoff()
Hands off conversation to a human agent.
.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
getLiveAgentHandoffOrBuilder()
public ResponseMessage.LiveAgentHandoffOrBuilder getLiveAgentHandoffOrBuilder()
Hands off conversation to a human agent.
.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
getMessageCase()
public ResponseMessage.MessageCase getMessageCase()
getMixedAudio()
public 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];
getMixedAudioOrBuilder()
public 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];
getOutputAudioText()
public 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;
getOutputAudioTextOrBuilder()
public 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;
getParserForType()
public Parser<ResponseMessage> getParserForType()
Overrides
getPayload()
public Struct getPayload()
Returns a response containing a custom, platform-specific payload.
.google.protobuf.Struct payload = 2;
| Returns |
| Type |
Description |
Struct |
The payload.
|
getPayloadOrBuilder()
public StructOrBuilder getPayloadOrBuilder()
Returns a response containing a custom, platform-specific payload.
.google.protobuf.Struct payload = 2;
getPlayAudio()
public 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;
getPlayAudioOrBuilder()
public 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;
getResponseType()
public ResponseMessage.ResponseType getResponseType()
Response type.
.google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType response_type = 4;
getResponseTypeValue()
public int getResponseTypeValue()
Response type.
.google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType response_type = 4;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for responseType.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTelephonyTransferCall()
public 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;
getTelephonyTransferCallOrBuilder()
public 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;
getText()
public ResponseMessage.Text getText()
Returns a text response.
.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;
getTextOrBuilder()
public ResponseMessage.TextOrBuilder getTextOrBuilder()
Returns a text response.
.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;
hasConversationSuccess()
public boolean hasConversationSuccess()
Indicates that the conversation succeeded.
.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;
| Returns |
| Type |
Description |
boolean |
Whether the conversationSuccess field is set.
|
hasEndInteraction()
public 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];
| Returns |
| Type |
Description |
boolean |
Whether the endInteraction field is set.
|
hasKnowledgeInfoCard()
public boolean hasKnowledgeInfoCard()
Represents info card for knowledge answers, to be better rendered in
Dialogflow Messenger.
.google.cloud.dialogflow.cx.v3.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;
| Returns |
| Type |
Description |
boolean |
Whether the knowledgeInfoCard field is set.
|
hasLiveAgentHandoff()
public boolean hasLiveAgentHandoff()
Hands off conversation to a human agent.
.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
| Returns |
| Type |
Description |
boolean |
Whether the liveAgentHandoff field is set.
|
hasMixedAudio()
public 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];
| Returns |
| Type |
Description |
boolean |
Whether the mixedAudio field is set.
|
hasOutputAudioText()
public 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;
| Returns |
| Type |
Description |
boolean |
Whether the outputAudioText field is set.
|
hasPayload()
public 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 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;
| Returns |
| Type |
Description |
boolean |
Whether the playAudio field is set.
|
hasTelephonyTransferCall()
public 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;
| Returns |
| Type |
Description |
boolean |
Whether the telephonyTransferCall field is set.
|
hasText()
Returns a text response.
.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;
| Returns |
| Type |
Description |
boolean |
Whether the text field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ResponseMessage.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ResponseMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ResponseMessage.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
