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.
- If
query_input
was set to
query_input.audio.config,
all subsequent messages must contain
query_input.audio.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.cx.v3beta1.StreamingDetectIntentRequest
Static Fields
ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER
public static final int ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER
Field Value
OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
public static final int OUTPUT_AUDIO_CONFIG_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 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
getEnablePartialResponse()
public boolean getEnablePartialResponse()
Enable partial detect intent response. If this flag is not enabled,
response stream still contains only one final DetectIntentResponse
even
if some Fulfillment
s in the agent have been configured to return partial
responses.
bool enable_partial_response = 5;
Returns
Type |
Description |
boolean |
The enablePartialResponse.
|
getOutputAudioConfig()
public OutputAudioConfig getOutputAudioConfig()
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
Returns
getOutputAudioConfigOrBuilder()
public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
Returns
getParserForType()
public Parser<StreamingDetectIntentRequest> getParserForType()
Returns
Overrides
public QueryInput getQueryInput()
Required. The input specification.
.google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
public QueryInputOrBuilder getQueryInputOrBuilder()
Required. The input specification.
.google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
getQueryParams()
public QueryParameters getQueryParams()
The parameters of this query.
.google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
Returns
getQueryParamsOrBuilder()
public QueryParametersOrBuilder getQueryParamsOrBuilder()
The parameters of this query.
.google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSession()
public String getSession()
The name of the session this query is sent to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/sessions/<Session ID>
or projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
.
If Environment ID
is not specified, we assume default 'draft'
environment.
It's up to the API caller to choose an appropriate Session ID
. It can be
a random number or some type of session identifiers (preferably hashed).
The length of the Session ID
must not exceed 36 characters.
Note: session must be set in the first request.
For more information, see the sessions
guide.
Note: Always use agent versions for production traffic.
See Versions and
environments.
string session = 1 [(.google.api.resource_reference) = { ... }
Returns
Type |
Description |
String |
The session.
|
getSessionBytes()
public ByteString getSessionBytes()
The name of the session this query is sent to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/sessions/<Session ID>
or projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
.
If Environment ID
is not specified, we assume default 'draft'
environment.
It's up to the API caller to choose an appropriate Session ID
. It can be
a random number or some type of session identifiers (preferably hashed).
The length of the Session ID
must not exceed 36 characters.
Note: session must be set in the first request.
For more information, see the sessions
guide.
Note: Always use agent versions for production traffic.
See Versions and
environments.
string session = 1 [(.google.api.resource_reference) = { ... }
Returns
Type |
Description |
ByteString |
The bytes for session.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasOutputAudioConfig()
public boolean hasOutputAudioConfig()
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
Returns
Type |
Description |
boolean |
Whether the outputAudioConfig field is set.
|
public boolean hasQueryInput()
Required. The input specification.
.google.cloud.dialogflow.cx.v3beta1.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.cx.v3beta1.QueryParameters query_params = 2;
Returns
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