Interface AnalyzeContentResponseOrBuilder (4.5.11)

Version 4.5.11

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface AnalyzeContentResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutomatedAgentReply()

public abstract 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 instead.

.google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 3;

Returns

Type	Description
AutomatedAgentReply	The automatedAgentReply.

getAutomatedAgentReplyOrBuilder()

public abstract 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 instead.

.google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 3;

Returns

Type	Description
AutomatedAgentReplyOrBuilder

getDtmfParameters()

public abstract DtmfParameters getDtmfParameters()

Indicates the parameters of DTMF.

.google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;

Returns

Type	Description
DtmfParameters	The dtmfParameters.

getDtmfParametersOrBuilder()

public abstract DtmfParametersOrBuilder getDtmfParametersOrBuilder()

Indicates the parameters of DTMF.

.google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;

Returns

Type	Description
DtmfParametersOrBuilder

getEndUserSuggestionResults(int index)

public abstract SuggestionResult getEndUserSuggestionResults(int index)

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Parameter

Name	Description
index	int

Returns

Type	Description
SuggestionResult

getEndUserSuggestionResultsCount()

public abstract int getEndUserSuggestionResultsCount()

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Returns

Type	Description
int

getEndUserSuggestionResultsList()

public abstract List<SuggestionResult> getEndUserSuggestionResultsList()

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Returns

Type	Description
List<SuggestionResult>

getEndUserSuggestionResultsOrBuilder(int index)

public abstract SuggestionResultOrBuilder getEndUserSuggestionResultsOrBuilder(int index)

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Parameter

Name	Description
index	int

Returns

Type	Description
SuggestionResultOrBuilder

getEndUserSuggestionResultsOrBuilderList()

public abstract List<? extends SuggestionResultOrBuilder> getEndUserSuggestionResultsOrBuilderList()

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Returns

Type	Description
List<? extends com.google.cloud.dialogflow.v2beta1.SuggestionResultOrBuilder>

getHumanAgentSuggestionResults(int index)

public abstract SuggestionResult getHumanAgentSuggestionResults(int index)

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Parameter

Name	Description
index	int

Returns

Type	Description
SuggestionResult

getHumanAgentSuggestionResultsCount()

public abstract int getHumanAgentSuggestionResultsCount()

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Returns

Type	Description
int

getHumanAgentSuggestionResultsList()

public abstract List<SuggestionResult> getHumanAgentSuggestionResultsList()

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Returns

Type	Description
List<SuggestionResult>

getHumanAgentSuggestionResultsOrBuilder(int index)

public abstract SuggestionResultOrBuilder getHumanAgentSuggestionResultsOrBuilder(int index)

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Parameter

Name	Description
index	int

Returns

Type	Description
SuggestionResultOrBuilder

getHumanAgentSuggestionResultsOrBuilderList()

public abstract List<? extends SuggestionResultOrBuilder> getHumanAgentSuggestionResultsOrBuilderList()

The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of 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;

Returns

Type	Description
List<? extends com.google.cloud.dialogflow.v2beta1.SuggestionResultOrBuilder>

getMessage()

public abstract Message getMessage()

Output only. Message analyzed by CCAI.

.google.cloud.dialogflow.v2beta1.Message message = 5;

Returns

Type	Description
Message	The message.

getMessageOrBuilder()

public abstract MessageOrBuilder getMessageOrBuilder()

Output only. Message analyzed by CCAI.

.google.cloud.dialogflow.v2beta1.Message message = 5;

Returns

Type	Description
MessageOrBuilder

getReplyAudio()

public abstract 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

Type	Description
OutputAudio	The replyAudio.

getReplyAudioOrBuilder()

public abstract 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;

Returns

Type	Description
OutputAudioOrBuilder

getReplyText()

public abstract 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

Type	Description
String	The replyText.

getReplyTextBytes()

public abstract 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

Type	Description
ByteString	The bytes for replyText.

hasAutomatedAgentReply()

public abstract 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 instead.

.google.cloud.dialogflow.v2beta1.AutomatedAgentReply automated_agent_reply = 3;

Returns

Type	Description
boolean	Whether the automatedAgentReply field is set.

hasDtmfParameters()

public abstract boolean hasDtmfParameters()

Indicates the parameters of DTMF.

.google.cloud.dialogflow.v2beta1.DtmfParameters dtmf_parameters = 9;

Returns

Type	Description
boolean	Whether the dtmfParameters field is set.

hasMessage()

public abstract boolean hasMessage()

Output only. Message analyzed by CCAI.

.google.cloud.dialogflow.v2beta1.Message message = 5;

Returns

Type	Description
boolean	Whether the message field is set.

hasReplyAudio()

public abstract 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

Type	Description
boolean	Whether the replyAudio field is set.