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: 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.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
ALTERNATIVE_QUERY_RESULTS_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 |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
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.
|
static StreamingDetectIntentResponse |
getDefaultInstance() |
StreamingDetectIntentResponse |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
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.
|
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.
|
ByteString |
getResponseIdBytes()
The unique identifier of the response.
|
int |
getSerializedSize() |
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.
|
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 GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static StreamingDetectIntentResponse.Builder |
newBuilder() |
static StreamingDetectIntentResponse.Builder |
newBuilder(StreamingDetectIntentResponse prototype) |
StreamingDetectIntentResponse.Builder |
newBuilderForType() |
protected StreamingDetectIntentResponse.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static StreamingDetectIntentResponse |
parseDelimitedFrom(InputStream input) |
static StreamingDetectIntentResponse |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(byte[] data) |
static StreamingDetectIntentResponse |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(ByteBuffer data) |
static StreamingDetectIntentResponse |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(ByteString data) |
static StreamingDetectIntentResponse |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(CodedInputStream input) |
static StreamingDetectIntentResponse |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static StreamingDetectIntentResponse |
parseFrom(InputStream input) |
static StreamingDetectIntentResponse |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<StreamingDetectIntentResponse> |
parser() |
StreamingDetectIntentResponse.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public 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
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
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;
getResponseId
in interface StreamingDetectIntentResponseOrBuilder
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;
getResponseIdBytes
in interface StreamingDetectIntentResponseOrBuilder
public boolean hasRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
hasRecognitionResult
in interface StreamingDetectIntentResponseOrBuilder
public StreamingRecognitionResult getRecognitionResult()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
getRecognitionResult
in interface StreamingDetectIntentResponseOrBuilder
public StreamingRecognitionResultOrBuilder getRecognitionResultOrBuilder()
The result of speech recognition.
.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;
getRecognitionResultOrBuilder
in interface StreamingDetectIntentResponseOrBuilder
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;
hasQueryResult
in interface StreamingDetectIntentResponseOrBuilder
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;
getQueryResult
in interface StreamingDetectIntentResponseOrBuilder
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;
getQueryResultOrBuilder
in interface StreamingDetectIntentResponseOrBuilder
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;
getAlternativeQueryResultsList
in interface StreamingDetectIntentResponseOrBuilder
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;
getAlternativeQueryResultsOrBuilderList
in interface StreamingDetectIntentResponseOrBuilder
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;
getAlternativeQueryResultsCount
in interface StreamingDetectIntentResponseOrBuilder
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;
getAlternativeQueryResults
in interface StreamingDetectIntentResponseOrBuilder
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;
getAlternativeQueryResultsOrBuilder
in interface StreamingDetectIntentResponseOrBuilder
public boolean hasWebhookStatus()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;
hasWebhookStatus
in interface StreamingDetectIntentResponseOrBuilder
public com.google.rpc.Status getWebhookStatus()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;
getWebhookStatus
in interface StreamingDetectIntentResponseOrBuilder
public com.google.rpc.StatusOrBuilder getWebhookStatusOrBuilder()
Specifies the status of the webhook request.
.google.rpc.Status webhook_status = 4;
getWebhookStatusOrBuilder
in interface StreamingDetectIntentResponseOrBuilder
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;
getOutputAudio
in interface StreamingDetectIntentResponseOrBuilder
public 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 StreamingDetectIntentResponseOrBuilder
public 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 StreamingDetectIntentResponseOrBuilder
public 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 StreamingDetectIntentResponseOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static StreamingDetectIntentResponse parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingDetectIntentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingDetectIntentResponse parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingDetectIntentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingDetectIntentResponse parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingDetectIntentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static StreamingDetectIntentResponse parseFrom(InputStream input) throws IOException
IOException
public static StreamingDetectIntentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StreamingDetectIntentResponse parseDelimitedFrom(InputStream input) throws IOException
IOException
public static StreamingDetectIntentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StreamingDetectIntentResponse parseFrom(CodedInputStream input) throws IOException
IOException
public static StreamingDetectIntentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public StreamingDetectIntentResponse.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static StreamingDetectIntentResponse.Builder newBuilder()
public static StreamingDetectIntentResponse.Builder newBuilder(StreamingDetectIntentResponse prototype)
public StreamingDetectIntentResponse.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected StreamingDetectIntentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static StreamingDetectIntentResponse getDefaultInstance()
public static Parser<StreamingDetectIntentResponse> parser()
public Parser<StreamingDetectIntentResponse> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public StreamingDetectIntentResponse getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.