Reference documentation and code samples for the Cloud Speech V1 Client class WordInfo.
Word-specific information for recognized words.
Generated from protobuf message google.cloud.speech.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
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 |
↳ 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' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. |
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.
Generated from protobuf field .google.protobuf.Duration start_time = 1;
| 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.
Generated from protobuf field .google.protobuf.Duration start_time = 1;
| 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.
Generated from protobuf field .google.protobuf.Duration end_time = 2;
| 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.
Generated from protobuf field .google.protobuf.Duration end_time = 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=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=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 | |
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' to diarization_speaker_count.
speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative.
Generated from protobuf field int32 speaker_tag = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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' to diarization_speaker_count.
speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative.
Generated from protobuf field int32 speaker_tag = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |