com.google.cloud.dialogflow.v2beta1

Class StreamingRecognitionResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult

All Implemented Interfaces:

StreamingRecognitionResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class StreamingRecognitionResult
extends com.google.protobuf.GeneratedMessageV3
implements StreamingRecognitionResultOrBuilder

 Contains a speech recognition result corresponding to a portion of the audio
 that is currently being processed or an indication that this is the end
 of the single requested utterance.
 Example:
 1.  transcript: "tube"
 2.  transcript: "to be a"
 3.  transcript: "to be"
 4.  transcript: "to be or not to be"
     is_final: true
 5.  transcript: " that's"
 6.  transcript: " that is"
 7.  recognition_event_type: `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE`
 8.  transcript: " that is the question"
     is_final: true
 Only two of the responses contain final results (#4 and #8 indicated by
 `is_final: true`). Concatenating these generates the full transcript: "to be
 or not to be that is the question".
 In each response we populate:
 *  for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`.
 *  for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`.
 

Protobuf type google.cloud.dialogflow.v2beta1.StreamingRecognitionResult

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamingRecognitionResult.Builder Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.
static class	StreamingRecognitionResult.MessageType Type of the response message.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONFIDENCE_FIELD_NUMBER
static int	IS_FINAL_FIELD_NUMBER
static int	MESSAGE_TYPE_FIELD_NUMBER
static int	TRANSCRIPT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
float	getConfidence() The Speech confidence between 0.0 and 1.0 for the current portion of audio.
static StreamingRecognitionResult	getDefaultInstance()
StreamingRecognitionResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getIsFinal() The default of 0.0 is a sentinel value indicating `confidence` was not set.
StreamingRecognitionResult.MessageType	getMessageType() Type of the result message.
int	getMessageTypeValue() Type of the result message.
com.google.protobuf.Parser<StreamingRecognitionResult>	getParserForType()
int	getSerializedSize()
String	getTranscript() Transcript text representing the words that the user spoke.
com.google.protobuf.ByteString	getTranscriptBytes() Transcript text representing the words that the user spoke.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static StreamingRecognitionResult.Builder	newBuilder()
static StreamingRecognitionResult.Builder	newBuilder(StreamingRecognitionResult prototype)
StreamingRecognitionResult.Builder	newBuilderForType()
protected StreamingRecognitionResult.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static StreamingRecognitionResult	parseDelimitedFrom(InputStream input)
static StreamingRecognitionResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognitionResult	parseFrom(byte[] data)
static StreamingRecognitionResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognitionResult	parseFrom(ByteBuffer data)
static StreamingRecognitionResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognitionResult	parseFrom(com.google.protobuf.ByteString data)
static StreamingRecognitionResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognitionResult	parseFrom(com.google.protobuf.CodedInputStream input)
static StreamingRecognitionResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamingRecognitionResult	parseFrom(InputStream input)
static StreamingRecognitionResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StreamingRecognitionResult>	parser()
StreamingRecognitionResult.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MESSAGE_TYPE_FIELD_NUMBER

public static final int MESSAGE_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

TRANSCRIPT_FIELD_NUMBER

public static final int TRANSCRIPT_FIELD_NUMBER

See Also:

Constant Field Values

IS_FINAL_FIELD_NUMBER

public static final int IS_FINAL_FIELD_NUMBER

See Also:

Constant Field Values

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getMessageTypeValue

public int getMessageTypeValue()

 Type of the result message.
 

.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.MessageType message_type = 1;

Specified by:

getMessageTypeValue in interface StreamingRecognitionResultOrBuilder

getMessageType

public StreamingRecognitionResult.MessageType getMessageType()

 Type of the result message.
 

.google.cloud.dialogflow.v2beta1.StreamingRecognitionResult.MessageType message_type = 1;

Specified by:

getMessageType in interface StreamingRecognitionResultOrBuilder

getTranscript

public String getTranscript()

 Transcript text representing the words that the user spoke.
 Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

string transcript = 2;

Specified by:

getTranscript in interface StreamingRecognitionResultOrBuilder

getTranscriptBytes

public com.google.protobuf.ByteString getTranscriptBytes()

 Transcript text representing the words that the user spoke.
 Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

string transcript = 2;

Specified by:

getTranscriptBytes in interface StreamingRecognitionResultOrBuilder

getIsFinal

public boolean getIsFinal()

 The default of 0.0 is a sentinel value indicating `confidence` was not set.
 If `false`, the `StreamingRecognitionResult` represents an
 interim result that may change. If `true`, the recognizer will not return
 any further hypotheses about this piece of the audio. May only be populated
 for `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
 

bool is_final = 3;

Specified by:

getIsFinal in interface StreamingRecognitionResultOrBuilder

getConfidence

public float getConfidence()

 The Speech confidence between 0.0 and 1.0 for the current portion of audio.
 A higher number indicates an estimated greater likelihood that the
 recognized words are correct. The default of 0.0 is a sentinel value
 indicating that confidence was not set.
 This field is typically only provided if `is_final` is true and you should
 not rely on it being accurate or even set.
 

float confidence = 4;

Specified by:

getConfidence in interface StreamingRecognitionResultOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static StreamingRecognitionResult parseFrom(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingRecognitionResult parseFrom(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingRecognitionResult parseFrom(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingRecognitionResult parseFrom(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingRecognitionResult parseFrom(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingRecognitionResult parseFrom(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingRecognitionResult parseFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static StreamingRecognitionResult parseFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static StreamingRecognitionResult parseDelimitedFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static StreamingRecognitionResult parseDelimitedFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseFrom

public static StreamingRecognitionResult parseFrom(com.google.protobuf.CodedInputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static StreamingRecognitionResult parseFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

newBuilderForType

public StreamingRecognitionResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StreamingRecognitionResult.Builder newBuilder()

newBuilder

public static StreamingRecognitionResult.Builder newBuilder(StreamingRecognitionResult prototype)

toBuilder

public StreamingRecognitionResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StreamingRecognitionResult.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static StreamingRecognitionResult getDefaultInstance()

parser

public static com.google.protobuf.Parser<StreamingRecognitionResult> parser()

getParserForType

public com.google.protobuf.Parser<StreamingRecognitionResult> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public StreamingRecognitionResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder