Interface AnalyzeContentResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AnalyzeContentResponse, AnalyzeContentResponse.Builder

    public interface AnalyzeContentResponseOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getReplyText

        String getReplyText()
         Output only. The output text content.
         This field is set if the automated agent responded with text to show to
         the user.
         
        string reply_text = 1;
        Returns:
        The replyText.
      • getReplyTextBytes

        com.google.protobuf.ByteString getReplyTextBytes()
         Output only. The output text content.
         This field is set if the automated agent responded with text to show to
         the user.
         
        string reply_text = 1;
        Returns:
        The bytes for replyText.
      • hasReplyAudio

        boolean hasReplyAudio()
         Optional. 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.v2beta1.OutputAudio reply_audio = 2;
        Returns:
        Whether the replyAudio field is set.
      • getReplyAudio

        OutputAudio getReplyAudio()
         Optional. 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.v2beta1.OutputAudio reply_audio = 2;
        Returns:
        The replyAudio.
      • getReplyAudioOrBuilder

        OutputAudioOrBuilder getReplyAudioOrBuilder()
         Optional. 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.v2beta1.OutputAudio reply_audio = 2;
      • hasAutomatedAgentReply

        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.AnalyzeContentResponse.reply_audio]
         instead.
         
        .google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 3;
        Returns:
        Whether the automatedAgentReply field is set.
      • getAutomatedAgentReply

        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.AnalyzeContentResponse.reply_audio]
         instead.
         
        .google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 3;
        Returns:
        The automatedAgentReply.
      • getAutomatedAgentReplyOrBuilder

        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.AnalyzeContentResponse.reply_audio]
         instead.
         
        .google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 3;
      • hasMessage

        boolean hasMessage()
         Output only. Message analyzed by CCAI.
         
        .google.cloud.dialogflow.v2beta1.Message message = 5;
        Returns:
        Whether the message field is set.
      • getMessage

        Message getMessage()
         Output only. Message analyzed by CCAI.
         
        .google.cloud.dialogflow.v2beta1.Message message = 5;
        Returns:
        The message.
      • getMessageOrBuilder

        MessageOrBuilder getMessageOrBuilder()
         Output only. Message analyzed by CCAI.
         
        .google.cloud.dialogflow.v2beta1.Message message = 5;
      • getHumanAgentSuggestionResultsList

        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].
        
         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.v2beta1.SuggestionResult human_agent_suggestion_results = 6;
      • getHumanAgentSuggestionResults

        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].
        
         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.v2beta1.SuggestionResult human_agent_suggestion_results = 6;
      • getHumanAgentSuggestionResultsCount

        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].
        
         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.v2beta1.SuggestionResult human_agent_suggestion_results = 6;
      • getHumanAgentSuggestionResultsOrBuilderList

        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].
        
         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.v2beta1.SuggestionResult human_agent_suggestion_results = 6;
      • getHumanAgentSuggestionResultsOrBuilder

        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].
        
         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.v2beta1.SuggestionResult human_agent_suggestion_results = 6;
      • getEndUserSuggestionResultsList

        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].
        
         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.v2beta1.SuggestionResult end_user_suggestion_results = 7;
      • getEndUserSuggestionResults

        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].
        
         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.v2beta1.SuggestionResult end_user_suggestion_results = 7;
      • getEndUserSuggestionResultsCount

        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].
        
         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.v2beta1.SuggestionResult end_user_suggestion_results = 7;
      • getEndUserSuggestionResultsOrBuilderList

        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].
        
         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.v2beta1.SuggestionResult end_user_suggestion_results = 7;
      • getEndUserSuggestionResultsOrBuilder

        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].
        
         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.v2beta1.SuggestionResult end_user_suggestion_results = 7;
      • hasDtmfParameters

        boolean hasDtmfParameters()
         Indicates the parameters of DTMF.
         
        .google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;
        Returns:
        Whether the dtmfParameters field is set.
      • getDtmfParameters

        DtmfParameters getDtmfParameters()
         Indicates the parameters of DTMF.
         
        .google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;
        Returns:
        The dtmfParameters.
      • getDtmfParametersOrBuilder

        DtmfParametersOrBuilder getDtmfParametersOrBuilder()
         Indicates the parameters of DTMF.
         
        .google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;