public final class StreamingDetectIntentRequest extends GeneratedMessageV3 implements StreamingDetectIntentRequestOrBuilder
The top-level message sent by the client to the
Sessions.StreamingDetectIntent method.
Multiple request messages should be sent in order:
- The first message must contain
session,
query_input plus optionally
query_params. If the client
wants to receive an audio response, it should also contain
output_audio_config.
The message must not contain
input_audio.
- If query_input was set to
query_input.audio_config, all subsequent
messages must contain
input_audio to continue with
Speech recognition.
If you decide to rather detect an intent from text input after you
already started Speech recognition, please send a message with
query_input.text.
However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the
input text.
- Dialogflow will use the language code from the first message.
After you sent all input, you must half-close or abort the request stream.
Protobuf type google.cloud.dialogflow.v2.StreamingDetectIntentRequest
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
SINGLE_UTTERANCE_FIELD_NUMBER
public static final int SINGLE_UTTERANCE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static StreamingDetectIntentRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static StreamingDetectIntentRequest.Builder newBuilder()
Returns
newBuilder(StreamingDetectIntentRequest prototype)
public static StreamingDetectIntentRequest.Builder newBuilder(StreamingDetectIntentRequest prototype)
Parameter
Returns
public static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static StreamingDetectIntentRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static StreamingDetectIntentRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StreamingDetectIntentRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static StreamingDetectIntentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StreamingDetectIntentRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static StreamingDetectIntentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static StreamingDetectIntentRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<StreamingDetectIntentRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public StreamingDetectIntentRequest getDefaultInstanceForType()
Returns
public ByteString getInputAudio()
The input audio content to be recognized. Must be sent if
query_input was set to a streaming input audio config. The complete audio
over all streaming messages must not exceed 1 minute.
bytes input_audio = 6;
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.v2.OutputAudioConfig output_audio_config = 5;
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.v2.OutputAudioConfig output_audio_config = 5;
getParserForType()
public Parser<StreamingDetectIntentRequest> 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.v2.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.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
getQueryParams()
public QueryParameters getQueryParams()
The parameters of this query.
.google.cloud.dialogflow.v2.QueryParameters query_params = 2;
getQueryParamsOrBuilder()
public QueryParametersOrBuilder getQueryParamsOrBuilder()
The parameters of this query.
.google.cloud.dialogflow.v2.QueryParameters query_params = 2;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSession()
public String getSession()
Required. The name of the session the query is sent to.
Format of the session name:
projects/<Project ID>/agent/sessions/<Session ID>, or
projects/<Project ID>/agent/environments/<Environment ID>/users/<User
ID>/sessions/<Session ID>. If Environment ID is not specified, we assume
default 'draft' environment. 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 the query is sent to.
Format of the session name:
projects/<Project ID>/agent/sessions/<Session ID>, or
projects/<Project ID>/agent/environments/<Environment ID>/users/<User
ID>/sessions/<Session ID>. If Environment ID is not specified, we assume
default 'draft' environment. 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) = { ... }
getSingleUtterance()
public boolean getSingleUtterance()
Please use InputAudioConfig.single_utterance instead.
If false (default), recognition does not cease until
the client closes the stream. If true, the recognizer will detect a
single spoken utterance in input audio. Recognition ceases when it detects
the audio's voice has stopped or paused. In this case, once a detected
intent is received, the client should close the stream and start a new
request with a new stream as needed.
This setting is ignored when query_input is a piece of text or an event.
bool single_utterance = 4 [deprecated = true];
| Type | Description |
| boolean | The singleUtterance.
|
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.v2.OutputAudioConfig output_audio_config = 5;
| 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.v2.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.v2.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 StreamingDetectIntentRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StreamingDetectIntentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public StreamingDetectIntentRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
