Package com.google.cloud.dialogflow.v2

Class AnalyzeContentResponse

  • All Implemented Interfaces:
    AnalyzeContentResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AnalyzeContentResponse
extends com.google.protobuf.GeneratedMessageV3
implements AnalyzeContentResponseOrBuilder
     The response message for
 [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent].
    Protobuf type google.cloud.dialogflow.v2.AnalyzeContentResponse
    See Also:
    Serialized Form

    • Field Detail

      • 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

    • 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

      • getReplyText

        public String getReplyText()
         The output text content.
 This field is set if the automated agent responded with text to show to
 the user.
        string reply_text = 1;
        Specified by:
        getReplyText in interface AnalyzeContentResponseOrBuilder
        Returns:
        The replyText.

      • getReplyTextBytes

        public com.google.protobuf.ByteString getReplyTextBytes()
         The output text content.
 This field is set if the automated agent responded with text to show to
 the user.
        string reply_text = 1;
        Specified by:
        getReplyTextBytes in interface AnalyzeContentResponseOrBuilder
        Returns:
        The bytes for replyText.

      • hasReplyAudio

        public boolean hasReplyAudio()
         The audio data bytes encoded as specified in the request.
 This field is set if:

  - `reply_audio_config` was specified in the request, or
  - The automated agent responded with audio to play to the user. In such
    case, `reply_audio.config` 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 = 2;
        Specified by:
        hasReplyAudio in interface AnalyzeContentResponseOrBuilder
        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:

  - `reply_audio_config` was specified in the request, or
  - The automated agent responded with audio to play to the user. In such
    case, `reply_audio.config` 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 = 2;
        Specified by:
        getReplyAudio in interface AnalyzeContentResponseOrBuilder
        Returns:
        The replyAudio.

      • getReplyAudioOrBuilder

        public OutputAudioOrBuilder getReplyAudioOrBuilder()
         The audio data bytes encoded as specified in the request.
 This field is set if:

  - `reply_audio_config` was specified in the request, or
  - The automated agent responded with audio to play to the user. In such
    case, `reply_audio.config` 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 = 2;
        Specified by:
        getReplyAudioOrBuilder in interface AnalyzeContentResponseOrBuilder

      • 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.AnalyzeContentResponse.reply_audio]
 instead.
        .google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 3;
        Specified by:
        hasAutomatedAgentReply in interface AnalyzeContentResponseOrBuilder
        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.AnalyzeContentResponse.reply_audio]
 instead.
        .google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 3;
        Specified by:
        getAutomatedAgentReply in interface AnalyzeContentResponseOrBuilder
        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.AnalyzeContentResponse.reply_audio]
 instead.
        .google.cloud.dialogflow.v2.AutomatedAgentReply automated_agent_reply = 3;
        Specified by:
        getAutomatedAgentReplyOrBuilder in interface AnalyzeContentResponseOrBuilder

      • hasMessage

        public boolean hasMessage()
         Message analyzed by CCAI.
        .google.cloud.dialogflow.v2.Message message = 5;
        Specified by:
        hasMessage in interface AnalyzeContentResponseOrBuilder
        Returns:
        Whether the message field is set.

      • 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].

 Note that any failure of Agent Assist features will not lead to the overall
 failure of an AnalyzeContent API call. Instead, the features will
 fail silently with the error field set in the corresponding
 SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 6;
        Specified by:
        getHumanAgentSuggestionResultsList in interface AnalyzeContentResponseOrBuilder

      • 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].

 Note that any failure of Agent Assist features will not lead to the overall
 failure of an AnalyzeContent API call. Instead, the features will
 fail silently with the error field set in the corresponding
 SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 6;
        Specified by:
        getHumanAgentSuggestionResultsOrBuilderList in interface AnalyzeContentResponseOrBuilder

      • 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].

 Note that any failure of Agent Assist features will not lead to the overall
 failure of an AnalyzeContent API call. Instead, the features will
 fail silently with the error field set in the corresponding
 SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 6;
        Specified by:
        getHumanAgentSuggestionResultsCount in interface AnalyzeContentResponseOrBuilder

      • 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].

 Note that any failure of Agent Assist features will not lead to the overall
 failure of an AnalyzeContent API call. Instead, the features will
 fail silently with the error field set in the corresponding
 SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 6;
        Specified by:
        getHumanAgentSuggestionResults in interface AnalyzeContentResponseOrBuilder

      • 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].

 Note that any failure of Agent Assist features will not lead to the overall
 failure of an AnalyzeContent API call. Instead, the features will
 fail silently with the error field set in the corresponding
 SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult human_agent_suggestion_results = 6;
        Specified by:
        getHumanAgentSuggestionResultsOrBuilder in interface AnalyzeContentResponseOrBuilder

      • 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].

 Same as human_agent_suggestion_results, any failure of Agent Assist
 features will not lead to the overall failure of an AnalyzeContent API
 call. Instead, the features will fail silently with the error field set in
 the corresponding SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 7;
        Specified by:
        getEndUserSuggestionResultsList in interface AnalyzeContentResponseOrBuilder

      • 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].

 Same as human_agent_suggestion_results, any failure of Agent Assist
 features will not lead to the overall failure of an AnalyzeContent API
 call. Instead, the features will fail silently with the error field set in
 the corresponding SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 7;
        Specified by:
        getEndUserSuggestionResultsOrBuilderList in interface AnalyzeContentResponseOrBuilder

      • 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].

 Same as human_agent_suggestion_results, any failure of Agent Assist
 features will not lead to the overall failure of an AnalyzeContent API
 call. Instead, the features will fail silently with the error field set in
 the corresponding SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 7;
        Specified by:
        getEndUserSuggestionResultsCount in interface AnalyzeContentResponseOrBuilder

      • 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].

 Same as human_agent_suggestion_results, any failure of Agent Assist
 features will not lead to the overall failure of an AnalyzeContent API
 call. Instead, the features will fail silently with the error field set in
 the corresponding SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 7;
        Specified by:
        getEndUserSuggestionResults in interface AnalyzeContentResponseOrBuilder

      • 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].

 Same as human_agent_suggestion_results, any failure of Agent Assist
 features will not lead to the overall failure of an AnalyzeContent API
 call. Instead, the features will fail silently with the error field set in
 the corresponding SuggestionResult.
        repeated .google.cloud.dialogflow.v2.SuggestionResult end_user_suggestion_results = 7;
        Specified by:
        getEndUserSuggestionResultsOrBuilder in interface AnalyzeContentResponseOrBuilder

      • hasDtmfParameters

        public boolean hasDtmfParameters()
         Indicates the parameters of DTMF.
        .google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 9;
        Specified by:
        hasDtmfParameters in interface AnalyzeContentResponseOrBuilder
        Returns:
        Whether the dtmfParameters 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 AnalyzeContentResponse parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<AnalyzeContentResponse> 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 AnalyzeContentResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder