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.v3.StreamingDetectIntentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ENABLE_DEBUGGING_INFO_FIELD_NUMBER
public static final int ENABLE_DEBUGGING_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_PARTIAL_RESPONSE_FIELD_NUMBER
public static final int ENABLE_PARTIAL_RESPONSE_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 |
|
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 |
|
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.
|
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 Fulfillments 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.v3.OutputAudioConfig output_audio_config = 4;
getOutputAudioConfigOrBuilder()
public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;
getParserForType()
public Parser<StreamingDetectIntentRequest> getParserForType()
Overrides
public QueryInput getQueryInput()
Required. The input specification.
.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
QueryInput |
The queryInput.
|
public QueryInputOrBuilder getQueryInputOrBuilder()
Required. The input specification.
.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
getQueryParams()
public QueryParameters getQueryParams()
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
getQueryParamsOrBuilder()
public QueryParametersOrBuilder getQueryParamsOrBuilder()
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSession()
public String getSession()
The name of the session this query is sent to.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>.
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>.
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.
|
hasOutputAudioConfig()
public boolean hasOutputAudioConfig()
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3.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.v3.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.v3.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
