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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/speech_v1/classes.rb,
lib/google/apis/speech_v1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ RecognitionConfig

Returns a new instance of RecognitionConfig.



382
383
384
 
# File 'lib/google/apis/speech_v1/classes.rb', line 382

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

Instance Attribute Details

#audio_channel_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


268
269
270
 
# File 'lib/google/apis/speech_v1/classes.rb', line 268

def audio_channel_count
  @audio_channel_count
end

#diarization_config ⇒ Google::Apis::SpeechV1::SpeakerDiarizationConfig

Config to enable speaker diarization. Corresponds to the JSON property diarizationConfig

Returns:



273
274
275
 
# File 'lib/google/apis/speech_v1/classes.rb', line 273

def diarization_config
  @diarization_config
end

#enable_automatic_punctuation ⇒ Boolean Also known as: enable_automatic_punctuation?

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

Returns:

  • (Boolean) 


281
282
283
 
# File 'lib/google/apis/speech_v1/classes.rb', line 281

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) 


292
293
294
 
# File 'lib/google/apis/speech_v1/classes.rb', line 292

def enable_separate_recognition_per_channel
  @enable_separate_recognition_per_channel
end

#enable_word_time_offsets ⇒ Boolean Also known as: enable_word_time_offsets?

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) 


300
301
302
 
# File 'lib/google/apis/speech_v1/classes.rb', line 300

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) 


308
309
310
 
# File 'lib/google/apis/speech_v1/classes.rb', line 308

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) 


316
317
318
 
# File 'lib/google/apis/speech_v1/classes.rb', line 316

def language_code
  @language_code
end

#max_alternatives ⇒ Fixnum

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) 


325
326
327
 
# File 'lib/google/apis/speech_v1/classes.rb', line 325

def max_alternatives
  @max_alternatives
end

#metadata ⇒ Google::Apis::SpeechV1::RecognitionMetadata

Description of audio data to be recognized. Corresponds to the JSON property metadata

Returns:



330
331
332
 
# File 'lib/google/apis/speech_v1/classes.rb', line 330

def metadata
  @metadata
end

#model ⇒ String

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

Returns:

  • (String) 


345
346
347
 
# File 'lib/google/apis/speech_v1/classes.rb', line 345

def model
  @model
end

#profanity_filter ⇒ Boolean Also known as: profanity_filter?

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) 


352
353
354
 
# File 'lib/google/apis/speech_v1/classes.rb', line 352

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

Returns:

  • (Fixnum) 


363
364
365
 
# File 'lib/google/apis/speech_v1/classes.rb', line 363

def sample_rate_hertz
  @sample_rate_hertz
end

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

Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see speech adaptation. Corresponds to the JSON property speechContexts

Returns:



370
371
372
 
# File 'lib/google/apis/speech_v1/classes.rb', line 370

def speech_contexts
  @speech_contexts
end

#use_enhanced ⇒ Boolean Also known as: use_enhanced?

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

Returns:

  • (Boolean) 


379
380
381
 
# File 'lib/google/apis/speech_v1/classes.rb', line 379

def use_enhanced
  @use_enhanced
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/speech_v1/classes.rb', line 387

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