Class SpeechRecognitionAlternative.Builder (4.38.0)

public static final class SpeechRecognitionAlternative.Builder extends GeneratedMessageV3.Builder<SpeechRecognitionAlternative.Builder> implements SpeechRecognitionAlternativeOrBuilder

Alternative hypotheses (a.k.a. n-best list).

Protobuf type google.cloud.speech.v1.SpeechRecognitionAlternative

Static Methods

getDescriptor()

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

Methods

addAllWords(Iterable<? extends WordInfo> values)

public SpeechRecognitionAlternative.Builder addAllWords(Iterable<? extends WordInfo> values)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.speech.v1.WordInfo>
Returns
Type Description
SpeechRecognitionAlternative.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SpeechRecognitionAlternative.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

addWords(WordInfo value)

public SpeechRecognitionAlternative.Builder addWords(WordInfo value)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameter
Name Description
value WordInfo
Returns
Type Description
SpeechRecognitionAlternative.Builder

addWords(WordInfo.Builder builderForValue)

public SpeechRecognitionAlternative.Builder addWords(WordInfo.Builder builderForValue)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameter
Name Description
builderForValue WordInfo.Builder
Returns
Type Description
SpeechRecognitionAlternative.Builder

addWords(int index, WordInfo value)

public SpeechRecognitionAlternative.Builder addWords(int index, WordInfo value)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameters
Name Description
index int
value WordInfo
Returns
Type Description
SpeechRecognitionAlternative.Builder

addWords(int index, WordInfo.Builder builderForValue)

public SpeechRecognitionAlternative.Builder addWords(int index, WordInfo.Builder builderForValue)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameters
Name Description
index int
builderForValue WordInfo.Builder
Returns
Type Description
SpeechRecognitionAlternative.Builder

addWordsBuilder()

public WordInfo.Builder addWordsBuilder()

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Returns
Type Description
WordInfo.Builder

addWordsBuilder(int index)

public WordInfo.Builder addWordsBuilder(int index)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameter
Name Description
index int
Returns
Type Description
WordInfo.Builder

build()

public SpeechRecognitionAlternative build()
Returns
Type Description
SpeechRecognitionAlternative

buildPartial()

public SpeechRecognitionAlternative buildPartial()
Returns
Type Description
SpeechRecognitionAlternative

clear()

public SpeechRecognitionAlternative.Builder clear()
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

clearConfidence()

public SpeechRecognitionAlternative.Builder clearConfidence()

The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where is_final=true. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating confidence was not set.

float confidence = 2;

Returns
Type Description
SpeechRecognitionAlternative.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SpeechRecognitionAlternative.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SpeechRecognitionAlternative.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

clearTranscript()

public SpeechRecognitionAlternative.Builder clearTranscript()

Transcript text representing the words that the user spoke. In languages that use spaces to separate words, the transcript might have a leading space if it isn't the first result. You can concatenate each result to obtain the full transcript without using a separator.

string transcript = 1;

Returns
Type Description
SpeechRecognitionAlternative.Builder

This builder for chaining.

clearWords()

public SpeechRecognitionAlternative.Builder clearWords()

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Returns
Type Description
SpeechRecognitionAlternative.Builder

clone()

public SpeechRecognitionAlternative.Builder clone()
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

getConfidence()

public float getConfidence()

The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where is_final=true. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating confidence was not set.

float confidence = 2;

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public SpeechRecognitionAlternative getDefaultInstanceForType()
Returns
Type Description
SpeechRecognitionAlternative

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getTranscript()

public String getTranscript()

Transcript text representing the words that the user spoke. In languages that use spaces to separate words, the transcript might have a leading space if it isn't the first result. You can concatenate each result to obtain the full transcript without using a separator.

string transcript = 1;

Returns
Type Description
String

The transcript.

getTranscriptBytes()

public ByteString getTranscriptBytes()

