Package com.google.cloud.dialogflow.v2

Class AnalyzeContentResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.AnalyzeContentResponse
All Implemented Interfaces:
AnalyzeContentResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AnalyzeContentResponse extends com.google.protobuf.GeneratedMessage implements AnalyzeContentResponseOrBuilder
 The response message for
 [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent].
Protobuf type google.cloud.dialogflow.v2.AnalyzeContentResponse
See Also:

  • Field Details

    • REPLY_TEXT_FIELD_NUMBER

      public static final int REPLY_TEXT_FIELD_NUMBER
      See Also:

    • REPLY_AUDIO_FIELD_NUMBER

      public static final int REPLY_AUDIO_FIELD_NUMBER
      See Also:

    • AUTOMATED_AGENT_REPLY_FIELD_NUMBER

      public static final int AUTOMATED_AGENT_REPLY_FIELD_NUMBER
      See Also:

    • MESSAGE_FIELD_NUMBER

      public static final int MESSAGE_FIELD_NUMBER
      See Also:

    • HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER

      public static final int HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER
      See Also:

    • END_USER_SUGGESTION_RESULTS_FIELD_NUMBER

      public static final int END_USER_SUGGESTION_RESULTS_FIELD_NUMBER
      See Also:

    • DTMF_PARAMETERS_FIELD_NUMBER

      public static final int DTMF_PARAMETERS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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 in [AutomatedAgentReply.DetectIntentResponse][],
 [Sessions.DetectIntentResponse.output_audio][]
 and [Sessions.DetectIntentResponse.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 in [AutomatedAgentReply.DetectIntentResponse][],
 [Sessions.DetectIntentResponse.output_audio][]
 and [Sessions.DetectIntentResponse.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 in [AutomatedAgentReply.DetectIntentResponse][],
 [Sessions.DetectIntentResponse.output_audio][]
 and [Sessions.DetectIntentResponse.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.

    • getMessage

      public Message getMessage()
       Message analyzed by CCAI.
      .google.cloud.dialogflow.v2.Message message = 5;
      Specified by:
      getMessage in interface AnalyzeContentResponseOrBuilder
      Returns:
      The message.

    • getMessageOrBuilder

      public MessageOrBuilder getMessageOrBuilder()
       Message analyzed by CCAI.
      .google.cloud.dialogflow.v2.Message message = 5;
      Specified by:
      getMessageOrBuilder in interface AnalyzeContentResponseOrBuilder

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

    • getDtmfParameters

      public DtmfParameters getDtmfParameters()
       Indicates the parameters of DTMF.
      .google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 9;
      Specified by:
      getDtmfParameters in interface AnalyzeContentResponseOrBuilder
      Returns:
      The dtmfParameters.

    • getDtmfParametersOrBuilder

      public DtmfParametersOrBuilder getDtmfParametersOrBuilder()
       Indicates the parameters of DTMF.
      .google.cloud.dialogflow.v2.DtmfParameters dtmf_parameters = 9;
      Specified by:
      getDtmfParametersOrBuilder in interface AnalyzeContentResponseOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static AnalyzeContentResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AnalyzeContentResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AnalyzeContentResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AnalyzeContentResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AnalyzeContentResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AnalyzeContentResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static AnalyzeContentResponse.Builder newBuilder()

    • newBuilder

      public static AnalyzeContentResponse.Builder newBuilder(AnalyzeContentResponse prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AnalyzeContentResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AnalyzeContentResponse> parser()

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

    • getDefaultInstanceForType

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