- 0.63.0 (latest)
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
public static final class StreamingDetectIntentRequest.Builder extends GeneratedMessageV3.Builder<StreamingDetectIntentRequest.Builder> 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StreamingDetectIntentRequest.BuilderImplements
StreamingDetectIntentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StreamingDetectIntentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
build()
public StreamingDetectIntentRequest build()
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest |
buildPartial()
public StreamingDetectIntentRequest buildPartial()
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest |
clear()
public StreamingDetectIntentRequest.Builder clear()
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
clearEnableDebuggingInfo()
public StreamingDetectIntentRequest.Builder clearEnableDebuggingInfo()
If true, StreamingDetectIntentResponse.debugging_info
will get populated.
bool enable_debugging_info = 8;
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
This builder for chaining. |
clearEnablePartialResponse()
public StreamingDetectIntentRequest.Builder clearEnablePartialResponse()
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 |
StreamingDetectIntentRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public StreamingDetectIntentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public StreamingDetectIntentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
clearOutputAudioConfig()
public StreamingDetectIntentRequest.Builder clearOutputAudioConfig()
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
clearQueryInput()
public StreamingDetectIntentRequest.Builder clearQueryInput()
Required. The input specification.
.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
clearQueryParams()
public StreamingDetectIntentRequest.Builder clearQueryParams()
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
clearSession()
public StreamingDetectIntentRequest.Builder clearSession()
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 |
StreamingDetectIntentRequest.Builder |
This builder for chaining. |
clone()
public StreamingDetectIntentRequest.Builder clone()
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
getDefaultInstanceForType()
public StreamingDetectIntentRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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 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.v3.OutputAudioConfig output_audio_config = 4;
Returns | |
---|---|
Type | Description |
OutputAudioConfig |
The outputAudioConfig. |
getOutputAudioConfigBuilder()
public OutputAudioConfig.Builder getOutputAudioConfigBuilder()
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;
Returns | |
---|---|
Type | Description |
OutputAudioConfig.Builder |
getOutputAudioConfigOrBuilder()
public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;
Returns | |
---|---|
Type | Description |
OutputAudioConfigOrBuilder |
getQueryInput()
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. |
getQueryInputBuilder()
public QueryInput.Builder getQueryInputBuilder()
Required. The input specification.
.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
QueryInput.Builder |
getQueryInputOrBuilder()
public QueryInputOrBuilder getQueryInputOrBuilder()
Required. The input specification.
.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
QueryInputOrBuilder |
getQueryParams()
public QueryParameters getQueryParams()
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
Returns | |
---|---|
Type | Description |
QueryParameters |
The queryParams. |
getQueryParamsBuilder()
public QueryParameters.Builder getQueryParamsBuilder()
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
Returns | |
---|---|
Type | Description |
QueryParameters.Builder |
getQueryParamsOrBuilder()
public QueryParametersOrBuilder getQueryParamsOrBuilder()
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
Returns | |
---|---|
Type | Description |
QueryParametersOrBuilder |
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. |
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. |
hasQueryInput()
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(StreamingDetectIntentRequest other)
public StreamingDetectIntentRequest.Builder mergeFrom(StreamingDetectIntentRequest other)
Parameter | |
---|---|
Name | Description |
other |
StreamingDetectIntentRequest |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StreamingDetectIntentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public StreamingDetectIntentRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
mergeOutputAudioConfig(OutputAudioConfig value)
public StreamingDetectIntentRequest.Builder mergeOutputAudioConfig(OutputAudioConfig value)
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;
Parameter | |
---|---|
Name | Description |
value |
OutputAudioConfig |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
mergeQueryInput(QueryInput value)
public StreamingDetectIntentRequest.Builder mergeQueryInput(QueryInput value)
Required. The input specification.
.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
QueryInput |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
mergeQueryParams(QueryParameters value)
public StreamingDetectIntentRequest.Builder mergeQueryParams(QueryParameters value)
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
Parameter | |
---|---|
Name | Description |
value |
QueryParameters |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StreamingDetectIntentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setEnableDebuggingInfo(boolean value)
public StreamingDetectIntentRequest.Builder setEnableDebuggingInfo(boolean value)
If true, StreamingDetectIntentResponse.debugging_info
will get populated.
bool enable_debugging_info = 8;
Parameter | |
---|---|
Name | Description |
value |
boolean The enableDebuggingInfo to set. |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
This builder for chaining. |
setEnablePartialResponse(boolean value)
public StreamingDetectIntentRequest.Builder setEnablePartialResponse(boolean value)
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;
Parameter | |
---|---|
Name | Description |
value |
boolean The enablePartialResponse to set. |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public StreamingDetectIntentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setOutputAudioConfig(OutputAudioConfig value)
public StreamingDetectIntentRequest.Builder setOutputAudioConfig(OutputAudioConfig value)
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;
Parameter | |
---|---|
Name | Description |
value |
OutputAudioConfig |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)
public StreamingDetectIntentRequest.Builder setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)
Instructs the speech synthesizer how to generate the output audio.
.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 4;
Parameter | |
---|---|
Name | Description |
builderForValue |
OutputAudioConfig.Builder |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setQueryInput(QueryInput value)
public StreamingDetectIntentRequest.Builder setQueryInput(QueryInput value)
Required. The input specification.
.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
QueryInput |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setQueryInput(QueryInput.Builder builderForValue)
public StreamingDetectIntentRequest.Builder setQueryInput(QueryInput.Builder builderForValue)
Required. The input specification.
.google.cloud.dialogflow.cx.v3.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
QueryInput.Builder |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setQueryParams(QueryParameters value)
public StreamingDetectIntentRequest.Builder setQueryParams(QueryParameters value)
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
Parameter | |
---|---|
Name | Description |
value |
QueryParameters |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setQueryParams(QueryParameters.Builder builderForValue)
public StreamingDetectIntentRequest.Builder setQueryParams(QueryParameters.Builder builderForValue)
The parameters of this query.
.google.cloud.dialogflow.cx.v3.QueryParameters query_params = 2;
Parameter | |
---|---|
Name | Description |
builderForValue |
QueryParameters.Builder |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StreamingDetectIntentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
setSession(String value)
public StreamingDetectIntentRequest.Builder setSession(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The session to set. |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
This builder for chaining. |
setSessionBytes(ByteString value)
public StreamingDetectIntentRequest.Builder setSessionBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for session to set. |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final StreamingDetectIntentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
StreamingDetectIntentRequest.Builder |