public final class StreamingDetectIntentRequest extends com.google.protobuf.GeneratedMessageV3 implements StreamingDetectIntentRequestOrBuilder
The top-level message sent by the client to the
[Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]
method.
Multiple request messages should be sent in order:
1. The first message must contain
[session][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.session],
[query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input]
plus optionally
[query_params][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_params].
If the client wants to receive an audio response, it should also contain
[output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config].
The message must not contain
[input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.input_audio].
2. If
[query_input][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.query_input]
was set to
[query_input.audio_config][google.cloud.dialogflow.v2beta1.InputAudioConfig],
all subsequent messages must contain
[input_audio][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.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][google.cloud.dialogflow.v2beta1.QueryInput.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| Modifier and Type | Class and Description |
|---|---|
static class |
StreamingDetectIntentRequest.Builder
The top-level message sent by the client to the
[Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]
method.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ENABLE_DEBUGGING_INFO_FIELD_NUMBER |
static int |
INPUT_AUDIO_FIELD_NUMBER |
static int |
OUTPUT_AUDIO_CONFIG_FIELD_NUMBER |
static int |
OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER |
static int |
QUERY_INPUT_FIELD_NUMBER |
static int |
QUERY_PARAMS_FIELD_NUMBER |
static int |
SESSION_FIELD_NUMBER |
static int |
SINGLE_UTTERANCE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static StreamingDetectIntentRequest |
getDefaultInstance() |
StreamingDetectIntentRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getEnableDebuggingInfo()
If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
|
com.google.protobuf.ByteString |
getInputAudio()
The input audio content to be recognized.
|
OutputAudioConfig |
getOutputAudioConfig()
Instructs the speech synthesizer how to generate the output
audio.
|
com.google.protobuf.FieldMask |
getOutputAudioConfigMask()
Mask for
[output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config]
indicating which settings in this request-level config should override
speech synthesizer settings defined at agent-level.
|
com.google.protobuf.FieldMaskOrBuilder |
getOutputAudioConfigMaskOrBuilder()
Mask for
[output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config]
indicating which settings in this request-level config should override
speech synthesizer settings defined at agent-level.
|
OutputAudioConfigOrBuilder |
getOutputAudioConfigOrBuilder()
Instructs the speech synthesizer how to generate the output
audio.
|
com.google.protobuf.Parser<StreamingDetectIntentRequest> |
getParserForType() |
QueryInput |
getQueryInput()
Required.
|
QueryInputOrBuilder |
getQueryInputOrBuilder()
Required.
|
QueryParameters |
getQueryParams()
The parameters of this query.
|
QueryParametersOrBuilder |
getQueryParamsOrBuilder()
The parameters of this query.
|
int |
getSerializedSize() |
String |
getSession()
Required.
|
com.google.protobuf.ByteString |
getSessionBytes()
Required.
|
boolean |
getSingleUtterance()
Deprecated.
google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.single_utterance is
deprecated. See google/cloud/dialogflow/v2beta1/session.proto;l=564
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasOutputAudioConfig()
Instructs the speech synthesizer how to generate the output
audio.
|
boolean |
hasOutputAudioConfigMask()
Mask for
[output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config]
indicating which settings in this request-level config should override
speech synthesizer settings defined at agent-level.
|
boolean |
hasQueryInput()
Required.
|
boolean |
hasQueryParams()
The parameters of this query.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static StreamingDetectIntentRequest.Builder |
newBuilder() |
static StreamingDetectIntentRequest.Builder |
newBuilder(StreamingDetectIntentRequest prototype) |
StreamingDetectIntentRequest.Builder |
newBuilderForType() |
protected StreamingDetectIntentRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static StreamingDetectIntentRequest |
parseDelimitedFrom(InputStream input) |
static StreamingDetectIntentRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentRequest |
parseFrom(byte[] data) |
static StreamingDetectIntentRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentRequest |
parseFrom(ByteBuffer data) |
static StreamingDetectIntentRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentRequest |
parseFrom(com.google.protobuf.ByteString data) |
static StreamingDetectIntentRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static StreamingDetectIntentRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentRequest |
parseFrom(InputStream input) |
static StreamingDetectIntentRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<StreamingDetectIntentRequest> |
parser() |
StreamingDetectIntentRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int SESSION_FIELD_NUMBER
public static final int QUERY_PARAMS_FIELD_NUMBER
public static final int QUERY_INPUT_FIELD_NUMBER
public static final int SINGLE_UTTERANCE_FIELD_NUMBER
public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
public static final int OUTPUT_AUDIO_CONFIG_MASK_FIELD_NUMBER
public static final int INPUT_AUDIO_FIELD_NUMBER
public static final int ENABLE_DEBUGGING_INFO_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getSession in interface StreamingDetectIntentRequestOrBuilderpublic com.google.protobuf.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](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getSessionBytes in interface StreamingDetectIntentRequestOrBuilderpublic boolean hasQueryParams()
The parameters of this query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 2;hasQueryParams in interface StreamingDetectIntentRequestOrBuilderpublic QueryParameters getQueryParams()
The parameters of this query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 2;getQueryParams in interface StreamingDetectIntentRequestOrBuilderpublic QueryParametersOrBuilder getQueryParamsOrBuilder()
The parameters of this query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 2;getQueryParamsOrBuilder in interface StreamingDetectIntentRequestOrBuilderpublic 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];
hasQueryInput in interface StreamingDetectIntentRequestOrBuilderpublic 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];
getQueryInput in interface StreamingDetectIntentRequestOrBuilderpublic 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];
getQueryInputOrBuilder in interface StreamingDetectIntentRequestOrBuilder@Deprecated public boolean getSingleUtterance()
DEPRECATED. Please use [InputAudioConfig.single_utterance][google.cloud.dialogflow.v2beta1.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];getSingleUtterance in interface StreamingDetectIntentRequestOrBuilderpublic 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;hasOutputAudioConfig in interface StreamingDetectIntentRequestOrBuilderpublic 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;getOutputAudioConfig in interface StreamingDetectIntentRequestOrBuilderpublic 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;getOutputAudioConfigOrBuilder in interface StreamingDetectIntentRequestOrBuilderpublic boolean hasOutputAudioConfigMask()
Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.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][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] replaces the agent-level config in its entirety.
.google.protobuf.FieldMask output_audio_config_mask = 7;hasOutputAudioConfigMask in interface StreamingDetectIntentRequestOrBuilderpublic com.google.protobuf.FieldMask getOutputAudioConfigMask()
Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.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][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] replaces the agent-level config in its entirety.
.google.protobuf.FieldMask output_audio_config_mask = 7;getOutputAudioConfigMask in interface StreamingDetectIntentRequestOrBuilderpublic com.google.protobuf.FieldMaskOrBuilder getOutputAudioConfigMaskOrBuilder()
Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.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][google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config] replaces the agent-level config in its entirety.
.google.protobuf.FieldMask output_audio_config_mask = 7;getOutputAudioConfigMaskOrBuilder in interface StreamingDetectIntentRequestOrBuilderpublic com.google.protobuf.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;getInputAudio in interface StreamingDetectIntentRequestOrBuilderpublic boolean getEnableDebuggingInfo()
If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
bool enable_debugging_info = 8;getEnableDebuggingInfo in interface StreamingDetectIntentRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static StreamingDetectIntentRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static StreamingDetectIntentRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static StreamingDetectIntentRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StreamingDetectIntentRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static StreamingDetectIntentRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic StreamingDetectIntentRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static StreamingDetectIntentRequest.Builder newBuilder()
public static StreamingDetectIntentRequest.Builder newBuilder(StreamingDetectIntentRequest prototype)
public StreamingDetectIntentRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected StreamingDetectIntentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static StreamingDetectIntentRequest getDefaultInstance()
public static com.google.protobuf.Parser<StreamingDetectIntentRequest> parser()
public com.google.protobuf.Parser<StreamingDetectIntentRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public StreamingDetectIntentRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.