Class DetectIntentRequest (4.7.3)

public final class DetectIntentRequest extends GeneratedMessageV3 implements DetectIntentRequestOrBuilder

The request to detect user's intent.

Protobuf type google.cloud.dialogflow.v2beta1.DetectIntentRequest

Static Fields

INPUT_AUDIO_FIELD_NUMBER

public static final int INPUT_AUDIO_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER

public static final int OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_INPUT_FIELD_NUMBER

public static final int QUERY_INPUT_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_PARAMS_FIELD_NUMBER

public static final int QUERY_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DetectIntentRequest getDefaultInstance()
Returns
TypeDescription
DetectIntentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DetectIntentRequest.Builder newBuilder()
Returns
TypeDescription
DetectIntentRequest.Builder

newBuilder(DetectIntentRequest prototype)

public static DetectIntentRequest.Builder newBuilder(DetectIntentRequest prototype)
Parameter
NameDescription
prototypeDetectIntentRequest
Returns
TypeDescription
DetectIntentRequest.Builder

parseDelimitedFrom(InputStream input)

public static DetectIntentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DetectIntentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DetectIntentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DetectIntentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DetectIntentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DetectIntentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DetectIntentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DetectIntentRequest> parser()
Returns
TypeDescription
Parser<DetectIntentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DetectIntentRequest getDefaultInstanceForType()
Returns
TypeDescription
DetectIntentRequest

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
TypeDescription
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
TypeDescription
OutputAudioConfig

The outputAudioConfig.

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
TypeDescription
FieldMask

The outputAudioConfigMask.

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
TypeDescription
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
TypeDescription
OutputAudioConfigOrBuilder

getParserForType()

public Parser<DetectIntentRequest> getParserForType()
Returns
TypeDescription
Parser<DetectIntentRequest>
Overrides

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
TypeDescription
QueryInput

The queryInput.

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
TypeDescription
QueryInputOrBuilder

getQueryParams()

public QueryParameters getQueryParams()

The parameters of this query.

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

Returns
TypeDescription
QueryParameters

The queryParams.

getQueryParamsOrBuilder()

public QueryParametersOrBuilder getQueryParamsOrBuilder()

The parameters of this query.

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

Returns
TypeDescription
QueryParametersOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for session.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the queryParams field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DetectIntentRequest.Builder newBuilderForType()
Returns
TypeDescription
DetectIntentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DetectIntentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DetectIntentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DetectIntentRequest.Builder toBuilder()
Returns
TypeDescription
DetectIntentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException