Class StreamingRecognitionResult (4.57.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.

Num transcript message_type is_final
1 "tube" TRANSCRIPT false
2 "to be a" TRANSCRIPT false
3 "to be" TRANSCRIPT false
4 "to be or not to be" TRANSCRIPT true
5 "that's" TRANSCRIPT false
6 "that is TRANSCRIPT false
7 unset END_OF_SINGLE_UTTERANCE unset
8 " that is the question" TRANSCRIPT true

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.v2beta1.StreamingRecognitionResult

Static Fields

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

DTMF_DIGITS_FIELD_NUMBER

public static final int DTMF_DIGITS_FIELD_NUMBER
Field Value
Type Description
int

IS_FINAL_FIELD_NUMBER

public static final int IS_FINAL_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_TYPE_FIELD_NUMBER

public static final int MESSAGE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SPEECH_END_OFFSET_FIELD_NUMBER

public static final int SPEECH_END_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

SPEECH_WORD_INFO_FIELD_NUMBER

public static final int SPEECH_WORD_INFO_FIELD_NUMBER
Field Value
Type Description
int

STABILITY_FIELD_NUMBER

public static final int STABILITY_FIELD_NUMBER
Field Value
Type Description
int

TRANSCRIPT_FIELD_NUMBER

public static final int TRANSCRIPT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StreamingRecognitionResult getDefaultInstance()
Returns
Type Description
StreamingRecognitionResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StreamingRecognitionResult.Builder newBuilder()
Returns
Type Description
StreamingRecognitionResult.Builder

newBuilder(StreamingRecognitionResult prototype)

public static StreamingRecognitionResult.Builder newBuilder(StreamingRecognitionResult prototype)
Parameter
Name Description
prototype StreamingRecognitionResult
Returns
Type Description
StreamingRecognitionResult.Builder

parseDelimitedFrom(InputStream input)

public static StreamingRecognitionResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StreamingRecognitionResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamingRecognitionResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamingRecognitionResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StreamingRecognitionResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StreamingRecognitionResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamingRecognitionResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingRecognitionResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StreamingRecognitionResult> parser()
Returns
Type Description
Parser<StreamingRecognitionResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
float

The confidence.

getDefaultInstanceForType()

public StreamingRecognitionResult getDefaultInstanceForType()
Returns
Type Description
StreamingRecognitionResult

getDtmfDigits()

public TelephonyDtmfEvents getDtmfDigits()

DTMF digits. Populated if and only if message_type = DTMF_DIGITS.

.google.cloud.dialogflow.v2beta1.TelephonyDtmfEvents dtmf_digits = 5;

Returns
Type Description
TelephonyDtmfEvents

The dtmfDigits.

getDtmfDigitsOrBuilder()

public TelephonyDtmfEventsOrBuilder getDtmfDigitsOrBuilder()

DTMF digits. Populated if and only if message_type = DTMF_DIGITS.

.google.cloud.dialogflow.v2beta1.TelephonyDtmfEvents dtmf_digits = 5;

Returns
Type Description
TelephonyDtmfEventsOrBuilder

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
Type Description
boolean

The isFinal.

getLanguageCode()

public String getLanguageCode()

Detected language code for the transcript.

string language_code = 10;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Detected language code for the transcript.

string language_code = 10;

Returns
Type Description
ByteString

The bytes for languageCode.

getMessageType()

public StreamingRecognitionResult.MessageType getMessageType()

Type of the result message.

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

Returns
Type Description
StreamingRecognitionResult.MessageType

The messageType.

getMessageTypeValue()

public int getMessageTypeValue()

Type of the result message.

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

Returns
Type Description
int

The enum numeric value on the wire for messageType.

getParserForType()

public Parser<StreamingRecognitionResult> getParserForType()
Returns
Type Description
Parser<StreamingRecognitionResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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.v2beta1.SpeechWordInfo speech_word_info = 7;

Parameter
Name Description
index int
Returns
Type Description
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.v2beta1.SpeechWordInfo speech_word_info = 7;

Returns
Type Description
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.v2beta1.SpeechWordInfo speech_word_info = 7;

Returns
Type Description
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.v2beta1.SpeechWordInfo speech_word_info = 7;

Parameter
Name Description
index int
Returns
Type Description
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.v2beta1.SpeechWordInfo speech_word_info = 7;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.SpeechWordInfoOrBuilder>

getStability()

public float getStability()

An estimate of the likelihood that the speech recognizer will not change its guess about this interim recognition result:

  • If the value is unspecified or 0.0, Dialogflow didn't compute the stability. In particular, Dialogflow will only provide stability for TRANSCRIPT results with is_final = false.
  • Otherwise, the value is in (0.0, 1.0] where 0.0 means completely unstable and 1.0 means completely stable.

float stability = 6;

Returns
Type Description
float

The stability.

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
Type Description
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
Type Description
ByteString

The bytes for transcript.

hasDtmfDigits()

public boolean hasDtmfDigits()

DTMF digits. Populated if and only if message_type = DTMF_DIGITS.

.google.cloud.dialogflow.v2beta1.TelephonyDtmfEvents dtmf_digits = 5;

Returns
Type Description
boolean

Whether the dtmfDigits field is set.

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
Type Description
boolean

Whether the speechEndOffset field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StreamingRecognitionResult.Builder newBuilderForType()
Returns
Type Description
StreamingRecognitionResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StreamingRecognitionResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StreamingRecognitionResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StreamingRecognitionResult.Builder toBuilder()
Returns
Type Description
StreamingRecognitionResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException