public final class StreamingDetectIntentResponse extends GeneratedMessageV3 implements StreamingDetectIntentResponseOrBuilder
The top-level message returned from the
StreamingDetectIntent method.
Multiple response messages can be returned in order:
- If the
StreamingDetectIntentRequest.input_audio field was
set, the recognition_result field is populated for one
or more messages.
See the
StreamingRecognitionResult
message for details about the result message sequence.
- The next message contains
response_id, query_result,
alternative_query_results and optionally webhook_status if a WebHook
was called.
- If
output_audio_config was specified in the request or agent-level
speech synthesizer is configured, all subsequent messages contain
output_audio and output_audio_config.
Protobuf type google.cloud.dialogflow.v2beta1.StreamingDetectIntentResponse
Static Fields
ALTERNATIVE_QUERY_RESULTS_FIELD_NUMBER
public static final int ALTERNATIVE_QUERY_RESULTS_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_FIELD_NUMBER
public static final int OUTPUT_AUDIO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_RESULT_FIELD_NUMBER
public static final int QUERY_RESULT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RECOGNITION_RESULT_FIELD_NUMBER
public static final int RECOGNITION_RESULT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESPONSE_ID_FIELD_NUMBER
public static final int RESPONSE_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
WEBHOOK_STATUS_FIELD_NUMBER
public static final int WEBHOOK_STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static StreamingDetectIntentResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static StreamingDetectIntentResponse.Builder newBuilder()
newBuilder(StreamingDetectIntentResponse prototype)
public static StreamingDetectIntentResponse.Builder newBuilder(StreamingDetectIntentResponse prototype)
public static StreamingDetectIntentResponse parseDelimitedFrom(InputStream input)
public static StreamingDetectIntentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static StreamingDetectIntentResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static StreamingDetectIntentResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentResponse parseFrom(CodedInputStream input)
public static StreamingDetectIntentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentResponse parseFrom(InputStream input)
public static StreamingDetectIntentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static StreamingDetectIntentResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StreamingDetectIntentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<StreamingDetectIntentResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAlternativeQueryResults(int index)
public QueryResult getAlternativeQueryResults(int index)
If Knowledge Connectors are enabled, there could be more than one result
returned for a given query or event, and this field will contain all
results except for the top one, which is captured in query_result. The
alternative results are ordered by decreasing
QueryResult.intent_detection_confidence. If Knowledge Connectors are
disabled, this field will be empty until multiple responses for regular
intents are supported, at which point those additional results will be
surfaced here.
repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
| Parameter |
| Name |
Description |
index |
int
|
getAlternativeQueryResultsCount()
public int getAlternativeQueryResultsCount()
If Knowledge Connectors are enabled, there could be more than one result
returned for a given query or event, and this field will contain all
results except for the top one, which is captured in query_result. The
alternative results are ordered by decreasing
QueryResult.intent_detection_confidence. If Knowledge Connectors are
disabled, this field will be empty until multiple responses for regular
intents are supported, at which point those additional results will be
surfaced here.
repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
| Returns |
| Type |
Description |
int |
|
getAlternativeQueryResultsList()
public List<QueryResult> getAlternativeQueryResultsList()
If Knowledge Connectors are enabled, there could be more than one result
returned for a given query or event, and this field will contain all
results except for the top one, which is captured in query_result. The
alternative results are ordered by decreasing
QueryResult.intent_detection_confidence. If Knowledge Connectors are
disabled, this field will be empty until multiple responses for regular
intents are supported, at which point those additional results will be
surfaced here.
repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
getAlternativeQueryResultsOrBuilder(int index)
public QueryResultOrBuilder getAlternativeQueryResultsOrBuilder(int index)
If Knowledge Connectors are enabled, there could be more than one result
returned for a given query or event, and this field will contain all
results except for the top one, which is captured in query_result. The
alternative results are ordered by decreasing
QueryResult.intent_detection_confidence. If Knowledge Connectors are
disabled, this field will be empty until multiple responses for regular
intents are supported, at which point those additional results will be
surfaced here.
repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
| Parameter |
| Name |
Description |
index |
int
|
getAlternativeQueryResultsOrBuilderList()
public List<? extends QueryResultOrBuilder> getAlternativeQueryResultsOrBuilderList()
If Knowledge Connectors are enabled, there could be more than one result
returned for a given query or event, and this field will contain all
results except for the top one, which is captured in query_result. The
alternative results are ordered by decreasing
QueryResult.intent_detection_confidence. If Knowledge Connectors are
disabled, this field will be empty until multiple responses for regular
intents are supported, at which point those additional results will be
surfaced here.
repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 7;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.v2beta1.QueryResultOrBuilder> |
|
getDefaultInstanceForType()
public StreamingDetectIntentResponse getDefaultInstanceForType()
getOutputAudio()
public ByteString getOutputAudio()
The audio data bytes encoded as specified in the request.
Note: The output audio is generated based on the values of default platform
text responses found in the query_result.fulfillment_messages field. If
multiple default text responses exist, they will be concatenated when
generating audio. If no default platform text responses exist, the
generated audio content will be empty.
In some scenarios, multiple output audio fields may be present in the
response structure. In these cases, only the top-most-level audio output
has content.
bytes output_audio = 5;
| Returns |
| Type |
Description |
ByteString |
The outputAudio.
|
getOutputAudioConfig()
public OutputAudioConfig getOutputAudioConfig()
The config used by the speech synthesizer to generate the output audio.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;
getOutputAudioConfigOrBuilder()
public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
The config used by the speech synthesizer to generate the output audio.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;
getParserForType()
public Parser<StreamingDetectIntentResponse> getParserForType()
Overrides
getQueryResult()
public QueryResult getQueryResult()
The selected results of the conversational query or event processing.
See alternative_query_results for additional potential results.
.google.cloud.dialogflow.v2beta1.QueryResult query_result = 3;
getQueryResultOrBuilder()
public QueryResultOrBuilder getQueryResultOrBuilder()
The selected results of the conversational query or event processing.
See alternative_query_results for additional potential results.
.google.cloud.dialogflow.v2beta1.QueryResult query_result = 3;
getRecognitionResult()
public StreamingRecognitionResult getRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
getRecognitionResultOrBuilder()
public StreamingRecognitionResultOrBuilder getRecognitionResultOrBuilder()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
getResponseId()
public String getResponseId()
The unique identifier of the response. It can be used to
locate a response in the training example set or for reporting issues.
string response_id = 1;
| Returns |
| Type |
Description |
String |
The responseId.
|
getResponseIdBytes()
public ByteString getResponseIdBytes()
The unique identifier of the response. It can be used to
locate a response in the training example set or for reporting issues.
string response_id = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for responseId.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getWebhookStatus()
public Status getWebhookStatus()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;
| Returns |
| Type |
Description |
com.google.rpc.Status |
The webhookStatus.
|
getWebhookStatusOrBuilder()
public StatusOrBuilder getWebhookStatusOrBuilder()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;
| Returns |
| Type |
Description |
com.google.rpc.StatusOrBuilder |
|
hasOutputAudioConfig()
public boolean hasOutputAudioConfig()
The config used by the speech synthesizer to generate the output audio.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;
| Returns |
| Type |
Description |
boolean |
Whether the outputAudioConfig field is set.
|
hasQueryResult()
public boolean hasQueryResult()
The selected results of the conversational query or event processing.
See alternative_query_results for additional potential results.
.google.cloud.dialogflow.v2beta1.QueryResult query_result = 3;
| Returns |
| Type |
Description |
boolean |
Whether the queryResult field is set.
|
hasRecognitionResult()
public boolean hasRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
| Returns |
| Type |
Description |
boolean |
Whether the recognitionResult field is set.
|
hasWebhookStatus()
public boolean hasWebhookStatus()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;
| Returns |
| Type |
Description |
boolean |
Whether the webhookStatus field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public StreamingDetectIntentResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StreamingDetectIntentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public StreamingDetectIntentResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
