Class StreamingRecognitionResult (4.43.0)

public final class StreamingRecognitionResult extends 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.

While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript.

If StreamingDetectIntentRequest.query_input.audio_config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript.

The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results.

In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.

Numtranscriptmessage_typeis_final
1"tube"TRANSCRIPTfalse
2"to be a"TRANSCRIPTfalse
3"to be"TRANSCRIPTfalse
4"to be or not to be"TRANSCRIPTtrue
5"that's"TRANSCRIPTfalse
6"that isTRANSCRIPTfalse
7unsetEND_OF_SINGLE_UTTERANCEunset
8" that is the question"TRANSCRIPTtrue

Concatenating the finalized transcripts with is_final` set to true, the complete utterance becomes "to be or not to be that is the question".

Protobuf type google.cloud.dialogflow.v2.StreamingRecognitionResult

Static Fields

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

IS_FINAL_FIELD_NUMBER

public static final int IS_FINAL_FIELD_NUMBER
Field Value
TypeDescription
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

MESSAGE_TYPE_FIELD_NUMBER

public static final int MESSAGE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

SPEECH_END_OFFSET_FIELD_NUMBER

public static final int SPEECH_END_OFFSET_FIELD_NUMBER
Field Value
TypeDescription
int

SPEECH_WORD_INFO_FIELD_NUMBER

public static final int SPEECH_WORD_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSCRIPT_FIELD_NUMBER

public static final int TRANSCRIPT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StreamingRecognitionResult getDefaultInstance()
Returns
TypeDescription
StreamingRecognitionResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StreamingRecognitionResult.Builder newBuilder()
Returns
TypeDescription
StreamingRecognitionResult.Builder

newBuilder(StreamingRecognitionResult prototype)

public static StreamingRecognitionResult.Builder newBuilder(StreamingRecognitionResult prototype)
Parameter
NameDescription
prototypeStreamingRecognitionResult
Returns
TypeDescription
StreamingRecognitionResult.Builder

parseDelimitedFrom(InputStream input)

public static StreamingRecognitionResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StreamingRecognitionResult parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamingRecognitionResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamingRecognitionResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StreamingRecognitionResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StreamingRecognitionResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingRecognitionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StreamingRecognitionResult> parser()
Returns
TypeDescription
Parser<StreamingRecognitionResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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;

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public StreamingRecognitionResult getDefaultInstanceForType()
Returns
TypeDescription
StreamingRecognitionResult

getIsFinal()

public boolean getIsFinal()

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 message_type = TRANSCRIPT.

bool is_final = 3;

Returns
TypeDescription
boolean

The isFinal.

getLanguageCode()

public String getLanguageCode()

Detected language code for the transcript.

string language_code = 10;

Returns
TypeDescription
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Detected language code for the transcript.

string language_code = 10;

Returns
TypeDescription
ByteString

The bytes for languageCode.

getMessageType()

public StreamingRecognitionResult.MessageType getMessageType()

Type of the result message.

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

Returns
TypeDescription
StreamingRecognitionResult.MessageType

The messageType.

getMessageTypeValue()

public int getMessageTypeValue()

Type of the result message.

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

Returns
TypeDescription
int

The enum numeric value on the wire for messageType.

getParserForType()

public Parser<StreamingRecognitionResult> getParserForType()
Returns
TypeDescription
Parser<StreamingRecognitionResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpeechEndOffset()

public Duration getSpeechEndOffset()

Time offset of the end of this Speech recognition result relative to the beginning of the audio. Only populated for message_type = TRANSCRIPT.

.google.protobuf.Duration speech_end_offset = 8;

Returns
TypeDescription
Duration

The speechEndOffset.

getSpeechEndOffsetOrBuilder()

public DurationOrBuilder getSpeechEndOffsetOrBuilder()

Time offset of the end of this Speech recognition result relative to the beginning of the audio. Only populated for message_type = TRANSCRIPT.

.google.protobuf.Duration speech_end_offset = 8;

Returns
TypeDescription
DurationOrBuilder

getSpeechWordInfo(int index)

public SpeechWordInfo getSpeechWordInfo(int index)

Word-specific information for the words recognized by Speech in transcript. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
SpeechWordInfo

getSpeechWordInfoCount()

public int getSpeechWordInfoCount()

Word-specific information for the words recognized by Speech in transcript. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;

Returns
TypeDescription
int

getSpeechWordInfoList()

public List<SpeechWordInfo> getSpeechWordInfoList()

Word-specific information for the words recognized by Speech in transcript. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;

Returns
TypeDescription
List<SpeechWordInfo>

getSpeechWordInfoOrBuilder(int index)

public SpeechWordInfoOrBuilder getSpeechWordInfoOrBuilder(int index)

Word-specific information for the words recognized by Speech in transcript. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
SpeechWordInfoOrBuilder

getSpeechWordInfoOrBuilderList()

public List<? extends SpeechWordInfoOrBuilder> getSpeechWordInfoOrBuilderList()

Word-specific information for the words recognized by Speech in transcript. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

repeated .google.cloud.dialogflow.v2.SpeechWordInfo speech_word_info = 7;

Returns
TypeDescription
List<? extends com.google.cloud.dialogflow.v2.SpeechWordInfoOrBuilder>

getTranscript()

public String getTranscript()

Transcript text representing the words that the user spoke. Populated if and only if message_type = TRANSCRIPT.

string transcript = 2;

Returns
TypeDescription
String

The transcript.

getTranscriptBytes()

public ByteString getTranscriptBytes()

Transcript text representing the words that the user spoke. Populated if and only if message_type = TRANSCRIPT.

string transcript = 2;

Returns
TypeDescription
ByteString

The bytes for transcript.

hasSpeechEndOffset()

public boolean hasSpeechEndOffset()

Time offset of the end of this Speech recognition result relative to the beginning of the audio. Only populated for message_type = TRANSCRIPT.

.google.protobuf.Duration speech_end_offset = 8;

Returns
TypeDescription
boolean

Whether the speechEndOffset field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StreamingRecognitionResult.Builder newBuilderForType()
Returns
TypeDescription
StreamingRecognitionResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StreamingRecognitionResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StreamingRecognitionResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StreamingRecognitionResult.Builder toBuilder()
Returns
TypeDescription
StreamingRecognitionResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException