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_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.v2beta1.StreamingAnalyzeContentResponse
Modifier and Type | Class and Description |
---|---|
static class |
StreamingAnalyzeContentResponse.Builder
The top-level message returned from the `StreamingAnalyzeContent` method.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
AUTOMATED_AGENT_REPLY_FIELD_NUMBER |
static int |
DTMF_PARAMETERS_FIELD_NUMBER |
static int |
END_USER_SUGGESTION_RESULTS_FIELD_NUMBER |
static int |
HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER |
static int |
MESSAGE_FIELD_NUMBER |
static int |
RECOGNITION_RESULT_FIELD_NUMBER |
static int |
REPLY_AUDIO_FIELD_NUMBER |
static int |
REPLY_TEXT_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int RECOGNITION_RESULT_FIELD_NUMBER
public static final int REPLY_TEXT_FIELD_NUMBER
public static final int REPLY_AUDIO_FIELD_NUMBER
public static final int AUTOMATED_AGENT_REPLY_FIELD_NUMBER
public static final int MESSAGE_FIELD_NUMBER
public static final int HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER
public static final int END_USER_SUGGESTION_RESULTS_FIELD_NUMBER
public static final int DTMF_PARAMETERS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public boolean hasRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 1;
hasRecognitionResult
in interface StreamingAnalyzeContentResponseOrBuilder
public StreamingRecognitionResult getRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 1;
getRecognitionResult
in interface StreamingAnalyzeContentResponseOrBuilder
public StreamingRecognitionResultOrBuilder getRecognitionResultOrBuilder()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 1;
getRecognitionResultOrBuilder
in interface StreamingAnalyzeContentResponseOrBuilder
public String getReplyText()
Optional. The output text content. This field is set if an automated agent responded with a text for the user.
string reply_text = 2;
getReplyText
in interface StreamingAnalyzeContentResponseOrBuilder
public ByteString getReplyTextBytes()
Optional. The output text content. This field is set if an automated agent responded with a text for the user.
string reply_text = 2;
getReplyTextBytes
in interface StreamingAnalyzeContentResponseOrBuilder
public boolean hasReplyAudio()
Optional. 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.v2beta1.OutputAudio reply_audio = 3;
hasReplyAudio
in interface StreamingAnalyzeContentResponseOrBuilder
public OutputAudio getReplyAudio()
Optional. 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.v2beta1.OutputAudio reply_audio = 3;
getReplyAudio
in interface StreamingAnalyzeContentResponseOrBuilder
public OutputAudioOrBuilder getReplyAudioOrBuilder()
Optional. 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.v2beta1.OutputAudio reply_audio = 3;
getReplyAudioOrBuilder
in interface StreamingAnalyzeContentResponseOrBuilder
public boolean hasAutomatedAgentReply()
Optional. 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][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentResponse.reply_audio] instead.
.google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 4;
hasAutomatedAgentReply
in interface StreamingAnalyzeContentResponseOrBuilder
public AutomatedAgentReply getAutomatedAgentReply()
Optional. 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][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentResponse.reply_audio] instead.
.google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 4;
getAutomatedAgentReply
in interface StreamingAnalyzeContentResponseOrBuilder
public AutomatedAgentReplyOrBuilder getAutomatedAgentReplyOrBuilder()
Optional. 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][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentResponse.reply_audio] instead.
.google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 4;
getAutomatedAgentReplyOrBuilder
in interface StreamingAnalyzeContentResponseOrBuilder
public boolean hasMessage()
Output only. Message analyzed by CCAI.
.google.cloud.dialogflow.v2beta1.Message message = 6;
hasMessage
in interface StreamingAnalyzeContentResponseOrBuilder
public Message getMessage()
Output only. Message analyzed by CCAI.
.google.cloud.dialogflow.v2beta1.Message message = 6;
getMessage
in interface StreamingAnalyzeContentResponseOrBuilder
public MessageOrBuilder getMessageOrBuilder()
Output only. Message analyzed by CCAI.
.google.cloud.dialogflow.v2beta1.Message message = 6;
getMessageOrBuilder
in interface StreamingAnalyzeContentResponseOrBuilder
public List<SuggestionResult> getHumanAgentSuggestionResultsList()
The suggestions for most recent human agent. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.human_agent_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult human_agent_suggestion_results = 7;
getHumanAgentSuggestionResultsList
in interface StreamingAnalyzeContentResponseOrBuilder
public List<? extends SuggestionResultOrBuilder> getHumanAgentSuggestionResultsOrBuilderList()
The suggestions for most recent human agent. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.human_agent_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult human_agent_suggestion_results = 7;
getHumanAgentSuggestionResultsOrBuilderList
in interface StreamingAnalyzeContentResponseOrBuilder
public int getHumanAgentSuggestionResultsCount()
The suggestions for most recent human agent. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.human_agent_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult human_agent_suggestion_results = 7;
getHumanAgentSuggestionResultsCount
in interface StreamingAnalyzeContentResponseOrBuilder
public SuggestionResult getHumanAgentSuggestionResults(int index)
The suggestions for most recent human agent. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.human_agent_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult human_agent_suggestion_results = 7;
getHumanAgentSuggestionResults
in interface StreamingAnalyzeContentResponseOrBuilder
public SuggestionResultOrBuilder getHumanAgentSuggestionResultsOrBuilder(int index)
The suggestions for most recent human agent. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.human_agent_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult human_agent_suggestion_results = 7;
getHumanAgentSuggestionResultsOrBuilder
in interface StreamingAnalyzeContentResponseOrBuilder
public List<SuggestionResult> getEndUserSuggestionResultsList()
The suggestions for end user. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.end_user_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult end_user_suggestion_results = 8;
getEndUserSuggestionResultsList
in interface StreamingAnalyzeContentResponseOrBuilder
public List<? extends SuggestionResultOrBuilder> getEndUserSuggestionResultsOrBuilderList()
The suggestions for end user. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.end_user_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult end_user_suggestion_results = 8;
getEndUserSuggestionResultsOrBuilderList
in interface StreamingAnalyzeContentResponseOrBuilder
public int getEndUserSuggestionResultsCount()
The suggestions for end user. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.end_user_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult end_user_suggestion_results = 8;
getEndUserSuggestionResultsCount
in interface StreamingAnalyzeContentResponseOrBuilder
public SuggestionResult getEndUserSuggestionResults(int index)
The suggestions for end user. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.end_user_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult end_user_suggestion_results = 8;
getEndUserSuggestionResults
in interface StreamingAnalyzeContentResponseOrBuilder
public SuggestionResultOrBuilder getEndUserSuggestionResultsOrBuilder(int index)
The suggestions for end user. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.end_user_suggestion_config].
repeated .google.cloud.dialogflow.v2beta1.SuggestionResult end_user_suggestion_results = 8;
getEndUserSuggestionResultsOrBuilder
in interface StreamingAnalyzeContentResponseOrBuilder
public boolean hasDtmfParameters()
Indicates the parameters of DTMF.
.google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 10;
hasDtmfParameters
in interface StreamingAnalyzeContentResponseOrBuilder
public DtmfParameters getDtmfParameters()
Indicates the parameters of DTMF.
.google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 10;
getDtmfParameters
in interface StreamingAnalyzeContentResponseOrBuilder
public DtmfParametersOrBuilder getDtmfParametersOrBuilder()
Indicates the parameters of DTMF.
.google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 10;
getDtmfParametersOrBuilder
in interface StreamingAnalyzeContentResponseOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static StreamingAnalyzeContentResponse parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentResponse parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentResponse parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingAnalyzeContentResponse parseFrom(InputStream input) throws IOException
IOException
public static StreamingAnalyzeContentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StreamingAnalyzeContentResponse parseDelimitedFrom(InputStream input) throws IOException
IOException
public static StreamingAnalyzeContentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StreamingAnalyzeContentResponse parseFrom(CodedInputStream input) throws IOException
IOException
public static StreamingAnalyzeContentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public StreamingAnalyzeContentResponse.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static StreamingAnalyzeContentResponse.Builder newBuilder()
public static StreamingAnalyzeContentResponse.Builder newBuilder(StreamingAnalyzeContentResponse prototype)
public StreamingAnalyzeContentResponse.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected StreamingAnalyzeContentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static StreamingAnalyzeContentResponse getDefaultInstance()
public static Parser<StreamingAnalyzeContentResponse> parser()
public Parser<StreamingAnalyzeContentResponse> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public StreamingAnalyzeContentResponse getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.