Interface DetectIntentRequestOrBuilder (4.27.0)

Version 4.27.0

• 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 DetectIntentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getInputAudio()

public abstract ByteString getInputAudio()

The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

bytes input_audio = 5;

Returns
Type	Description
ByteString	The inputAudio.

getOutputAudioConfig()

public abstract OutputAudioConfig getOutputAudioConfig()

Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 4;

Returns
Type	Description
OutputAudioConfig	The outputAudioConfig.

getOutputAudioConfigMask()

public abstract FieldMask getOutputAudioConfigMask()

Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

.google.protobuf.FieldMask output_audio_config_mask = 7;

Returns
Type	Description
FieldMask	The outputAudioConfigMask.

getOutputAudioConfigMaskOrBuilder()

public abstract FieldMaskOrBuilder getOutputAudioConfigMaskOrBuilder()

Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

.google.protobuf.FieldMask output_audio_config_mask = 7;

Returns
Type	Description
FieldMaskOrBuilder

getOutputAudioConfigOrBuilder()

public abstract OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()

Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 4;

Returns
Type	Description
OutputAudioConfigOrBuilder

getQueryInput()

public abstract QueryInput getQueryInput()

Required. The input specification. It can be set to:

1. an audio config which instructs the speech recognizer how to process the speech audio,

2. a conversational query in the form of text, or

3. an event that specifies which intent to trigger.

.google.cloud.dialogflow.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
QueryInput	The queryInput.

getQueryInputOrBuilder()

public abstract QueryInputOrBuilder getQueryInputOrBuilder()

Required. The input specification. It can be set to:

1. an audio config which instructs the speech recognizer how to process the speech audio,

2. a conversational query in the form of text, or

3. an event that specifies which intent to trigger.

.google.cloud.dialogflow.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
QueryInputOrBuilder

getQueryParams()

public abstract QueryParameters getQueryParams()

The parameters of this query.

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

Returns
Type	Description
QueryParameters	The queryParams.

getQueryParamsOrBuilder()

public abstract QueryParametersOrBuilder getQueryParamsOrBuilder()

The parameters of this query.

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

Returns
Type	Description
QueryParametersOrBuilder

getSession()

public abstract String getSession()

Required. The name of the session this query is sent to. Supported formats:

• projects/<Project ID>/agent/sessions/<Session ID>,
• projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,
• projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

• projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

  If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID` must not exceed 36 characters. For more information, see the API interactions guide.

  Note: Always use agent versions for production traffic. See Versions and environments.

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

Returns
Type	Description
String	The session.

getSessionBytes()

public abstract ByteString getSessionBytes()

Required. The name of the session this query is sent to. Supported formats:

• projects/<Project ID>/agent/sessions/<Session ID>,
• projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,
• projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

• projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

  If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID` must not exceed 36 characters. For more information, see the API interactions guide.

  Note: Always use agent versions for production traffic. See Versions and environments.

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

Returns
Type	Description
ByteString	The bytes for session.

hasOutputAudioConfig()

public abstract boolean hasOutputAudioConfig()

Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 4;

Returns
Type	Description
boolean	Whether the outputAudioConfig field is set.

hasOutputAudioConfigMask()

public abstract boolean hasOutputAudioConfigMask()

Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

.google.protobuf.FieldMask output_audio_config_mask = 7;

Returns
Type	Description
boolean	Whether the outputAudioConfigMask field is set.

hasQueryInput()

public abstract boolean hasQueryInput()

Required. The input specification. It can be set to:

1. an audio config which instructs the speech recognizer how to process the speech audio,

2. a conversational query in the form of text, or

3. an event that specifies which intent to trigger.

.google.cloud.dialogflow.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the queryInput field is set.

hasQueryParams()

public abstract boolean hasQueryParams()

The parameters of this query.

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

Returns
Type	Description
boolean	Whether the queryParams field is set.