Class DetectIntentRequest.Builder (4.58.0) 

public static final class DetectIntentRequest.Builder extends GeneratedMessageV3.Builder<DetectIntentRequest.Builder> implements DetectIntentRequestOrBuilder

The request to detect user's intent.

Protobuf type google.cloud.dialogflow.v2beta1.DetectIntentRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DetectIntentRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DetectIntentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DetectIntentRequest.Builder
Overrides

build()

public DetectIntentRequest build()
Returns
Type Description
DetectIntentRequest

buildPartial()

public DetectIntentRequest buildPartial()
Returns
Type Description
DetectIntentRequest

clear()

public DetectIntentRequest.Builder clear()
Returns
Type Description
DetectIntentRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public DetectIntentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DetectIntentRequest.Builder
Overrides

clearInputAudio()

public DetectIntentRequest.Builder clearInputAudio()

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
DetectIntentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DetectIntentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DetectIntentRequest.Builder
Overrides

clearOutputAudioConfig()

public DetectIntentRequest.Builder clearOutputAudioConfig()

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
DetectIntentRequest.Builder

clearOutputAudioConfigMask()

public DetectIntentRequest.Builder clearOutputAudioConfigMask()

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
DetectIntentRequest.Builder

clearQueryInput()

public DetectIntentRequest.Builder clearQueryInput()

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
DetectIntentRequest.Builder

clearQueryParams()

public DetectIntentRequest.Builder clearQueryParams()

The parameters of this query.

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

Returns
Type Description
DetectIntentRequest.Builder

clearSession()

public DetectIntentRequest.Builder clearSession()

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
DetectIntentRequest.Builder

This builder for chaining.

clone()

public DetectIntentRequest.Builder clone()
Returns
Type Description
DetectIntentRequest.Builder
Overrides

getDefaultInstanceForType()

public DetectIntentRequest getDefaultInstanceForType()
Returns
Type Description
DetectIntentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInputAudio()

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

getOutputAudioConfigBuilder()

public OutputAudioConfig.Builder getOutputAudioConfigBuilder()

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

getOutputAudioConfigMask()

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

getOutputAudioConfigMaskBuilder()

public FieldMask.Builder getOutputAudioConfigMaskBuilder()

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
Builder

getOutputAudioConfigMaskOrBuilder()

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

getQueryInputBuilder()

public QueryInput.Builder getQueryInputBuilder()

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

getQueryInputOrBuilder()

public 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 QueryParameters getQueryParams()

The parameters of this query.

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

Returns
Type Description
QueryParameters

The queryParams.

getQueryParamsBuilder()

public QueryParameters.Builder getQueryParamsBuilder()

The parameters of this query.

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

Returns
Type Description
QueryParameters.Builder

getQueryParamsOrBuilder()

public QueryParametersOrBuilder getQueryParamsOrBuilder()

The parameters of this query.

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

Returns
Type Description
QueryParametersOrBuilder

getSession()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DetectIntentRequest other)

public DetectIntentRequest.Builder mergeFrom(DetectIntentRequest other)
Parameter
Name Description
other DetectIntentRequest
Returns
Type Description
DetectIntentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DetectIntentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DetectIntentRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DetectIntentRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DetectIntentRequest.Builder
Overrides

mergeOutputAudioConfig(OutputAudioConfig value)

public DetectIntentRequest.Builder mergeOutputAudioConfig(OutputAudioConfig value)

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;

Parameter
Name Description
value OutputAudioConfig
Returns
Type Description
DetectIntentRequest.Builder

mergeOutputAudioConfigMask(FieldMask value)

public DetectIntentRequest.Builder mergeOutputAudioConfigMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
DetectIntentRequest.Builder

mergeQueryInput(QueryInput value)

public DetectIntentRequest.Builder mergeQueryInput(QueryInput value)

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

Parameter
Name Description
value QueryInput
Returns
Type Description
DetectIntentRequest.Builder

mergeQueryParams(QueryParameters value)

public DetectIntentRequest.Builder mergeQueryParams(QueryParameters value)

The parameters of this query.

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

Parameter
Name Description
value QueryParameters
Returns
Type Description
DetectIntentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DetectIntentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DetectIntentRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public DetectIntentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DetectIntentRequest.Builder
Overrides

setInputAudio(ByteString value)

public DetectIntentRequest.Builder setInputAudio(ByteString value)

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;

Parameter
Name Description
value ByteString

The inputAudio to set.
Returns
Type Description
DetectIntentRequest.Builder

This builder for chaining.

setOutputAudioConfig(OutputAudioConfig value)

public DetectIntentRequest.Builder setOutputAudioConfig(OutputAudioConfig value)

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;

Parameter
Name Description
value OutputAudioConfig
Returns
Type Description
DetectIntentRequest.Builder

setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)

public DetectIntentRequest.Builder setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue OutputAudioConfig.Builder
Returns
Type Description
DetectIntentRequest.Builder

setOutputAudioConfigMask(FieldMask value)

public DetectIntentRequest.Builder setOutputAudioConfigMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
DetectIntentRequest.Builder

setOutputAudioConfigMask(FieldMask.Builder builderForValue)

public DetectIntentRequest.Builder setOutputAudioConfigMask(FieldMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DetectIntentRequest.Builder

setQueryInput(QueryInput value)

public DetectIntentRequest.Builder setQueryInput(QueryInput value)

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

Parameter
Name Description
value QueryInput
Returns
Type Description
DetectIntentRequest.Builder

setQueryInput(QueryInput.Builder builderForValue)

public DetectIntentRequest.Builder setQueryInput(QueryInput.Builder builderForValue)

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

Parameter
Name Description
builderForValue QueryInput.Builder
Returns
Type Description
DetectIntentRequest.Builder

setQueryParams(QueryParameters value)

public DetectIntentRequest.Builder setQueryParams(QueryParameters value)

The parameters of this query.

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

Parameter
Name Description
value QueryParameters
Returns
Type Description
DetectIntentRequest.Builder

setQueryParams(QueryParameters.Builder builderForValue)

public DetectIntentRequest.Builder setQueryParams(QueryParameters.Builder builderForValue)

The parameters of this query.

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

Parameter
Name Description
builderForValue QueryParameters.Builder
Returns
Type Description
DetectIntentRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DetectIntentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DetectIntentRequest.Builder
Overrides

setSession(String value)

public DetectIntentRequest.Builder setSession(String value)

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) = { ... }

Parameter
Name Description
value String

The session to set.
Returns
Type Description
DetectIntentRequest.Builder

This builder for chaining.

setSessionBytes(ByteString value)

public DetectIntentRequest.Builder setSessionBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for session to set.
Returns
Type Description
DetectIntentRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DetectIntentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DetectIntentRequest.Builder
Overrides