public final class DetectIntentRequest extends GeneratedMessageV3 implements DetectIntentRequestOrBuilder
The request to detect user's intent.
Protobuf type google.cloud.dialogflow.v2beta1.DetectIntentRequest
Static Fields
public static final int INPUT_AUDIO_FIELD_NUMBER
Field Value
OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
Field Value
OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER
public static final int OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER
Field Value
public static final int QUERY_INPUT_FIELD_NUMBER
Field Value
QUERY_PARAMS_FIELD_NUMBER
public static final int QUERY_PARAMS_FIELD_NUMBER
Field Value
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DetectIntentRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DetectIntentRequest.Builder newBuilder()
Returns
newBuilder(DetectIntentRequest prototype)
public static DetectIntentRequest.Builder newBuilder(DetectIntentRequest prototype)
Parameter
Returns
public static DetectIntentRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DetectIntentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DetectIntentRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DetectIntentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DetectIntentRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DetectIntentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DetectIntentRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DetectIntentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DetectIntentRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DetectIntentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DetectIntentRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DetectIntentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DetectIntentRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public DetectIntentRequest getDefaultInstanceForType()
Returns
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;
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;
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;
| 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;
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;
getParserForType()
public Parser<DetectIntentRequest> getParserForType()
Returns
Overrides
public QueryInput getQueryInput()
Required. The input specification. It can be set to:
- an audio config
which instructs the speech recognizer how to process the speech audio,
- a conversational query in the form of text, or
- an event that specifies which intent to trigger.
.google.cloud.dialogflow.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
public QueryInputOrBuilder getQueryInputOrBuilder()
Required. The input specification. It can be set to:
- an audio config
which instructs the speech recognizer how to process the speech audio,
- a conversational query in the form of text, or
- an event that specifies which intent to trigger.
.google.cloud.dialogflow.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
getQueryParams()
public QueryParameters getQueryParams()
The parameters of this query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 2;
getQueryParamsOrBuilder()
public QueryParametersOrBuilder getQueryParamsOrBuilder()
The parameters of this query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 2;
getSerializedSize()
public int getSerializedSize()
Returns
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) = { ... }
| 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) = { ... }
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| 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;
| Type | Description |
| boolean | Whether the outputAudioConfigMask field is set.
|
public boolean hasQueryInput()
Required. The input specification. It can be set to:
- an audio config
which instructs the speech recognizer how to process the speech audio,
- a conversational query in the form of text, or
- an event that specifies which intent to trigger.
.google.cloud.dialogflow.v2beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
| 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;
| Type | Description |
| boolean | Whether the queryParams field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DetectIntentRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DetectIntentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DetectIntentRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
