Class StreamingAnalyzeContentResponse (4.21.0) 

public final class StreamingAnalyzeContentResponse extends GeneratedMessageV3 implements StreamingAnalyzeContentResponseOrBuilder

The top-level message returned from the StreamingAnalyzeContent method. Multiple response messages can be returned in order:

  1. If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.
  2. In virtual agent stage: if enable_partial_automated_agent_reply is true, the following N (currently 1 <= N <= 4) messages contain automated_agent_reply and optionally reply_audio returned by the virtual agent. The first (N-1) automated_agent_replys will have automated_agent_reply_type set to PARTIAL. The last automated_agent_reply has automated_agent_reply_type set to FINAL. If enable_partial_automated_agent_reply is not enabled, response stream only contains the final reply. In human assist stage: the following N (N >= 1) messages contain human_agent_suggestion_results, end_user_suggestion_results or message.

Protobuf type google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StreamingAnalyzeContentResponse

Static Fields

AUTOMATED_AGENT_REPLY_FIELD_NUMBER

public static final int AUTOMATED_AGENT_REPLY_FIELD_NUMBER
Field Value
Type Description
int

DTMF_PARAMETERS_FIELD_NUMBER

public static final int DTMF_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

END_USER_SUGGESTION_RESULTS_FIELD_NUMBER

public static final int END_USER_SUGGESTION_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER

public static final int HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

RECOGNITION_RESULT_FIELD_NUMBER

public static final int RECOGNITION_RESULT_FIELD_NUMBER
Field Value
Type Description
int

REPLY_AUDIO_FIELD_NUMBER

public static final int REPLY_AUDIO_FIELD_NUMBER
Field Value
Type Description
int

REPLY_TEXT_FIELD_NUMBER

public static final int REPLY_TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StreamingAnalyzeContentResponse getDefaultInstance()
Returns
Type Description
StreamingAnalyzeContentResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StreamingAnalyzeContentResponse.Builder newBuilder()
Returns
Type Description
StreamingAnalyzeContentResponse.Builder

newBuilder(StreamingAnalyzeContentResponse prototype)

public static StreamingAnalyzeContentResponse.Builder newBuilder(StreamingAnalyzeContentResponse prototype)
Parameter
Name Description
prototype StreamingAnalyzeContentResponse
Returns
Type Description
StreamingAnalyzeContentResponse.Builder

parseDelimitedFrom(InputStream input)

public static StreamingAnalyzeContentResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StreamingAnalyzeContentResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamingAnalyzeContentResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamingAnalyzeContentResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StreamingAnalyzeContentResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StreamingAnalyzeContentResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamingAnalyzeContentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingAnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StreamingAnalyzeContentResponse> parser()
Returns
Type Description
Parser<StreamingAnalyzeContentResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutomatedAgentReply()

public AutomatedAgentReply getAutomatedAgentReply()

Only set if a Dialogflow automated agent has responded. Note that: [AutomatedAgentReply.detect_intent_response.output_audio][] and [AutomatedAgentReply.detect_intent_response.output_audio_config][] are always empty, use reply_audio instead.

.google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 4;

Returns
Type Description
AutomatedAgentReply

The automatedAgentReply.

getAutomatedAgentReplyOrBuilder()

public AutomatedAgentReplyOrBuilder getAutomatedAgentReplyOrBuilder()

Only set if a Dialogflow automated agent has responded. Note that: [AutomatedAgentReply.detect_intent_response.output_audio][] and [AutomatedAgentReply.detect_intent_response.output_audio_config][] are always empty, use reply_audio instead.

.google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 4;

Returns
Type Description
AutomatedAgentReplyOrBuilder

getDefaultInstanceForType()

public StreamingAnalyzeContentResponse getDefaultInstanceForType()
Returns
Type Description
StreamingAnalyzeContentResponse

getDtmfParameters()

public DtmfParameters getDtmfParameters()

Indicates the parameters of DTMF.

.google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 10;

Returns
Type Description
DtmfParameters

The dtmfParameters.

getDtmfParametersOrBuilder()

public DtmfParametersOrBuilder getDtmfParametersOrBuilder()

Indicates the parameters of DTMF.

.google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 10;

Returns
Type Description
DtmfParametersOrBuilder

getEndUserSuggestionResults(int index)

public SuggestionResult getEndUserSuggestionResults(int index)

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;

Parameter
Name Description
index int
Returns
Type Description
SuggestionResult

getEndUserSuggestionResultsCount()

public int getEndUserSuggestionResultsCount()

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;

Returns
Type Description
int

getEndUserSuggestionResultsList()

public List<SuggestionResult> getEndUserSuggestionResultsList()

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;

Returns
Type Description
List<SuggestionResult>

getEndUserSuggestionResultsOrBuilder(int index)

public SuggestionResultOrBuilder getEndUserSuggestionResultsOrBuilder(int index)

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;

Parameter
Name Description
index int
Returns
Type Description
SuggestionResultOrBuilder

getEndUserSuggestionResultsOrBuilderList()

public List<? extends SuggestionResultOrBuilder> getEndUserSuggestionResultsOrBuilderList()

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.SuggestionResultOrBuilder>

getHumanAgentSuggestionResults(int index)

public SuggestionResult getHumanAgentSuggestionResults(int index)

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;

Parameter
Name Description
index int
Returns
Type Description
SuggestionResult

getHumanAgentSuggestionResultsCount()

public int getHumanAgentSuggestionResultsCount()

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;

Returns
Type Description
int

getHumanAgentSuggestionResultsList()

public List<SuggestionResult> getHumanAgentSuggestionResultsList()

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;

Returns
Type Description
List<SuggestionResult>

getHumanAgentSuggestionResultsOrBuilder(int index)

public SuggestionResultOrBuilder getHumanAgentSuggestionResultsOrBuilder(int index)

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;

Parameter
Name Description
index int
Returns
Type Description
SuggestionResultOrBuilder

getHumanAgentSuggestionResultsOrBuilderList()

public List<? extends SuggestionResultOrBuilder> getHumanAgentSuggestionResultsOrBuilderList()

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.

repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.SuggestionResultOrBuilder>

getMessage()

public Message getMessage()

Message analyzed by CCAI.

.google.cloud.dialogflow.v2.Message message = 6;

Returns
Type Description
Message

The message.

getMessageOrBuilder()

public MessageOrBuilder getMessageOrBuilder()

Message analyzed by CCAI.

.google.cloud.dialogflow.v2.Message message = 6;

Returns
Type Description
MessageOrBuilder

getParserForType()

public Parser<StreamingAnalyzeContentResponse> getParserForType()
Returns
Type Description
Parser<StreamingAnalyzeContentResponse>
Overrides

getRecognitionResult()

public StreamingRecognitionResult getRecognitionResult()

The result of speech recognition.

.google.cloud.dialogflow.v2.StreamingRecognitionResult recognition_result = 1;

Returns
Type Description
StreamingRecognitionResult

The recognitionResult.

getRecognitionResultOrBuilder()

public StreamingRecognitionResultOrBuilder getRecognitionResultOrBuilder()

The result of speech recognition.

.google.cloud.dialogflow.v2.StreamingRecognitionResult recognition_result = 1;

Returns
Type Description
StreamingRecognitionResultOrBuilder

getReplyAudio()

public OutputAudio getReplyAudio()

The audio data bytes encoded as specified in the request. This field is set if:

  • The reply_audio_config field is specified in the request.
  • The automated agent, which this output comes from, responded with audio. In such case, the reply_audio.config field contains settings used to synthesize the speech. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

.google.cloud.dialogflow.v2.OutputAudio reply_audio = 3;

Returns
Type Description
OutputAudio

The replyAudio.

getReplyAudioOrBuilder()

public OutputAudioOrBuilder getReplyAudioOrBuilder()

The audio data bytes encoded as specified in the request. This field is set if:

  • The reply_audio_config field is specified in the request.
  • The automated agent, which this output comes from, responded with audio. In such case, the reply_audio.config field contains settings used to synthesize the speech. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

.google.cloud.dialogflow.v2.OutputAudio reply_audio = 3;

Returns
Type Description
OutputAudioOrBuilder

getReplyText()

public String getReplyText()

The output text content. This field is set if an automated agent responded with a text for the user.

string reply_text = 2;

Returns
Type Description
String

The replyText.

getReplyTextBytes()

public ByteString getReplyTextBytes()

The output text content. This field is set if an automated agent responded with a text for the user.

string reply_text = 2;

Returns
Type Description
ByteString

The bytes for replyText.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasAutomatedAgentReply()

public boolean hasAutomatedAgentReply()

Only set if a Dialogflow automated agent has responded. Note that: [AutomatedAgentReply.detect_intent_response.output_audio][] and [AutomatedAgentReply.detect_intent_response.output_audio_config][] are always empty, use reply_audio instead.

.google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 4;

Returns
Type Description
boolean

Whether the automatedAgentReply field is set.

hasDtmfParameters()

public boolean hasDtmfParameters()

Indicates the parameters of DTMF.

.google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 10;

Returns
Type Description
boolean

Whether the dtmfParameters field is set.

hasMessage()

public boolean hasMessage()

Message analyzed by CCAI.

.google.cloud.dialogflow.v2.Message message = 6;

Returns
Type Description
boolean

Whether the message field is set.

hasRecognitionResult()

public boolean hasRecognitionResult()

The result of speech recognition.

.google.cloud.dialogflow.v2.StreamingRecognitionResult recognition_result = 1;

Returns
Type Description
boolean

Whether the recognitionResult field is set.

hasReplyAudio()

public boolean hasReplyAudio()

The audio data bytes encoded as specified in the request. This field is set if:

  • The reply_audio_config field is specified in the request.
  • The automated agent, which this output comes from, responded with audio. In such case, the reply_audio.config field contains settings used to synthesize the speech. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

.google.cloud.dialogflow.v2.OutputAudio reply_audio = 3;

Returns
Type Description
boolean

Whether the replyAudio field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StreamingAnalyzeContentResponse.Builder newBuilderForType()
Returns
Type Description
StreamingAnalyzeContentResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StreamingAnalyzeContentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StreamingAnalyzeContentResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StreamingAnalyzeContentResponse.Builder toBuilder()
Returns
Type Description
StreamingAnalyzeContentResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException