Reference documentation and code samples for the Cloud Speech V2 Client class WordInfo.
Word-specific information for recognized words.
Generated from protobuf message google.cloud.speech.v2.WordInfo
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_offset |
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 enable_word_time_offsets is |
↳ end_offset |
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 enable_word_time_offsets is |
↳ word |
string
The word corresponding to this set of information. |
↳ confidence |
float
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 is set to |
↳ speaker_label |
string
A distinct label is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. |
getStartOffset
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
is true and only in the top hypothesis. This is an experimental feature
and the accuracy of the time offset can vary.
Generated from protobuf field .google.protobuf.Duration start_offset = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasStartOffset
clearStartOffset
setStartOffset
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
is true and only in the top hypothesis. This is an experimental feature
and the accuracy of the time offset can vary.
Generated from protobuf field .google.protobuf.Duration start_offset = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndOffset
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
is true and only in the top hypothesis. This is an experimental feature
and the accuracy of the time offset can vary.
Generated from protobuf field .google.protobuf.Duration end_offset = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasEndOffset
clearEndOffset
setEndOffset
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
is true and only in the top hypothesis. This is an experimental feature
and the accuracy of the time offset can vary.
Generated from protobuf field .google.protobuf.Duration end_offset = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWord
The word corresponding to this set of information.
Generated from protobuf field string word = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setWord
The word corresponding to this set of information.
Generated from protobuf field string word = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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 is
set to 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.
Generated from protobuf field float confidence = 4;
| Returns | |
|---|---|
| Type | Description |
float | |
setConfidence
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 is
set to 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.
Generated from protobuf field float confidence = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpeakerLabel
A distinct label is assigned for every speaker within the audio. This field
specifies which one of those speakers was detected to have spoken this
word. speaker_label is set if
enable_speaker_diarization
is true and only in the top alternative.
Generated from protobuf field string speaker_label = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setSpeakerLabel
A distinct label is assigned for every speaker within the audio. This field
specifies which one of those speakers was detected to have spoken this
word. speaker_label is set if
enable_speaker_diarization
is true and only in the top alternative.
Generated from protobuf field string speaker_label = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |