Interface AnalyzeContentRequestOrBuilder (4.19.0)

public interface AnalyzeContentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssistQueryParams()

public abstract 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 abstract AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()

Parameters for a human assist query.

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

Returns
Type Description
AssistQueryParametersOrBuilder

getAudioInput()

public abstract 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 abstract AudioInputOrBuilder getAudioInputOrBuilder()

The natural language speech audio to be processed.

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

Returns
Type Description
AudioInputOrBuilder

getCxCurrentPage()

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

getEventInput()

public abstract 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 abstract EventInputOrBuilder getEventInputOrBuilder()

An input event to send to Dialogflow.

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

Returns
Type Description
EventInputOrBuilder

getInputCase()

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

getMessageSendTime()

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

Returns
Type Description
Timestamp

The messageSendTime.

getMessageSendTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getParticipant()

public abstract 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 abstract 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 abstract 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 abstract QueryParametersOrBuilder getQueryParamsOrBuilder()

Parameters for a Dialogflow virtual-agent query.

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

Returns
Type Description
QueryParametersOrBuilder

getReplyAudioConfig()

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

getTextInput()

public abstract 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 abstract TextInputOrBuilder getTextInputOrBuilder()

The natural language text to be processed.

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

Returns
Type Description
TextInputOrBuilder

hasAssistQueryParams()

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

hasMessageSendTime()

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

Returns
Type Description
boolean

Whether the messageSendTime field is set.

hasQueryParams()

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

hasTextInput()

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