Class: Google::Apis::SpeechV1::RecognitionConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/speech_v1/classes.rb,
generated/google/apis/speech_v1/representations.rb,
generated/google/apis/speech_v1/representations.rb

Overview

Provides information to the recognizer that specifies how to process the request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RecognitionConfig

Returns a new instance of RecognitionConfig



416
417
418
 
# File 'generated/google/apis/speech_v1/classes.rb', line 416

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#enable_automatic_punctuation ⇒ Boolean Also known as: enable_automatic_punctuation?

Optional 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. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. Corresponds to the JSON property enableAutomaticPunctuation

Returns:

  • (Boolean) 


286
287
288
 
# File 'generated/google/apis/speech_v1/classes.rb', line 286

def enable_automatic_punctuation
  @enable_automatic_punctuation
end

#enable_separate_recognition_per_channel ⇒ Boolean Also known as: enable_separate_recognition_per_channel?

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

Returns:

  • (Boolean) 


297
298
299
 
# File 'generated/google/apis/speech_v1/classes.rb', line 297

def enable_separate_recognition_per_channel
  @enable_separate_recognition_per_channel
end

#enable_word_time_offsets ⇒ Boolean Also known as: enable_word_time_offsets?

Optional 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

Returns:

  • (Boolean) 


306
307
308
 
# File 'generated/google/apis/speech_v1/classes.rb', line 306

def enable_word_time_offsets
  @enable_word_time_offsets
end

#encoding ⇒ String

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

Returns:

  • (String) 


314
315
316
 
# File 'generated/google/apis/speech_v1/classes.rb', line 314

def encoding
  @encoding
end

#language_code ⇒ String

Required The language of the supplied audio as a BCP-47 language tag. Example: "en-US". See Language Support for a list of the currently supported language codes. Corresponds to the JSON property languageCode

Returns:

  • (String) 


323
324
325
 
# File 'generated/google/apis/speech_v1/classes.rb', line 323

def language_code
  @language_code
end

#max_alternatives ⇒ Fixnum

Optional 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

Returns:

  • (Fixnum) 


333
334
335
 
# File 'generated/google/apis/speech_v1/classes.rb', line 333

def max_alternatives
  @max_alternatives
end

#model ⇒ String

Optional 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 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

Returns:

  • (String) 


369
370
371
 
# File 'generated/google/apis/speech_v1/classes.rb', line 369

def model
  @model
end

#profanity_filter ⇒ Boolean Also known as: profanity_filter?

Optional 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

Returns:

  • (Boolean) 


377
378
379
 
# File 'generated/google/apis/speech_v1/classes.rb', line 377

def profanity_filter
  @profanity_filter
end

#sample_rate_hertz ⇒ Fixnum

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 and required for all other audio formats. For details, see AudioEncoding. Corresponds to the JSON property sampleRateHertz

Returns:

  • (Fixnum) 


389
390
391
 
# File 'generated/google/apis/speech_v1/classes.rb', line 389

def sample_rate_hertz
  @sample_rate_hertz
end

#speech_contexts ⇒ Array<Google::Apis::SpeechV1::SpeechContext>

Optional array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see Phrase Hints. Corresponds to the JSON property speechContexts

Returns:



396
397
398
 
# File 'generated/google/apis/speech_v1/classes.rb', line 396

def speech_contexts
  @speech_contexts
end

#use_enhanced ⇒ Boolean Also known as: use_enhanced?

Optional 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:

  1. project is eligible for requesting enhanced models
  2. 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. Enhanced speech models require that you opt-in to data logging using instructions in the documentation. If you set use_enhanced to true and you have not enabled audio logging, then you will receive an error. Corresponds to the JSON property useEnhanced

Returns:

  • (Boolean) 


413
414
415
 
# File 'generated/google/apis/speech_v1/classes.rb', line 413

def use_enhanced
  @use_enhanced
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'generated/google/apis/speech_v1/classes.rb', line 421

def update!(**args)
  @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_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)
  @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)
  @use_enhanced = args[:use_enhanced] if args.key?(:use_enhanced)
end