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:
- 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
.
- 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_reply
s 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
Static Fields
AUTOMATED_AGENT_REPLY_FIELD_NUMBER
public static final int AUTOMATED_AGENT_REPLY_FIELD_NUMBER
Field Value
DTMF_PARAMETERS_FIELD_NUMBER
public static final int DTMF_PARAMETERS_FIELD_NUMBER
Field Value
END_USER_SUGGESTION_RESULTS_FIELD_NUMBER
public static final int END_USER_SUGGESTION_RESULTS_FIELD_NUMBER
Field Value
HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER
public static final int HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER
Field Value
MESSAGE_FIELD_NUMBER
public static final int MESSAGE_FIELD_NUMBER
Field Value
RECOGNITION_RESULT_FIELD_NUMBER
public static final int RECOGNITION_RESULT_FIELD_NUMBER
Field Value
REPLY_AUDIO_FIELD_NUMBER
public static final int REPLY_AUDIO_FIELD_NUMBER
Field Value
REPLY_TEXT_FIELD_NUMBER
public static final int REPLY_TEXT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static StreamingAnalyzeContentResponse getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static StreamingAnalyzeContentResponse.Builder newBuilder()
Returns
newBuilder(StreamingAnalyzeContentResponse prototype)
public static StreamingAnalyzeContentResponse.Builder newBuilder(StreamingAnalyzeContentResponse prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static StreamingAnalyzeContentResponse parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static StreamingAnalyzeContentResponse parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static StreamingAnalyzeContentResponse parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static StreamingAnalyzeContentResponse parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static StreamingAnalyzeContentResponse parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static StreamingAnalyzeContentResponse parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StreamingAnalyzeContentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<StreamingAnalyzeContentResponse> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
getDefaultInstanceForType()
public StreamingAnalyzeContentResponse getDefaultInstanceForType()
Returns
getDtmfParameters()
public DtmfParameters getDtmfParameters()
Indicates the parameters of DTMF.
.google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 10;
Returns
getDtmfParametersOrBuilder()
public DtmfParametersOrBuilder getDtmfParametersOrBuilder()
Indicates the parameters of DTMF.
.google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 10;
Returns
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
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
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
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
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
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
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
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
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
getParserForType()
public Parser<StreamingAnalyzeContentResponse> getParserForType()
Returns
Overrides
getRecognitionResult()
public StreamingRecognitionResult getRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2.StreamingRecognitionResult recognition_result = 1;
Returns
getRecognitionResultOrBuilder()
public StreamingRecognitionResultOrBuilder getRecognitionResultOrBuilder()
The result of speech recognition.
.google.cloud.dialogflow.v2.StreamingRecognitionResult recognition_result = 1;
Returns
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
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
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public StreamingAnalyzeContentResponse.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StreamingAnalyzeContentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public StreamingAnalyzeContentResponse.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions