public final class StreamingDetectIntentResponse extends com.google.protobuf.GeneratedMessageV3 implements StreamingDetectIntentResponseOrBuilder
The top-level message returned from the
`StreamingDetectIntent` method.
Multiple response messages can be returned in order:
1. If the `StreamingDetectIntentRequest.input_audio` field was
set, the `recognition_result` field is populated for one
or more messages.
See the
[StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult]
message for details about the result message sequence.
2. The next message contains `response_id`, `query_result`,
`alternative_query_results` and optionally `webhook_status` if a WebHook
was called.
3. 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| Modifier and Type | Class and Description |
|---|---|
static class |
StreamingDetectIntentResponse.Builder
The top-level message returned from the
`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 |
ALTERNATIVE_QUERY_RESULTS_FIELD_NUMBER |
static int |
DEBUGGING_INFO_FIELD_NUMBER |
static int |
OUTPUT_AUDIO_CONFIG_FIELD_NUMBER |
static int |
OUTPUT_AUDIO_FIELD_NUMBER |
static int |
QUERY_RESULT_FIELD_NUMBER |
static int |
RECOGNITION_RESULT_FIELD_NUMBER |
static int |
RESPONSE_ID_FIELD_NUMBER |
static int |
WEBHOOK_STATUS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
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.
|
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.
|
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.
|
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.
|
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.
|
CloudConversationDebuggingInfo |
getDebuggingInfo()
Debugging info that would get populated when
`StreamingDetectIntentRequest.enable_debugging_info` is set to true.
|
CloudConversationDebuggingInfoOrBuilder |
getDebuggingInfoOrBuilder()
Debugging info that would get populated when
`StreamingDetectIntentRequest.enable_debugging_info` is set to true.
|
static StreamingDetectIntentResponse |
getDefaultInstance() |
StreamingDetectIntentResponse |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.ByteString |
getOutputAudio()
The audio data bytes encoded as specified in the request.
|
OutputAudioConfig |
getOutputAudioConfig()
The config used by the speech synthesizer to generate the output audio.
|
OutputAudioConfigOrBuilder |
getOutputAudioConfigOrBuilder()
The config used by the speech synthesizer to generate the output audio.
|
com.google.protobuf.Parser<StreamingDetectIntentResponse> |
getParserForType() |
QueryResult |
getQueryResult()
The selected results of the conversational query or event processing.
|
QueryResultOrBuilder |
getQueryResultOrBuilder()
The selected results of the conversational query or event processing.
|
StreamingRecognitionResult |
getRecognitionResult()
The result of speech recognition.
|
StreamingRecognitionResultOrBuilder |
getRecognitionResultOrBuilder()
The result of speech recognition.
|
String |
getResponseId()
The unique identifier of the response.
|
com.google.protobuf.ByteString |
getResponseIdBytes()
The unique identifier of the response.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
com.google.rpc.Status |
getWebhookStatus()
Specifies the status of the webhook request.
|
com.google.rpc.StatusOrBuilder |
getWebhookStatusOrBuilder()
Specifies the status of the webhook request.
|
boolean |
hasDebuggingInfo()
Debugging info that would get populated when
`StreamingDetectIntentRequest.enable_debugging_info` is set to true.
|
int |
hashCode() |
boolean |
hasOutputAudioConfig()
The config used by the speech synthesizer to generate the output audio.
|
boolean |
hasQueryResult()
The selected results of the conversational query or event processing.
|
boolean |
hasRecognitionResult()
The result of speech recognition.
|
boolean |
hasWebhookStatus()
Specifies the status of the webhook request.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static StreamingDetectIntentResponse.Builder |
newBuilder() |
static StreamingDetectIntentResponse.Builder |
newBuilder(StreamingDetectIntentResponse prototype) |
StreamingDetectIntentResponse.Builder |
newBuilderForType() |
protected StreamingDetectIntentResponse.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static StreamingDetectIntentResponse |
parseDelimitedFrom(InputStream input) |
static StreamingDetectIntentResponse |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(byte[] data) |
static StreamingDetectIntentResponse |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(ByteBuffer data) |
static StreamingDetectIntentResponse |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(com.google.protobuf.ByteString data) |
static StreamingDetectIntentResponse |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(com.google.protobuf.CodedInputStream input) |
static StreamingDetectIntentResponse |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(InputStream input) |
static StreamingDetectIntentResponse |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<StreamingDetectIntentResponse> |
parser() |
StreamingDetectIntentResponse.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 RESPONSE_ID_FIELD_NUMBER
public static final int RECOGNITION_RESULT_FIELD_NUMBER
public static final int QUERY_RESULT_FIELD_NUMBER
public static final int ALTERNATIVE_QUERY_RESULTS_FIELD_NUMBER
public static final int WEBHOOK_STATUS_FIELD_NUMBER
public static final int OUTPUT_AUDIO_FIELD_NUMBER
public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
public static final int 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 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;getResponseId in interface StreamingDetectIntentResponseOrBuilderpublic com.google.protobuf.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;getResponseIdBytes in interface StreamingDetectIntentResponseOrBuilderpublic boolean hasRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
hasRecognitionResult in interface StreamingDetectIntentResponseOrBuilderpublic StreamingRecognitionResult getRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
getRecognitionResult in interface StreamingDetectIntentResponseOrBuilderpublic StreamingRecognitionResultOrBuilder getRecognitionResultOrBuilder()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
getRecognitionResultOrBuilder in interface StreamingDetectIntentResponseOrBuilderpublic 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;hasQueryResult in interface StreamingDetectIntentResponseOrBuilderpublic 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;getQueryResult in interface StreamingDetectIntentResponseOrBuilderpublic 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;getQueryResultOrBuilder in interface StreamingDetectIntentResponseOrBuilderpublic 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;
getAlternativeQueryResultsList in interface StreamingDetectIntentResponseOrBuilderpublic 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;
getAlternativeQueryResultsOrBuilderList in interface StreamingDetectIntentResponseOrBuilderpublic 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;
getAlternativeQueryResultsCount in interface StreamingDetectIntentResponseOrBuilderpublic 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;
getAlternativeQueryResults in interface StreamingDetectIntentResponseOrBuilderpublic 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;
getAlternativeQueryResultsOrBuilder in interface StreamingDetectIntentResponseOrBuilderpublic boolean hasWebhookStatus()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;hasWebhookStatus in interface StreamingDetectIntentResponseOrBuilderpublic com.google.rpc.Status getWebhookStatus()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;getWebhookStatus in interface StreamingDetectIntentResponseOrBuilderpublic com.google.rpc.StatusOrBuilder getWebhookStatusOrBuilder()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;getWebhookStatusOrBuilder in interface StreamingDetectIntentResponseOrBuilderpublic com.google.protobuf.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;getOutputAudio in interface StreamingDetectIntentResponseOrBuilderpublic boolean hasOutputAudioConfig()
The config used by the speech synthesizer to generate the output audio.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;hasOutputAudioConfig in interface StreamingDetectIntentResponseOrBuilderpublic OutputAudioConfig getOutputAudioConfig()
The config used by the speech synthesizer to generate the output audio.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;getOutputAudioConfig in interface StreamingDetectIntentResponseOrBuilderpublic OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
The config used by the speech synthesizer to generate the output audio.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;getOutputAudioConfigOrBuilder in interface StreamingDetectIntentResponseOrBuilderpublic boolean hasDebuggingInfo()
Debugging info that would get populated when `StreamingDetectIntentRequest.enable_debugging_info` is set to true.
.google.cloud.dialogflow.v2beta1.CloudConversationDebuggingInfo debugging_info = 8;
hasDebuggingInfo in interface StreamingDetectIntentResponseOrBuilderpublic CloudConversationDebuggingInfo getDebuggingInfo()
Debugging info that would get populated when `StreamingDetectIntentRequest.enable_debugging_info` is set to true.
.google.cloud.dialogflow.v2beta1.CloudConversationDebuggingInfo debugging_info = 8;
getDebuggingInfo in interface StreamingDetectIntentResponseOrBuilderpublic CloudConversationDebuggingInfoOrBuilder getDebuggingInfoOrBuilder()
Debugging info that would get populated when `StreamingDetectIntentRequest.enable_debugging_info` is set to true.
.google.cloud.dialogflow.v2beta1.CloudConversationDebuggingInfo debugging_info = 8;
getDebuggingInfoOrBuilder in interface StreamingDetectIntentResponseOrBuilderpublic 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 StreamingDetectIntentResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StreamingDetectIntentResponse parseFrom(InputStream input) throws IOException
IOExceptionpublic static StreamingDetectIntentResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StreamingDetectIntentResponse parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static StreamingDetectIntentResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StreamingDetectIntentResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static StreamingDetectIntentResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic StreamingDetectIntentResponse.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static StreamingDetectIntentResponse.Builder newBuilder()
public static StreamingDetectIntentResponse.Builder newBuilder(StreamingDetectIntentResponse prototype)
public StreamingDetectIntentResponse.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected StreamingDetectIntentResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static StreamingDetectIntentResponse getDefaultInstance()
public static com.google.protobuf.Parser<StreamingDetectIntentResponse> parser()
public com.google.protobuf.Parser<StreamingDetectIntentResponse> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public StreamingDetectIntentResponse getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.