Class AnalyzeContentResponse (4.40.0)

public final class AnalyzeContentResponse extends GeneratedMessageV3 implements AnalyzeContentResponseOrBuilder

The response message for Participants.AnalyzeContent.

Protobuf type google.cloud.dialogflow.v2.AnalyzeContentResponse

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

AUTOMATED_AGENT_REPLY_FIELD_NUMBER

public static final int AUTOMATED_AGENT_REPLY_FIELD_NUMBER
Field Value
Type Description
int

DTMF_PARAMETERS_FIELD_NUMBER

public static final int DTMF_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

END_USER_SUGGESTION_RESULTS_FIELD_NUMBER

public static final int END_USER_SUGGESTION_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER

public static final int HUMAN_AGENT_SUGGESTION_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

REPLY_AUDIO_FIELD_NUMBER

public static final int REPLY_AUDIO_FIELD_NUMBER
Field Value
Type Description
int

REPLY_TEXT_FIELD_NUMBER

public static final int REPLY_TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnalyzeContentResponse getDefaultInstance()
Returns
Type Description
AnalyzeContentResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnalyzeContentResponse.Builder newBuilder()
Returns
Type Description
AnalyzeContentResponse.Builder

newBuilder(AnalyzeContentResponse prototype)

public static AnalyzeContentResponse.Builder newBuilder(AnalyzeContentResponse prototype)
Parameter
Name Description
prototype AnalyzeContentResponse
Returns
Type Description
AnalyzeContentResponse.Builder

parseDelimitedFrom(InputStream input)

public static AnalyzeContentResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeContentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnalyzeContentResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeContentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnalyzeContentResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeContentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnalyzeContentResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeContentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnalyzeContentResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeContentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnalyzeContentResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeContentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnalyzeContentResponse> parser()
Returns
Type Description
Parser<AnalyzeContentResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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

Returns
Type Description
AutomatedAgentReply

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

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

Returns
Type Description
AutomatedAgentReplyOrBuilder

getDefaultInstanceForType()

public AnalyzeContentResponse getDefaultInstanceForType()
Returns
Type Description
AnalyzeContentResponse

getDtmfParameters()

public DtmfParameters getDtmfParameters()

Indicates the parameters of DTMF.

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

Returns
Type Description
DtmfParameters

The dtmfParameters.

getDtmfParametersOrBuilder()

public DtmfParametersOrBuilder getDtmfParametersOrBuilder()

Indicates the parameters of DTMF.

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

Returns
Type Description
DtmfParametersOrBuilder

getEndUserSuggestionResults(int index)

public 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.v2.SuggestionResult end_user_suggestion_results = 7;

Parameter
Name Description
index int
Returns
Type Description
SuggestionResult

getEndUserSuggestionResultsCount()

public 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.v2.SuggestionResult end_user_suggestion_results = 7;

Returns
Type Description
int

getEndUserSuggestionResultsList()

public 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.v2.SuggestionResult end_user_suggestion_results = 7;

Returns
Type Description
List<SuggestionResult>

getEndUserSuggestionResultsOrBuilder(int index)

public 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.v2.SuggestionResult end_user_suggestion_results = 7;

Parameter
Name Description
index int
Returns
Type Description
SuggestionResultOrBuilder

getEndUserSuggestionResultsOrBuilderList()

public 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.v2.SuggestionResult end_user_suggestion_results = 7;

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

getHumanAgentSuggestionResults(int index)

public 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.v2.SuggestionResult human_agent_suggestion_results = 6;

Parameter
Name Description
index int
Returns
Type Description
SuggestionResult

getHumanAgentSuggestionResultsCount()

public 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.v2.SuggestionResult human_agent_suggestion_results = 6;

Returns
Type Description
int

getHumanAgentSuggestionResultsList()

public 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.v2.SuggestionResult human_agent_suggestion_results = 6;

Returns
Type Description
List<SuggestionResult>

getHumanAgentSuggestionResultsOrBuilder(int index)

public 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.v2.SuggestionResult human_agent_suggestion_results = 6;

Parameter
Name Description
index int
Returns
Type Description
SuggestionResultOrBuilder

getHumanAgentSuggestionResultsOrBuilderList()

public 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.v2.SuggestionResult human_agent_suggestion_results = 6;

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

getMessage()

public Message getMessage()

Message analyzed by CCAI.

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

Returns
Type Description
Message

The message.

getMessageOrBuilder()

public MessageOrBuilder getMessageOrBuilder()

Message analyzed by CCAI.

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

Returns
Type Description
MessageOrBuilder

getParserForType()

public Parser<AnalyzeContentResponse> getParserForType()
Returns
Type Description
Parser<AnalyzeContentResponse>
Overrides

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;

Returns
Type Description
OutputAudio

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;

Returns
Type Description
OutputAudioOrBuilder

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;

Returns
Type Description
String

The replyText.

getReplyTextBytes()

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

Returns
Type Description
ByteString

The bytes for replyText.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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

Returns
Type Description
boolean

Whether the automatedAgentReply field is set.

hasDtmfParameters()

public boolean hasDtmfParameters()

Indicates the parameters of DTMF.

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

Returns
Type Description
boolean

Whether the dtmfParameters field is set.

hasMessage()

public boolean hasMessage()

Message analyzed by CCAI.

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

Returns
Type Description
boolean

Whether the message field is set.

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;

Returns
Type Description
boolean

Whether the replyAudio field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnalyzeContentResponse.Builder newBuilderForType()
Returns
Type Description
AnalyzeContentResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnalyzeContentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnalyzeContentResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnalyzeContentResponse.Builder toBuilder()
Returns
Type Description
AnalyzeContentResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException