Cloud Speech V2 Client - Class RecognitionFeatures (2.3.0)

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

Namespace

Google \ Cloud \ Speech \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ profanity_filter bool

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.
↳ enable_word_time_offsets bool

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.
↳ enable_word_confidence bool

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.
↳ enable_automatic_punctuation bool

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.
↳ enable_spoken_punctuation bool

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.
↳ enable_spoken_emojis bool

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.
↳ multi_channel_mode int

Mode for recognizing multi-channel audio.
↳ diarization_config SpeakerDiarizationConfig

Configuration to enable speaker diarization. To enable diarization, set this field to an empty SpeakerDiarizationConfig message.
↳ max_alternatives int

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.
↳ custom_prompt_config CustomPromptConfig

Optional. Configuration to enable custom prompt for chirp3.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getMultiChannelMode

Mode for recognizing multi-channel audio.

Returns
Type Description
int Enum of type MultiChannelMode.

setMultiChannelMode

Mode for recognizing multi-channel audio.

Parameter
Name Description
var int

Enum of type MultiChannelMode.

Returns
Type Description
$this

getDiarizationConfig

Configuration to enable speaker diarization. To enable diarization, set this field to an empty SpeakerDiarizationConfig message.

Returns
Type Description
SpeakerDiarizationConfig|null

hasDiarizationConfig

clearDiarizationConfig

setDiarizationConfig

Configuration to enable speaker diarization. To enable diarization, set this field to an empty SpeakerDiarizationConfig message.

Parameter
Name Description
var 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.

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getCustomPromptConfig

Optional. Configuration to enable custom prompt for chirp3.

Returns
Type Description
CustomPromptConfig|null

hasCustomPromptConfig

clearCustomPromptConfig

setCustomPromptConfig

Optional. Configuration to enable custom prompt for chirp3.

Parameter
Name Description
var CustomPromptConfig
Returns
Type Description
$this