Transcript text representing the words that the user spoke. In languages that use spaces to separate words, the transcript might have a leading space if it isn't the first result. You can concatenate each result to obtain the full transcript without using a separator.

string transcript = 1;

Returns
Type Description
ByteString

The bytes for transcript.

getWords(int index)

public WordInfo getWords(int index)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameter
Name Description
index int
Returns
Type Description
WordInfo

getWordsBuilder(int index)

public WordInfo.Builder getWordsBuilder(int index)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameter
Name Description
index int
Returns
Type Description
WordInfo.Builder

getWordsBuilderList()

public List<WordInfo.Builder> getWordsBuilderList()

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Returns
Type Description
List<Builder>

getWordsCount()

public int getWordsCount()

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Returns
Type Description
int

getWordsList()

public List<WordInfo> getWordsList()

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Returns
Type Description
List<WordInfo>

getWordsOrBuilder(int index)

public WordInfoOrBuilder getWordsOrBuilder(int index)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameter
Name Description
index int
Returns
Type Description
WordInfoOrBuilder

getWordsOrBuilderList()

public List<? extends WordInfoOrBuilder> getWordsOrBuilderList()

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Returns
Type Description
List<? extends com.google.cloud.speech.v1.WordInfoOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SpeechRecognitionAlternative other)

public SpeechRecognitionAlternative.Builder mergeFrom(SpeechRecognitionAlternative other)
Parameter
Name Description
other SpeechRecognitionAlternative
Returns
Type Description
SpeechRecognitionAlternative.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SpeechRecognitionAlternative.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SpeechRecognitionAlternative.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SpeechRecognitionAlternative.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

removeWords(int index)

public SpeechRecognitionAlternative.Builder removeWords(int index)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameter
Name Description
index int
Returns
Type Description
SpeechRecognitionAlternative.Builder

setConfidence(float value)

public SpeechRecognitionAlternative.Builder setConfidence(float value)

The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where is_final=true. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating confidence was not set.

float confidence = 2;

Parameter
Name Description
value float

The confidence to set.

Returns
Type Description
SpeechRecognitionAlternative.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SpeechRecognitionAlternative.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SpeechRecognitionAlternative.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

setTranscript(String value)

public SpeechRecognitionAlternative.Builder setTranscript(String value)

Transcript text representing the words that the user spoke. In languages that use spaces to separate words, the transcript might have a leading space if it isn't the first result. You can concatenate each result to obtain the full transcript without using a separator.

string transcript = 1;

Parameter
Name Description
value String

The transcript to set.

Returns
Type Description
SpeechRecognitionAlternative.Builder

This builder for chaining.

setTranscriptBytes(ByteString value)

public SpeechRecognitionAlternative.Builder setTranscriptBytes(ByteString value)

Transcript text representing the words that the user spoke. In languages that use spaces to separate words, the transcript might have a leading space if it isn't the first result. You can concatenate each result to obtain the full transcript without using a separator.

string transcript = 1;

Parameter
Name Description
value ByteString

The bytes for transcript to set.

Returns
Type Description
SpeechRecognitionAlternative.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SpeechRecognitionAlternative.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SpeechRecognitionAlternative.Builder
Overrides

setWords(int index, WordInfo value)

public SpeechRecognitionAlternative.Builder setWords(int index, WordInfo value)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameters
Name Description
index int
value WordInfo
Returns
Type Description
SpeechRecognitionAlternative.Builder

setWords(int index, WordInfo.Builder builderForValue)

public SpeechRecognitionAlternative.Builder setWords(int index, WordInfo.Builder builderForValue)

A list of word-specific information for each recognized word. Note: When enable_speaker_diarization is true, you will see all the words from the beginning of the audio.

repeated .google.cloud.speech.v1.WordInfo words = 3;

Parameters
Name Description
index int
builderForValue WordInfo.Builder
Returns
Type Description
SpeechRecognitionAlternative.Builder