Reference documentation and code samples for the Cloud Speech-to-Text V2 API class Google::Cloud::Speech::V2::RecognitionFeatures.
Available recognition features.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#custom_prompt_config
def custom_prompt_config() -> ::Google::Cloud::Speech::V2::CustomPromptConfig
Returns
- (::Google::Cloud::Speech::V2::CustomPromptConfig) — Optional. Configuration to enable custom prompt for chirp3.
#custom_prompt_config=
def custom_prompt_config=(value) -> ::Google::Cloud::Speech::V2::CustomPromptConfig
Parameter
- value (::Google::Cloud::Speech::V2::CustomPromptConfig) — Optional. Configuration to enable custom prompt for chirp3.
Returns
- (::Google::Cloud::Speech::V2::CustomPromptConfig) — Optional. Configuration to enable custom prompt for chirp3.
#diarization_config
def diarization_config() -> ::Google::Cloud::Speech::V2::SpeakerDiarizationConfig
Returns
- (::Google::Cloud::Speech::V2::SpeakerDiarizationConfig) — Configuration to enable speaker diarization. To enable diarization, set this field to an empty SpeakerDiarizationConfig message.
#diarization_config=
def diarization_config=(value) -> ::Google::Cloud::Speech::V2::SpeakerDiarizationConfig
Parameter
- value (::Google::Cloud::Speech::V2::SpeakerDiarizationConfig) — Configuration to enable speaker diarization. To enable diarization, set this field to an empty SpeakerDiarizationConfig message.
Returns
- (::Google::Cloud::Speech::V2::SpeakerDiarizationConfig) — Configuration to enable speaker diarization. To enable diarization, set this field to an empty SpeakerDiarizationConfig message.
#enable_automatic_punctuation
def enable_automatic_punctuation() -> ::Boolean
Returns
-
(::Boolean) — If
true, adds punctuation to recognition result hypotheses. This feature is only available in select languages. The defaultfalsevalue does not add punctuation to result hypotheses.
#enable_automatic_punctuation=
def enable_automatic_punctuation=(value) -> ::Boolean
Parameter
-
value (::Boolean) — If
true, adds punctuation to recognition result hypotheses. This feature is only available in select languages. The defaultfalsevalue does not add punctuation to result hypotheses.
Returns
-
(::Boolean) — If
true, adds punctuation to recognition result hypotheses. This feature is only available in select languages. The defaultfalsevalue does not add punctuation to result hypotheses.
#enable_spoken_emojis
def enable_spoken_emojis() -> ::Boolean
Returns
-
(::Boolean) — 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. Iffalse, spoken emojis are not replaced.
#enable_spoken_emojis=
def enable_spoken_emojis=(value) -> ::Boolean
Parameter
-
value (::Boolean) — 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. Iffalse, spoken emojis are not replaced.
Returns
-
(::Boolean) — 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. Iffalse, spoken emojis are not replaced.
#enable_spoken_punctuation
def enable_spoken_punctuation() -> ::Boolean
Returns
-
(::Boolean) — 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. Iffalse, spoken punctuation is not replaced.
#enable_spoken_punctuation=
def enable_spoken_punctuation=(value) -> ::Boolean
Parameter
-
value (::Boolean) — 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. Iffalse, spoken punctuation is not replaced.
Returns
-
(::Boolean) — 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. Iffalse, spoken punctuation is not replaced.
#enable_word_confidence
def enable_word_confidence() -> ::Boolean
Returns
-
(::Boolean) — If
true, the top result includes a list of words and the confidence for those words. Iffalse, no word-level confidence information is returned. The default isfalse.
#enable_word_confidence=
def enable_word_confidence=(value) -> ::Boolean
Parameter
-
value (::Boolean) — If
true, the top result includes a list of words and the confidence for those words. Iffalse, no word-level confidence information is returned. The default isfalse.
Returns
-
(::Boolean) — If
true, the top result includes a list of words and the confidence for those words. Iffalse, no word-level confidence information is returned. The default isfalse.
#enable_word_time_offsets
def enable_word_time_offsets() -> ::Boolean
Returns
-
(::Boolean) — If
true, the top result includes a list of words and the start and end time offsets (timestamps) for those words. Iffalse, no word-level time offset information is returned. The default isfalse.
#enable_word_time_offsets=
def enable_word_time_offsets=(value) -> ::Boolean
Parameter
-
value (::Boolean) — If
true, the top result includes a list of words and the start and end time offsets (timestamps) for those words. Iffalse, no word-level time offset information is returned. The default isfalse.
Returns
-
(::Boolean) — If
true, the top result includes a list of words and the start and end time offsets (timestamps) for those words. Iffalse, no word-level time offset information is returned. The default isfalse.
#max_alternatives
def max_alternatives() -> ::Integer
Returns
-
(::Integer) — Maximum number of recognition hypotheses to be returned.
The server may return fewer than
max_alternatives. Valid values are0-30. A value of0or1will return a maximum of one. If omitted, will return a maximum of one.
#max_alternatives=
def max_alternatives=(value) -> ::Integer
Parameter
-
value (::Integer) — Maximum number of recognition hypotheses to be returned.
The server may return fewer than
max_alternatives. Valid values are0-30. A value of0or1will return a maximum of one. If omitted, will return a maximum of one.
Returns
-
(::Integer) — Maximum number of recognition hypotheses to be returned.
The server may return fewer than
max_alternatives. Valid values are0-30. A value of0or1will return a maximum of one. If omitted, will return a maximum of one.
#multi_channel_mode
def multi_channel_mode() -> ::Google::Cloud::Speech::V2::RecognitionFeatures::MultiChannelMode
Returns
- (::Google::Cloud::Speech::V2::RecognitionFeatures::MultiChannelMode) — Mode for recognizing multi-channel audio.
#multi_channel_mode=
def multi_channel_mode=(value) -> ::Google::Cloud::Speech::V2::RecognitionFeatures::MultiChannelMode
Parameter
- value (::Google::Cloud::Speech::V2::RecognitionFeatures::MultiChannelMode) — Mode for recognizing multi-channel audio.
Returns
- (::Google::Cloud::Speech::V2::RecognitionFeatures::MultiChannelMode) — Mode for recognizing multi-channel audio.
#profanity_filter
def profanity_filter() -> ::Boolean
Returns
-
(::Boolean) — 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 tofalseor omitted, profanities won't be filtered out.
#profanity_filter=
def profanity_filter=(value) -> ::Boolean
Parameter
-
value (::Boolean) — 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 tofalseor omitted, profanities won't be filtered out.
Returns
-
(::Boolean) — 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 tofalseor omitted, profanities won't be filtered out.