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

Static Fields

ALTERNATIVES_FIELD_NUMBER

public static final int ALTERNATIVES_FIELD_NUMBER
Field Value
TypeDescription
int

CHANNEL_TAG_FIELD_NUMBER

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

RESULT_END_TIME_FIELD_NUMBER

public static final int RESULT_END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STABILITY_FIELD_NUMBER

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

getAlternatives(int index)

public SpeechRecognitionAlternative getAlternatives(int index)

May contain one or more recognition hypotheses (up to the maximum specified in max_alternatives). 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.v1.SpeechRecognitionAlternative alternatives = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SpeechRecognitionAlternative

getAlternativesCount()

public int getAlternativesCount()

May contain one or more recognition hypotheses (up to the maximum specified in max_alternatives). 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.v1.SpeechRecognitionAlternative alternatives = 1;

Returns
TypeDescription
int

getAlternativesList()

public List<SpeechRecognitionAlternative> getAlternativesList()

May contain one or more recognition hypotheses (up to the maximum specified in max_alternatives). 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.v1.SpeechRecognitionAlternative alternatives = 1;

Returns
TypeDescription
List<SpeechRecognitionAlternative>

getAlternativesOrBuilder(int index)

public SpeechRecognitionAlternativeOrBuilder getAlternativesOrBuilder(int index)

May contain one or more recognition hypotheses (up to the maximum specified in max_alternatives). 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.v1.SpeechRecognitionAlternative alternatives = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SpeechRecognitionAlternativeOrBuilder

getAlternativesOrBuilderList()

public List<? extends SpeechRecognitionAlternativeOrBuilder> getAlternativesOrBuilderList()

May contain one or more recognition hypotheses (up to the maximum specified in max_alternatives). 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.v1.SpeechRecognitionAlternative alternatives = 1;

Returns
TypeDescription
List<? extends com.google.cloud.speech.v1.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
TypeDescription
int

The channelTag.

getDefaultInstanceForType()

public StreamingRecognitionResult getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for languageCode.

getParserForType()

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

getResultEndTime()

public Duration getResultEndTime()

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

.google.protobuf.Duration result_end_time = 4;

Returns
TypeDescription
Duration

The resultEndTime.

getResultEndTimeOrBuilder()

public DurationOrBuilder getResultEndTimeOrBuilder()

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

.google.protobuf.Duration result_end_time = 4;

Returns
TypeDescription
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
float

The stability.

hasResultEndTime()

public boolean hasResultEndTime()

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

.google.protobuf.Duration result_end_time = 4;

Returns
TypeDescription
boolean

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