Class DetectIntentRequest (4.34.0)

Version 4.34.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 final class DetectIntentRequest extends GeneratedMessageV3 implements DetectIntentRequestOrBuilder

The request to detect user's intent.

Protobuf type google.cloud.dialogflow.v2beta1.DetectIntentRequest

Inheritance

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

Implements

DetectIntentRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

INPUT_AUDIO_FIELD_NUMBER

public static final int INPUT_AUDIO_FIELD_NUMBER

Field Value
Type	Description
int

OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER

public static final int OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_INPUT_FIELD_NUMBER

public static final int QUERY_INPUT_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_PARAMS_FIELD_NUMBER

public static final int QUERY_PARAMS_FIELD_NUMBER

Field Value
Type	Description
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DetectIntentRequest getDefaultInstance()

Returns
Type	Description
DetectIntentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DetectIntentRequest.Builder newBuilder()

Returns
Type	Description
DetectIntentRequest.Builder

newBuilder(DetectIntentRequest prototype)

public static DetectIntentRequest.Builder newBuilder(DetectIntentRequest prototype)

Parameter
Name	Description
prototype	DetectIntentRequest

Returns
Type	Description
DetectIntentRequest.Builder

parseDelimitedFrom(InputStream input)

public static DetectIntentRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DetectIntentRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DetectIntentRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DetectIntentRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DetectIntentRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DetectIntentRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DetectIntentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DetectIntentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DetectIntentRequest> parser()

Returns
Type	Description
Parser<DetectIntentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public DetectIntentRequest getDefaultInstanceForType()

Returns
Type	Description
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
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.

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.

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

getParserForType()

public Parser<DetectIntentRequest> getParserForType()

Returns
Type	Description
Parser<DetectIntentRequest>

Overrides

GeneratedMessageV3.getParserForType()

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.

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.

getQueryParamsOrBuilder()

public QueryParametersOrBuilder getQueryParamsOrBuilder()

The parameters of this query.

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

Returns
Type	Description
QueryParametersOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public DetectIntentRequest.Builder newBuilderForType()

Returns
Type	Description
DetectIntentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DetectIntentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DetectIntentRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public DetectIntentRequest.Builder toBuilder()

Returns
Type	Description
DetectIntentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException