class Google::Apis::SpeechV1p1beta1::RecognitionConfig
Provides information to the recognizer that specifies how to process the request.
Attributes
Speech adaptation configuration. Corresponds to the JSON property `adaptation` @return [Google::Apis::SpeechV1p1beta1::SpeechAdaptation]
A list of up to 3 additional [BCP-47](www.rfc-editor.org/rfc/bcp/bcp47. txt) language tags, listing possible alternative languages of the supplied audio. See [Language Support](cloud.google.com/speech-to-text/docs/ languages) for a list of the currently supported language codes. If alternative languages are listed, recognition result will contain recognition in the most likely language detected including the main language_code. The recognition result will include the language tag of the language detected in the audio. Note: This feature is only supported for Voice Command and Voice Search use cases and performance may vary for other use cases (e.g., phone call transcription). Corresponds to the JSON property `alternativeLanguageCodes` @return [Array<String>]
The number of channels in the input audio data. ONLY set this for MULTI- CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set ` enable_separate_recognition_per_channel
` to 'true'. Corresponds to the JSON property `audioChannelCount` @return [Fixnum]
Config to enable speaker diarization. Corresponds to the JSON property `diarizationConfig` @return [Google::Apis::SpeechV1p1beta1::SpeakerDiarizationConfig]
If set, specifies the estimated number of speakers in the conversation. Defaults to '2'. Ignored unless enable_speaker_diarization
is set to true. Note: Use diarization_config
instead. Corresponds to the JSON property `diarizationSpeakerCount` @return [Fixnum]
If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Corresponds to the JSON property `enableAutomaticPunctuation` @return [Boolean]
If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Corresponds to the JSON property `enableAutomaticPunctuation` @return [Boolean]
This needs to be set to `true` explicitly and `audio_channel_count` > 1 to get each channel recognized separately. The recognition result will contain a ` channel_tag` field to state which channel that result belongs to. If this is not true, we will only recognize the first channel. The request is billed cumulatively for all channels recognized: `audio_channel_count` multiplied by the length of the audio. Corresponds to the JSON property `enableSeparateRecognitionPerChannel` @return [Boolean]
This needs to be set to `true` explicitly and `audio_channel_count` > 1 to get each channel recognized separately. The recognition result will contain a ` channel_tag` field to state which channel that result belongs to. If this is not true, we will only recognize the first channel. The request is billed cumulatively for all channels recognized: `audio_channel_count` multiplied by the length of the audio. Corresponds to the JSON property `enableSeparateRecognitionPerChannel` @return [Boolean]
If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo
. Note: Use diarization_config
instead. Corresponds to the JSON property `enableSpeakerDiarization` @return [Boolean]
If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo
. Note: Use diarization_config
instead. Corresponds to the JSON property `enableSpeakerDiarization` @return [Boolean]
The spoken emoji behavior for the call If not set, uses default behavior based on model of choice 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. Corresponds to the JSON property `enableSpokenEmojis` @return [Boolean]
The spoken emoji behavior for the call If not set, uses default behavior based on model of choice 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. Corresponds to the JSON property `enableSpokenEmojis` @return [Boolean]
The spoken punctuation behavior for the call If not set, uses default behavior based on model of choice e.g. command_and_search will enable spoken punctuation by default If 'true', replaces spoken punctuation with the corresponding symbols in the request. For example, “how are you question mark” becomes “how are you?”. See cloud.google.com/speech-to-text/docs/ spoken-punctuation for support. If 'false', spoken punctuation is not replaced. Corresponds to the JSON property `enableSpokenPunctuation` @return [Boolean]
The spoken punctuation behavior for the call If not set, uses default behavior based on model of choice e.g. command_and_search will enable spoken punctuation by default If 'true', replaces spoken punctuation with the corresponding symbols in the request. For example, “how are you question mark” becomes “how are you?”. See cloud.google.com/speech-to-text/docs/ spoken-punctuation for support. If 'false', spoken punctuation is not replaced. Corresponds to the JSON property `enableSpokenPunctuation` @return [Boolean]
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`. Corresponds to the JSON property `enableWordConfidence` @return [Boolean]
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`. Corresponds to the JSON property `enableWordConfidence` @return [Boolean]
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`. Corresponds to the JSON property `enableWordTimeOffsets` @return [Boolean]
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`. Corresponds to the JSON property `enableWordTimeOffsets` @return [Boolean]
Encoding of audio data sent in all `RecognitionAudio` messages. This field is optional for `FLAC` and `WAV` audio files and required for all other audio formats. For details, see AudioEncoding. Corresponds to the JSON property `encoding` @return [String]
Required. The language of the supplied audio as a [BCP-47](www.rfc- editor.org/rfc/bcp/bcp47.txt) language tag. Example: “en-US”. See [Language Support](cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. Corresponds to the JSON property `languageCode` @return [String]
Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each ` SpeechRecognitionResult`. 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. Corresponds to the JSON property `maxAlternatives` @return [Fixnum]
Description of audio data to be recognized. Corresponds to the JSON property `metadata` @return [Google::Apis::SpeechV1p1beta1::RecognitionMetadata]
Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig
. * Model* Description command_and_search Best for short queries such as voice commands or voice search. phone_call Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate). video Best for audio that originated from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate. default Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate. Corresponds to the JSON property `model` @return [String]
If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. “f***” . If set to `false` or omitted, profanities won't be filtered out. Corresponds to the JSON property `profanityFilter` @return [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, e.g. “f***” . If set to `false` or omitted, profanities won't be filtered out. Corresponds to the JSON property `profanityFilter` @return [Boolean]
Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. Corresponds to the JSON property `sampleRateHertz` @return [Fixnum]
Array of SpeechContext
. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](cloud. google.com/speech-to-text/docs/adaptation). Corresponds to the JSON property `speechContexts` @return [Array<Google::Apis::SpeechV1p1beta1::SpeechContext>]
Transcription normalization configuration. Use transcription normalization to automatically replace parts of the transcript with phrases of your choosing. For StreamingRecognize, this normalization only applies to stable partial transcripts (stability > 0.8) and final transcripts. Corresponds to the JSON property `transcriptNormalization` @return [Google::Apis::SpeechV1p1beta1::TranscriptNormalization]
Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. Corresponds to the JSON property `useEnhanced` @return [Boolean]
Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. Corresponds to the JSON property `useEnhanced` @return [Boolean]
Public Class Methods
# File lib/google/apis/speech_v1p1beta1/classes.rb, line 775 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/speech_v1p1beta1/classes.rb, line 780 def update!(**args) @adaptation = args[:adaptation] if args.key?(:adaptation) @alternative_language_codes = args[:alternative_language_codes] if args.key?(:alternative_language_codes) @audio_channel_count = args[:audio_channel_count] if args.key?(:audio_channel_count) @diarization_config = args[:diarization_config] if args.key?(:diarization_config) @diarization_speaker_count = args[:diarization_speaker_count] if args.key?(:diarization_speaker_count) @enable_automatic_punctuation = args[:enable_automatic_punctuation] if args.key?(:enable_automatic_punctuation) @enable_separate_recognition_per_channel = args[:enable_separate_recognition_per_channel] if args.key?(:enable_separate_recognition_per_channel) @enable_speaker_diarization = args[:enable_speaker_diarization] if args.key?(:enable_speaker_diarization) @enable_spoken_emojis = args[:enable_spoken_emojis] if args.key?(:enable_spoken_emojis) @enable_spoken_punctuation = args[:enable_spoken_punctuation] if args.key?(:enable_spoken_punctuation) @enable_word_confidence = args[:enable_word_confidence] if args.key?(:enable_word_confidence) @enable_word_time_offsets = args[:enable_word_time_offsets] if args.key?(:enable_word_time_offsets) @encoding = args[:encoding] if args.key?(:encoding) @language_code = args[:language_code] if args.key?(:language_code) @max_alternatives = args[:max_alternatives] if args.key?(:max_alternatives) @metadata = args[:metadata] if args.key?(:metadata) @model = args[:model] if args.key?(:model) @profanity_filter = args[:profanity_filter] if args.key?(:profanity_filter) @sample_rate_hertz = args[:sample_rate_hertz] if args.key?(:sample_rate_hertz) @speech_contexts = args[:speech_contexts] if args.key?(:speech_contexts) @transcript_normalization = args[:transcript_normalization] if args.key?(:transcript_normalization) @use_enhanced = args[:use_enhanced] if args.key?(:use_enhanced) end