Package com.google.cloud.dialogflow.v2

Class StreamingAnalyzeContentResponse

  • All Implemented Interfaces:
    StreamingAnalyzeContentResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class StreamingAnalyzeContentResponse
extends com.google.protobuf.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.v2.StreamingAnalyzeContentResponse
    See Also:
    Serialized Form

    • Field Detail

      • RECOGNITION_RESULT_FIELD_NUMBER

        public static final int RECOGNITION_RESULT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPLY_TEXT_FIELD_NUMBER

        public static final int REPLY_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPLY_AUDIO_FIELD_NUMBER

        public static final int REPLY_AUDIO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTOMATED_AGENT_REPLY_FIELD_NUMBER

        public static final int AUTOMATED_AGENT_REPLY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER

        public static final int HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • END_USER_SUGGESTION_RESULTS_FIELD_NUMBER

        public static final int END_USER_SUGGESTION_RESULTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DTMF_PARAMETERS_FIELD_NUMBER

        public static final int DTMF_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEBUGGING_INFO_FIELD_NUMBER

        public static final int DEBUGGING_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasRecognitionResult

        public boolean hasRecognitionResult()
         The result of speech recognition.
        .google.cloud.dialogflow.v2.StreamingRecognitionResult recognition_result = 1;
        Specified by:
        hasRecognitionResult in interface StreamingAnalyzeContentResponseOrBuilder
        Returns:
        Whether the recognitionResult field is set.

      • getReplyTextBytes

        public com.google.protobuf.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;
        Specified by:
        getReplyTextBytes in interface StreamingAnalyzeContentResponseOrBuilder
        Returns:
        The bytes for replyText.

      • 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;
        Specified by:
        hasReplyAudio in interface StreamingAnalyzeContentResponseOrBuilder
        Returns:
        Whether the replyAudio field is set.

      • 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;
        Specified by:
        getReplyAudio in interface StreamingAnalyzeContentResponseOrBuilder
        Returns:
        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;
        Specified by:
        getReplyAudioOrBuilder in interface StreamingAnalyzeContentResponseOrBuilder

      • 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][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.reply_audio]
 instead.
        .google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 4;
        Specified by:
        hasAutomatedAgentReply in interface StreamingAnalyzeContentResponseOrBuilder
        Returns:
        Whether the automatedAgentReply field is set.

      • 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][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.reply_audio]
 instead.
        .google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 4;
        Specified by:
        getAutomatedAgentReply in interface StreamingAnalyzeContentResponseOrBuilder
        Returns:
        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][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.reply_audio]
 instead.
        .google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 4;
        Specified by:
        getAutomatedAgentReplyOrBuilder in interface StreamingAnalyzeContentResponseOrBuilder

      • getHumanAgentSuggestionResultsList

        public List<SuggestionResult> getHumanAgentSuggestionResultsList()
         The suggestions for most recent human agent. The order is the same as
 [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.human_agent_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;
        Specified by:
        getHumanAgentSuggestionResultsList in interface StreamingAnalyzeContentResponseOrBuilder

      • getHumanAgentSuggestionResultsOrBuilderList

        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.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.human_agent_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;
        Specified by:
        getHumanAgentSuggestionResultsOrBuilderList in interface StreamingAnalyzeContentResponseOrBuilder

      • getHumanAgentSuggestionResultsCount

        public int getHumanAgentSuggestionResultsCount()
         The suggestions for most recent human agent. The order is the same as
 [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.human_agent_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;
        Specified by:
        getHumanAgentSuggestionResultsCount in interface StreamingAnalyzeContentResponseOrBuilder

      • getHumanAgentSuggestionResults

        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.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.human_agent_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;
        Specified by:
        getHumanAgentSuggestionResults in interface StreamingAnalyzeContentResponseOrBuilder

      • getHumanAgentSuggestionResultsOrBuilder

        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.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.human_agent_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 7;
        Specified by:
        getHumanAgentSuggestionResultsOrBuilder in interface StreamingAnalyzeContentResponseOrBuilder

      • getEndUserSuggestionResultsList

        public List<SuggestionResult> getEndUserSuggestionResultsList()
         The suggestions for end user. The order is the same as
 [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.end_user_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;
        Specified by:
        getEndUserSuggestionResultsList in interface StreamingAnalyzeContentResponseOrBuilder

      • getEndUserSuggestionResultsOrBuilderList

        public List<? extends SuggestionResultOrBuilder> getEndUserSuggestionResultsOrBuilderList()
         The suggestions for end user. The order is the same as
 [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.end_user_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;
        Specified by:
        getEndUserSuggestionResultsOrBuilderList in interface StreamingAnalyzeContentResponseOrBuilder

      • getEndUserSuggestionResultsCount

        public int getEndUserSuggestionResultsCount()
         The suggestions for end user. The order is the same as
 [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.end_user_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;
        Specified by:
        getEndUserSuggestionResultsCount in interface StreamingAnalyzeContentResponseOrBuilder

      • getEndUserSuggestionResults

        public SuggestionResult getEndUserSuggestionResults​(int index)
         The suggestions for end user. The order is the same as
 [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.end_user_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;
        Specified by:
        getEndUserSuggestionResults in interface StreamingAnalyzeContentResponseOrBuilder

      • getEndUserSuggestionResultsOrBuilder

        public SuggestionResultOrBuilder getEndUserSuggestionResultsOrBuilder​(int index)
         The suggestions for end user. The order is the same as
 [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs]
 of
 [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.end_user_suggestion_config].
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 8;
        Specified by:
        getEndUserSuggestionResultsOrBuilder in interface StreamingAnalyzeContentResponseOrBuilder

      • hasDtmfParameters

        public boolean hasDtmfParameters()
         Indicates the parameters of DTMF.
        .google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 10;
        Specified by:
        hasDtmfParameters in interface StreamingAnalyzeContentResponseOrBuilder
        Returns:
        Whether the dtmfParameters field is set.

      • hasDebuggingInfo

        public boolean hasDebuggingInfo()
         Debugging info that would get populated when
 `StreamingAnalyzeContentRequest.enable_debugging_info` is set to true.
        .google.cloud.dialogflow.v2.CloudConversationDebuggingInfo debugging_info = 11;
        Specified by:
        hasDebuggingInfo in interface StreamingAnalyzeContentResponseOrBuilder
        Returns:
        Whether the debuggingInfo field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static StreamingAnalyzeContentResponse parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingAnalyzeContentResponse parseFrom​(ByteBuffer data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingAnalyzeContentResponse parseFrom​(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingAnalyzeContentResponse parseFrom​(com.google.protobuf.ByteString data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingAnalyzeContentResponse parseFrom​(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingAnalyzeContentResponse parseFrom​(byte[] data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public StreamingAnalyzeContentResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public StreamingAnalyzeContentResponse.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected StreamingAnalyzeContentResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<StreamingAnalyzeContentResponse> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public StreamingAnalyzeContentResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder