Class AnalyzeContentRequest (4.61.0) 

public final class AnalyzeContentRequest extends GeneratedMessageV3 implements AnalyzeContentRequestOrBuilder

The request message for Participants.AnalyzeContent.

Protobuf type google.cloud.dialogflow.v2beta1.AnalyzeContentRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AnalyzeContentRequest

Static Fields

ASSIST_QUERY_PARAMS_FIELD_NUMBER

public static final int ASSIST_QUERY_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

AUDIO_INPUT_FIELD_NUMBER

public static final int AUDIO_INPUT_FIELD_NUMBER
Field Value
Type Description
int

CX_CURRENT_PAGE_FIELD_NUMBER

public static final int CX_CURRENT_PAGE_FIELD_NUMBER
Field Value
Type Description
int

CX_PARAMETERS_FIELD_NUMBER

public static final int CX_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

EVENT_INPUT_FIELD_NUMBER

public static final int EVENT_INPUT_FIELD_NUMBER
Field Value
Type Description
int

INTENT_INPUT_FIELD_NUMBER

public static final int INTENT_INPUT_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_SEND_TIME_FIELD_NUMBER

public static final int MESSAGE_SEND_TIME_FIELD_NUMBER
Field Value
Type Description
int

PARTICIPANT_FIELD_NUMBER

public static final int PARTICIPANT_FIELD_NUMBER
Field Value
Type Description
int

QUERY_PARAMS_FIELD_NUMBER

public static final int QUERY_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

REPLY_AUDIO_CONFIG_FIELD_NUMBER

public static final int REPLY_AUDIO_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

SUGGESTION_INPUT_FIELD_NUMBER

public static final int SUGGESTION_INPUT_FIELD_NUMBER
Field Value
Type Description
int

TEXT_INPUT_FIELD_NUMBER

public static final int TEXT_INPUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnalyzeContentRequest getDefaultInstance()
Returns
Type Description
AnalyzeContentRequest

getDescriptor()

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

newBuilder()

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

newBuilder(AnalyzeContentRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAssistQueryParams()

public AssistQueryParameters getAssistQueryParams()

Parameters for a human assist query.

.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;

Returns
Type Description
AssistQueryParameters

The assistQueryParams.

getAssistQueryParamsOrBuilder()

public AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()

Parameters for a human assist query.

.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;

Returns
Type Description
AssistQueryParametersOrBuilder

getAudioInput()

public AudioInput getAudioInput()

The natural language speech audio to be processed.

.google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;

Returns
Type Description
AudioInput

The audioInput.

getAudioInputOrBuilder()

public AudioInputOrBuilder getAudioInputOrBuilder()

The natural language speech audio to be processed.

.google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;

Returns
Type Description
AudioInputOrBuilder

getCxCurrentPage()

public String getCxCurrentPage()

The unique identifier of the CX page to override the current_page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If cx_current_page is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, cx_current_page and cx_parameters should be configured together to direct a session to a specific state.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

string cx_current_page = 20;

Returns
Type Description
String

The cxCurrentPage.

getCxCurrentPageBytes()

public ByteString getCxCurrentPageBytes()

The unique identifier of the CX page to override the current_page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If cx_current_page is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, cx_current_page and cx_parameters should be configured together to direct a session to a specific state.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

string cx_current_page = 20;

Returns
Type Description
ByteString

The bytes for cxCurrentPage.

getCxParameters()

public Struct getCxParameters()

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 18;

Returns
Type Description
Struct

The cxParameters.

getCxParametersOrBuilder()

public StructOrBuilder getCxParametersOrBuilder()

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 18;

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public AnalyzeContentRequest getDefaultInstanceForType()
Returns
Type Description
AnalyzeContentRequest

getEventInput()

public EventInput getEventInput()

An input event to send to Dialogflow.

.google.cloud.dialogflow.v2beta1.EventInput event_input = 8;

Returns
Type Description
EventInput

The eventInput.

getEventInputOrBuilder()

public EventInputOrBuilder getEventInputOrBuilder()

An input event to send to Dialogflow.

.google.cloud.dialogflow.v2beta1.EventInput event_input = 8;

Returns
Type Description
EventInputOrBuilder

getInputCase()

public AnalyzeContentRequest.InputCase getInputCase()
Returns
Type Description
AnalyzeContentRequest.InputCase

getIntentInput()

public IntentInput getIntentInput()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 13;

Returns
Type Description
IntentInput

The intentInput.

getIntentInputOrBuilder()

public IntentInputOrBuilder getIntentInputOrBuilder()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 13;

Returns
Type Description
IntentInputOrBuilder

getMessageSendTime()

public Timestamp getMessageSendTime()

Optional. The send time of the message from end user or human agent's perspective. It is used for identifying the same message under one participant.

Given two messages under the same participant:

  • If send time are different regardless of whether the content of the messages are exactly the same, the conversation will regard them as two distinct messages sent by the participant.

  • If send time is the same regardless of whether the content of the messages are exactly the same, the conversation will regard them as same message, and ignore the message received later.

    If the value is not provided, a new request will always be regarded as a new message without any de-duplication.

.google.protobuf.Timestamp message_send_time = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The messageSendTime.

getMessageSendTimeOrBuilder()

public TimestampOrBuilder getMessageSendTimeOrBuilder()

Optional. The send time of the message from end user or human agent's perspective. It is used for identifying the same message under one participant.

Given two messages under the same participant:

  • If send time are different regardless of whether the content of the messages are exactly the same, the conversation will regard them as two distinct messages sent by the participant.

  • If send time is the same regardless of whether the content of the messages are exactly the same, the conversation will regard them as same message, and ignore the message received later.

    If the value is not provided, a new request will always be regarded as a new message without any de-duplication.

.google.protobuf.Timestamp message_send_time = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getParserForType()

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

getParticipant()

public String getParticipant()

Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The participant.

getParticipantBytes()

public ByteString getParticipantBytes()

Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for participant.

getQueryParams()

public QueryParameters getQueryParams()

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;

Returns
Type Description
QueryParameters

The queryParams.

getQueryParamsOrBuilder()

public QueryParametersOrBuilder getQueryParamsOrBuilder()

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;

Returns
Type Description
QueryParametersOrBuilder

getReplyAudioConfig()

public OutputAudioConfig getReplyAudioConfig()

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;

Returns
Type Description
OutputAudioConfig

The replyAudioConfig.

getReplyAudioConfigOrBuilder()

public OutputAudioConfigOrBuilder getReplyAudioConfigOrBuilder()

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;

Returns
Type Description
OutputAudioConfigOrBuilder

getRequestId()

public String getRequestId()

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.

string request_id = 11;

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.

string request_id = 11;

Returns
Type Description
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSuggestionInput()

public SuggestionInput getSuggestionInput()

An input representing the selection of a suggestion.

.google.cloud.dialogflow.v2beta1.SuggestionInput suggestion_input = 12;

Returns
Type Description
SuggestionInput

The suggestionInput.

getSuggestionInputOrBuilder()

public SuggestionInputOrBuilder getSuggestionInputOrBuilder()

An input representing the selection of a suggestion.

.google.cloud.dialogflow.v2beta1.SuggestionInput suggestion_input = 12;

Returns
Type Description
SuggestionInputOrBuilder

getTextInput()

public TextInput getTextInput()

The natural language text to be processed.

.google.cloud.dialogflow.v2beta1.TextInput text_input = 6;

Returns
Type Description
TextInput

The textInput.

getTextInputOrBuilder()

public TextInputOrBuilder getTextInputOrBuilder()

The natural language text to be processed.

.google.cloud.dialogflow.v2beta1.TextInput text_input = 6;

Returns
Type Description
TextInputOrBuilder

hasAssistQueryParams()

public boolean hasAssistQueryParams()

Parameters for a human assist query.

.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;

Returns
Type Description
boolean

Whether the assistQueryParams field is set.

hasAudioInput()

public boolean hasAudioInput()

The natural language speech audio to be processed.

.google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;

Returns
Type Description
boolean

Whether the audioInput field is set.

hasCxParameters()

public boolean hasCxParameters()

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

.google.protobuf.Struct cx_parameters = 18;

Returns
Type Description
boolean

Whether the cxParameters field is set.

hasEventInput()

public boolean hasEventInput()

An input event to send to Dialogflow.

.google.cloud.dialogflow.v2beta1.EventInput event_input = 8;

Returns
Type Description
boolean

Whether the eventInput field is set.

hasIntentInput()

public boolean hasIntentInput()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 13;

Returns
Type Description
boolean

Whether the intentInput field is set.

hasMessageSendTime()

public boolean hasMessageSendTime()

Optional. The send time of the message from end user or human agent's perspective. It is used for identifying the same message under one participant.

Given two messages under the same participant:

  • If send time are different regardless of whether the content of the messages are exactly the same, the conversation will regard them as two distinct messages sent by the participant.

  • If send time is the same regardless of whether the content of the messages are exactly the same, the conversation will regard them as same message, and ignore the message received later.

    If the value is not provided, a new request will always be regarded as a new message without any de-duplication.

.google.protobuf.Timestamp message_send_time = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the messageSendTime field is set.

hasQueryParams()

public boolean hasQueryParams()

Parameters for a Dialogflow virtual-agent query.

.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;

Returns
Type Description
boolean

Whether the queryParams field is set.

hasReplyAudioConfig()

public boolean hasReplyAudioConfig()

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;

Returns
Type Description
boolean

Whether the replyAudioConfig field is set.

hasSuggestionInput()

public boolean hasSuggestionInput()

An input representing the selection of a suggestion.

.google.cloud.dialogflow.v2beta1.SuggestionInput suggestion_input = 12;

Returns
Type Description
boolean

Whether the suggestionInput field is set.

hasTextInput()

public boolean hasTextInput()

The natural language text to be processed.

.google.cloud.dialogflow.v2beta1.TextInput text_input = 6;

Returns
Type Description
boolean

Whether the textInput 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 AnalyzeContentRequest.Builder newBuilderForType()
Returns
Type Description
AnalyzeContentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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