Class WordInfo.Builder (2.10.0)

public static final class WordInfo.Builder extends GeneratedMessageV3.Builder<WordInfo.Builder> implements WordInfoOrBuilder

Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as enable_word_time_offsets.

Protobuf type google.cloud.videointelligence.v1p3beta1.WordInfo

Implements

WordInfoOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WordInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WordInfo.Builder
Overrides

build()

public WordInfo build()
Returns
TypeDescription
WordInfo

buildPartial()

public WordInfo buildPartial()
Returns
TypeDescription
WordInfo

clear()

public WordInfo.Builder clear()
Returns
TypeDescription
WordInfo.Builder
Overrides

clearConfidence()

public WordInfo.Builder clearConfidence()

Output only. 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. 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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
WordInfo.Builder

This builder for chaining.

clearEndTime()

public WordInfo.Builder clearEndTime()

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration end_time = 2;

Returns
TypeDescription
WordInfo.Builder

clearField(Descriptors.FieldDescriptor field)

public WordInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
WordInfo.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public WordInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
WordInfo.Builder
Overrides

clearSpeakerTag()

public WordInfo.Builder clearSpeakerTag()

Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.

int32 speaker_tag = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
WordInfo.Builder

This builder for chaining.

clearStartTime()

public WordInfo.Builder clearStartTime()

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration start_time = 1;

Returns
TypeDescription
WordInfo.Builder

clearWord()

public WordInfo.Builder clearWord()

The word corresponding to this set of information.

string word = 3;

Returns
TypeDescription
WordInfo.Builder

This builder for chaining.

clone()

public WordInfo.Builder clone()
Returns
TypeDescription
WordInfo.Builder
Overrides

getConfidence()

public float getConfidence()

Output only. 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. 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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public WordInfo getDefaultInstanceForType()
Returns
TypeDescription
WordInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndTime()

public Duration getEndTime()

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration end_time = 2;

Returns
TypeDescription
Duration

The endTime.

getEndTimeBuilder()

public Duration.Builder getEndTimeBuilder()

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration end_time = 2;

Returns
TypeDescription
Builder

getEndTimeOrBuilder()

public DurationOrBuilder getEndTimeOrBuilder()

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration end_time = 2;

Returns
TypeDescription
DurationOrBuilder

getSpeakerTag()

public int getSpeakerTag()

Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.

int32 speaker_tag = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The speakerTag.

getStartTime()

public Duration getStartTime()

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration start_time = 1;

Returns
TypeDescription
Duration

The startTime.

getStartTimeBuilder()

public Duration.Builder getStartTimeBuilder()

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration start_time = 1;

Returns
TypeDescription
Builder

getStartTimeOrBuilder()

public DurationOrBuilder getStartTimeOrBuilder()

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration start_time = 1;

Returns
TypeDescription
DurationOrBuilder

getWord()

public String getWord()

The word corresponding to this set of information.

string word = 3;

Returns
TypeDescription
String

The word.

getWordBytes()

public ByteString getWordBytes()

The word corresponding to this set of information.

string word = 3;

Returns
TypeDescription
ByteString

The bytes for word.

hasEndTime()

public boolean hasEndTime()

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration end_time = 2;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration start_time = 1;

Returns
TypeDescription
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEndTime(Duration value)

public WordInfo.Builder mergeEndTime(Duration value)

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration end_time = 2;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
WordInfo.Builder

mergeFrom(WordInfo other)

public WordInfo.Builder mergeFrom(WordInfo other)
Parameter
NameDescription
otherWordInfo
Returns
TypeDescription
WordInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WordInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WordInfo.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WordInfo.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WordInfo.Builder
Overrides

mergeStartTime(Duration value)

public WordInfo.Builder mergeStartTime(Duration value)

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration start_time = 1;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
WordInfo.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WordInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WordInfo.Builder
Overrides

setConfidence(float value)

public WordInfo.Builder setConfidence(float value)

Output only. 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. 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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuefloat

The confidence to set.

Returns
TypeDescription
WordInfo.Builder

This builder for chaining.

setEndTime(Duration value)

public WordInfo.Builder setEndTime(Duration value)

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration end_time = 2;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
WordInfo.Builder

setEndTime(Duration.Builder builderForValue)

public WordInfo.Builder setEndTime(Duration.Builder builderForValue)

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration end_time = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
WordInfo.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WordInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WordInfo.Builder
Overrides

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

public WordInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
WordInfo.Builder
Overrides

setSpeakerTag(int value)

public WordInfo.Builder setSpeakerTag(int value)

Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.

int32 speaker_tag = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The speakerTag to set.

Returns
TypeDescription
WordInfo.Builder

This builder for chaining.

setStartTime(Duration value)

public WordInfo.Builder setStartTime(Duration value)

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration start_time = 1;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
WordInfo.Builder

setStartTime(Duration.Builder builderForValue)

public WordInfo.Builder setStartTime(Duration.Builder builderForValue)

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

.google.protobuf.Duration start_time = 1;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
WordInfo.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final WordInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WordInfo.Builder
Overrides

setWord(String value)

public WordInfo.Builder setWord(String value)

The word corresponding to this set of information.

string word = 3;

Parameter
NameDescription
valueString

The word to set.

Returns
TypeDescription
WordInfo.Builder

This builder for chaining.

setWordBytes(ByteString value)

public WordInfo.Builder setWordBytes(ByteString value)

The word corresponding to this set of information.

string word = 3;

Parameter
NameDescription
valueByteString

The bytes for word to set.

Returns
TypeDescription
WordInfo.Builder

This builder for chaining.