Class WordInfo (2.34.0)

public final class WordInfo extends GeneratedMessageV3 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.v1.WordInfo

Implements

WordInfoOrBuilder

Static Fields

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

SPEAKER_TAG_FIELD_NUMBER

public static final int SPEAKER_TAG_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

WORD_FIELD_NUMBER

public static final int WORD_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static WordInfo getDefaultInstance()
Returns
TypeDescription
WordInfo

getDescriptor()

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

newBuilder()

public static WordInfo.Builder newBuilder()
Returns
TypeDescription
WordInfo.Builder

newBuilder(WordInfo prototype)

public static WordInfo.Builder newBuilder(WordInfo prototype)
Parameter
NameDescription
prototypeWordInfo
Returns
TypeDescription
WordInfo.Builder

parseDelimitedFrom(InputStream input)

public static WordInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WordInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static WordInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WordInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WordInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WordInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WordInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WordInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static WordInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WordInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static WordInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WordInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WordInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<WordInfo> parser()
Returns
TypeDescription
Parser<WordInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

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.

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

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.

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 WordInfo.Builder newBuilderForType()
Returns
TypeDescription
WordInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WordInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
WordInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public WordInfo.Builder toBuilder()
Returns
TypeDescription
WordInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException