Reference documentation and code samples for the Cloud Video Intelligence V1 Client class WordInfo.
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.
Generated from protobuf message google.cloud.videointelligence.v1.WordInfo
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_time |
Google\Protobuf\Duration
Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if |
↳ end_time |
Google\Protobuf\Duration
Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if |
↳ word |
string
The word corresponding to this set of information. |
↳ confidence |
float
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 |
↳ speaker_tag |
int
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. |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasStartTime
clearStartTime
setStartTime
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasEndTime
clearEndTime
setEndTime
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWord
The word corresponding to this set of information.
| Returns | |
|---|---|
| Type | Description |
string | |
setWord
The word corresponding to this set of information.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
float | |
setConfidence
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.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
int | |
setSpeakerTag
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |