com.google.cloud.dialogflow.v2beta1.AnalyzeContentResponseOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-v2beta1 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2beta1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2beta1/participant.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.v2beta1;
public interface AnalyzeContentResponseOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2beta1.AnalyzeContentResponse)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The replyText.
*/
java.lang.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;
*
* @return The bytes for replyText.
*/
com.google.protobuf.ByteString getReplyTextBytes();
/**
*
*
*
* 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;
*
* @return Whether the replyAudio field is set.
*/
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;
*
* @return The replyAudio.
*/
com.google.cloud.dialogflow.v2beta1.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;
*/
com.google.cloud.dialogflow.v2beta1.OutputAudioOrBuilder getReplyAudioOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the automatedAgentReply field is set.
*/
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;
*
* @return The automatedAgentReply.
*/
com.google.cloud.dialogflow.v2beta1.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;
*/
com.google.cloud.dialogflow.v2beta1.AutomatedAgentReplyOrBuilder
getAutomatedAgentReplyOrBuilder();
/**
*
*
*
* Output only. Message analyzed by CCAI.
*
*
* .google.cloud.dialogflow.v2beta1.Message message = 5;
*
* @return Whether the message field is set.
*/
boolean hasMessage();
/**
*
*
*
* Output only. Message analyzed by CCAI.
*
*
* .google.cloud.dialogflow.v2beta1.Message message = 5;
*
* @return The message.
*/
com.google.cloud.dialogflow.v2beta1.Message getMessage();
/**
*
*
*
* Output only. Message analyzed by CCAI.
*
*
* .google.cloud.dialogflow.v2beta1.Message message = 5;
*/
com.google.cloud.dialogflow.v2beta1.MessageOrBuilder getMessageOrBuilder();
/**
*
*
*
* 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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.dialogflow.v2beta1.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;
*
*/
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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.dialogflow.v2beta1.SuggestionResultOrBuilder
getHumanAgentSuggestionResultsOrBuilder(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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.dialogflow.v2beta1.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;
*
*/
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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.dialogflow.v2beta1.SuggestionResultOrBuilder
getEndUserSuggestionResultsOrBuilder(int index);
/**
*
*
*
* Indicates the parameters of DTMF.
*
*
* .google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;
*
* @return Whether the dtmfParameters field is set.
*/
boolean hasDtmfParameters();
/**
*
*
*
* Indicates the parameters of DTMF.
*
*
* .google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;
*
* @return The dtmfParameters.
*/
com.google.cloud.dialogflow.v2beta1.DtmfParameters getDtmfParameters();
/**
*
*
*
* Indicates the parameters of DTMF.
*
*
* .google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;
*/
com.google.cloud.dialogflow.v2beta1.DtmfParametersOrBuilder getDtmfParametersOrBuilder();
}