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.v2beta1.StreamingDetectIntentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ENABLE_DEBUGGING_INFO_FIELD_NUMBER
public static final int ENABLE_DEBUGGING_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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 |
|
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 |
|
SINGLE_UTTERANCE_FIELD_NUMBER
public static final int SINGLE_UTTERANCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static StreamingDetectIntentRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static StreamingDetectIntentRequest.Builder newBuilder()
newBuilder(StreamingDetectIntentRequest prototype)
public static StreamingDetectIntentRequest.Builder newBuilder(StreamingDetectIntentRequest prototype)
public static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input)
public static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static StreamingDetectIntentRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static StreamingDetectIntentRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentRequest parseFrom(CodedInputStream input)
public static StreamingDetectIntentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentRequest parseFrom(InputStream input)
public static StreamingDetectIntentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static StreamingDetectIntentRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<StreamingDetectIntentRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public StreamingDetectIntentRequest getDefaultInstanceForType()
getEnableDebuggingInfo()
public boolean getEnableDebuggingInfo()
If true, StreamingDetectIntentResponse.debugging_info will get populated.
bool enable_debugging_info = 8;
| Returns |
| Type |
Description |
boolean |
The enableDebuggingInfo.
|
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;
| 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 = 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;
| 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;
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 = 5;
getParserForType()
public Parser<StreamingDetectIntentRequest> getParserForType()
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];
| Returns |
| Type |
Description |
QueryInput |
The queryInput.
|
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 |
| Type |
Description |
int |
|
Overrides
getSession()
public String getSession()
Required. The name of the session the 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.
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 the 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.
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.
|
getSingleUtterance() (deprecated)
public boolean getSingleUtterance()
Deprecated. google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.single_utterance is
deprecated. See google/cloud/dialogflow/v2beta1/session.proto;l=564
DEPRECATED. 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];
| Returns |
| Type |
Description |
boolean |
The singleUtterance.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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 = 5;
| 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.
|
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];
| 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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public StreamingDetectIntentRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StreamingDetectIntentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public StreamingDetectIntentRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
