Class StreamingRecognitionResult (4.40.0)

public final class StreamingRecognitionResult extends GeneratedMessageV3 implements StreamingRecognitionResultOrBuilder

A streaming speech recognition result corresponding to a portion of the audio that is currently being processed.

Protobuf type google.cloud.speech.v2.StreamingRecognitionResult

Static Fields

ALTERNATIVES_FIELD_NUMBER

public static final int ALTERNATIVES_FIELD_NUMBER
Field Value
Type Description
int

CHANNEL_TAG_FIELD_NUMBER

public static final int CHANNEL_TAG_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

RESULT_END_OFFSET_FIELD_NUMBER

public static final int RESULT_END_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

STABILITY_FIELD_NUMBER

public static final int STABILITY_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

getAlternatives(int index)

public SpeechRecognitionAlternative getAlternatives(int index)

May contain one or more recognition hypotheses. These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;

Parameter
Name Description
index int
Returns
Type Description
SpeechRecognitionAlternative

getAlternativesCount()

public int getAlternativesCount()

May contain one or more recognition hypotheses. These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;

Returns
Type Description
int

getAlternativesList()

public List<SpeechRecognitionAlternative> getAlternativesList()

May contain one or more recognition hypotheses. These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;

Returns
Type Description
List<SpeechRecognitionAlternative>

getAlternativesOrBuilder(int index)

public SpeechRecognitionAlternativeOrBuilder getAlternativesOrBuilder(int index)

May contain one or more recognition hypotheses. These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;

Parameter
Name Description
index int
Returns
Type Description
SpeechRecognitionAlternativeOrBuilder

getAlternativesOrBuilderList()

public List<? extends SpeechRecognitionAlternativeOrBuilder> getAlternativesOrBuilderList()

May contain one or more recognition hypotheses. These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;

Returns
Type Description
List<? extends com.google.cloud.speech.v2.SpeechRecognitionAlternativeOrBuilder>

getChannelTag()

public int getChannelTag()

For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For audio_channel_count = N, its output values can range from 1 to N.

int32 channel_tag = 5;

Returns
Type Description
int

The channelTag.

getDefaultInstanceForType()

public StreamingRecognitionResult getDefaultInstanceForType()
Returns
Type Description
StreamingRecognitionResult

getIsFinal()

public boolean getIsFinal()

If false, this StreamingRecognitionResult represents an interim result that may change. If true, this is the final time the speech service will return this particular StreamingRecognitionResult, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio.

bool is_final = 2;

Returns
Type Description
boolean

The isFinal.

getLanguageCode()

public String getLanguageCode()

Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.

string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.

string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for languageCode.

getParserForType()

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

getResultEndOffset()

public Duration getResultEndOffset()

Time offset of the end of this result relative to the beginning of the audio.

.google.protobuf.Duration result_end_offset = 4;

Returns
Type Description
Duration

The resultEndOffset.

getResultEndOffsetOrBuilder()

public DurationOrBuilder getResultEndOffsetOrBuilder()

Time offset of the end of this result relative to the beginning of the audio.

.google.protobuf.Duration result_end_offset = 4;

Returns
Type Description
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStability()

public float getStability()

An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable). This field is only provided for interim results (is_final=false). The default of 0.0 is a sentinel value indicating stability was not set.

float stability = 3;

Returns
Type Description
float

The stability.

hasResultEndOffset()

public boolean hasResultEndOffset()

Time offset of the end of this result relative to the beginning of the audio.

.google.protobuf.Duration result_end_offset = 4;

Returns
Type Description
boolean

Whether the resultEndOffset 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