Class StreamingDetectIntentResponse (4.6.0)

Version 4.6.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

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 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StreamingDetectIntentResponse

Implements

StreamingDetectIntentResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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()

Returns

Type	Description
StreamingDetectIntentResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static StreamingDetectIntentResponse.Builder newBuilder()

Returns

Type	Description
StreamingDetectIntentResponse.Builder

newBuilder(StreamingDetectIntentResponse prototype)

public static StreamingDetectIntentResponse.Builder newBuilder(StreamingDetectIntentResponse prototype)

Parameter

Name	Description
prototype	StreamingDetectIntentResponse

Returns

Type	Description
StreamingDetectIntentResponse.Builder

parseDelimitedFrom(InputStream input)

public static StreamingDetectIntentResponse parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingDetectIntentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static StreamingDetectIntentResponse parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamingDetectIntentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamingDetectIntentResponse parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamingDetectIntentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamingDetectIntentResponse parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingDetectIntentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static StreamingDetectIntentResponse parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingDetectIntentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static StreamingDetectIntentResponse parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamingDetectIntentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StreamingDetectIntentResponse

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<StreamingDetectIntentResponse> parser()

Returns

Type	Description
Parser<StreamingDetectIntentResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

Returns

Type	Description
QueryResult

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;

Returns

Type	Description
List<QueryResult>

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

Returns

Type	Description
QueryResultOrBuilder

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()

Returns

Type	Description
StreamingDetectIntentResponse

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;

Returns

Type	Description
OutputAudioConfig	The outputAudioConfig.

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;

Returns

Type	Description
OutputAudioConfigOrBuilder

getParserForType()

public Parser<StreamingDetectIntentResponse> getParserForType()

Returns

Type	Description
Parser<StreamingDetectIntentResponse>

Overrides

GeneratedMessageV3.getParserForType()

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;

Returns

Type	Description
QueryResult	The queryResult.

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;

Returns

Type	Description
QueryResultOrBuilder

getRecognitionResult()

public StreamingRecognitionResult getRecognitionResult()

The result of speech recognition.

.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;

Returns

Type	Description
StreamingRecognitionResult	The recognitionResult.

getRecognitionResultOrBuilder()

public StreamingRecognitionResultOrBuilder getRecognitionResultOrBuilder()

The result of speech recognition.

.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult recognition_result = 2;

Returns

Type	Description
StreamingRecognitionResultOrBuilder

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

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public StreamingDetectIntentResponse.Builder newBuilderForType()

Returns

Type	Description
StreamingDetectIntentResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StreamingDetectIntentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
StreamingDetectIntentResponse.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public StreamingDetectIntentResponse.Builder toBuilder()

Returns

Type	Description
StreamingDetectIntentResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException