Reference documentation and code samples for the Cloud Speech V2 Client class RecognitionFeatures.
Available recognition features.
Generated from protobuf message google.cloud.speech.v2.RecognitionFeatures
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ profanity_filter |
bool
If set to |
↳ enable_word_time_offsets |
bool
If |
↳ enable_word_confidence |
bool
If |
↳ enable_automatic_punctuation |
bool
If |
↳ enable_spoken_punctuation |
bool
The spoken punctuation behavior for the call. If |
↳ enable_spoken_emojis |
bool
The spoken emoji behavior for the call. If |
↳ multi_channel_mode |
int
Mode for recognizing multi-channel audio. |
↳ diarization_config |
Google\Cloud\Speech\V2\SpeakerDiarizationConfig
Configuration to enable speaker diarization and set additional parameters to make diarization better suited for your application. When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult. |
↳ max_alternatives |
int
Maximum number of recognition hypotheses to be returned. The server may return fewer than |
getProfanityFilter
If set to true, the server will attempt to filter out profanities,
replacing all but the initial character in each filtered word with
asterisks, for instance, "f***". If set to false or omitted, profanities
won't be filtered out.
Generated from protobuf field bool profanity_filter = 1;
| Returns | |
|---|---|
| Type | Description |
bool | |
setProfanityFilter
If set to true, the server will attempt to filter out profanities,
replacing all but the initial character in each filtered word with
asterisks, for instance, "f***". If set to false or omitted, profanities
won't be filtered out.
Generated from protobuf field bool profanity_filter = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableWordTimeOffsets
If true, the top result includes a list of words and the start and end
time offsets (timestamps) for those words. If false, no word-level time
offset information is returned. The default is false.
Generated from protobuf field bool enable_word_time_offsets = 2;
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableWordTimeOffsets
If true, the top result includes a list of words and the start and end
time offsets (timestamps) for those words. If false, no word-level time
offset information is returned. The default is false.
Generated from protobuf field bool enable_word_time_offsets = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableWordConfidence
If true, the top result includes a list of words and the confidence for
those words. If false, no word-level confidence information is returned.
The default is false.
Generated from protobuf field bool enable_word_confidence = 3;
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableWordConfidence
If true, the top result includes a list of words and the confidence for
those words. If false, no word-level confidence information is returned.
The default is false.
Generated from protobuf field bool enable_word_confidence = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableAutomaticPunctuation
If true, adds punctuation to recognition result hypotheses. This feature
is only available in select languages. The default false value does not
add punctuation to result hypotheses.
Generated from protobuf field bool enable_automatic_punctuation = 4;
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableAutomaticPunctuation
If true, adds punctuation to recognition result hypotheses. This feature
is only available in select languages. The default false value does not
add punctuation to result hypotheses.
Generated from protobuf field bool enable_automatic_punctuation = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableSpokenPunctuation
The spoken punctuation behavior for the call. If true, replaces spoken
punctuation with the corresponding symbols in the request. For example,
"how are you question mark" becomes "how are you?". See
https://cloud.google.com/speech-to-text/docs/spoken-punctuation for
support. If false, spoken punctuation is not replaced.
Generated from protobuf field bool enable_spoken_punctuation = 14;
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableSpokenPunctuation
The spoken punctuation behavior for the call. If true, replaces spoken
punctuation with the corresponding symbols in the request. For example,
"how are you question mark" becomes "how are you?". See
https://cloud.google.com/speech-to-text/docs/spoken-punctuation for
support. If false, spoken punctuation is not replaced.
Generated from protobuf field bool enable_spoken_punctuation = 14;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableSpokenEmojis
The spoken emoji behavior for the call. If true, adds spoken emoji
formatting for the request. This will replace spoken emojis with the
corresponding Unicode symbols in the final transcript. If false, spoken
emojis are not replaced.
Generated from protobuf field bool enable_spoken_emojis = 15;
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableSpokenEmojis
The spoken emoji behavior for the call. If true, adds spoken emoji
formatting for the request. This will replace spoken emojis with the
corresponding Unicode symbols in the final transcript. If false, spoken
emojis are not replaced.
Generated from protobuf field bool enable_spoken_emojis = 15;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMultiChannelMode
Mode for recognizing multi-channel audio.
Generated from protobuf field .google.cloud.speech.v2.RecognitionFeatures.MultiChannelMode multi_channel_mode = 17;
| Returns | |
|---|---|
| Type | Description |
int | |
setMultiChannelMode
Mode for recognizing multi-channel audio.
Generated from protobuf field .google.cloud.speech.v2.RecognitionFeatures.MultiChannelMode multi_channel_mode = 17;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiarizationConfig
Configuration to enable speaker diarization and set additional parameters to make diarization better suited for your application.
When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult.
Generated from protobuf field .google.cloud.speech.v2.SpeakerDiarizationConfig diarization_config = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Speech\V2\SpeakerDiarizationConfig|null | |
hasDiarizationConfig
clearDiarizationConfig
setDiarizationConfig
Configuration to enable speaker diarization and set additional parameters to make diarization better suited for your application.
When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult.
Generated from protobuf field .google.cloud.speech.v2.SpeakerDiarizationConfig diarization_config = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Speech\V2\SpeakerDiarizationConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxAlternatives
Maximum number of recognition hypotheses to be returned.
The server may return fewer than max_alternatives.
Valid values are 0-30. A value of 0 or 1 will return a maximum of
one. If omitted, will return a maximum of one.
Generated from protobuf field int32 max_alternatives = 16;
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxAlternatives
Maximum number of recognition hypotheses to be returned.
The server may return fewer than max_alternatives.
Valid values are 0-30. A value of 0 or 1 will return a maximum of
one. If omitted, will return a maximum of one.
Generated from protobuf field int32 max_alternatives = 16;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |