Class: Google::Apis::SpeechV1beta1::RecognitionConfig

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



265
266
267
 
# File 'generated/google/apis/speech_v1beta1/classes.rb', line 265

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

Instance Attribute Details

#encoding ⇒ String

Required Encoding of audio data sent in all RecognitionAudio messages. Corresponds to the JSON property encoding

Returns:

  • (String) 


220
221
222
 
# File 'generated/google/apis/speech_v1beta1/classes.rb', line 220

def encoding
  @encoding
end

#language_code ⇒ String

Optional The language of the supplied audio as a BCP-47 language tag. Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt If omitted, defaults to "en-US". See Language Support for a list of the currently supported language codes. Corresponds to the JSON property languageCode

Returns:

  • (String) 


229
230
231
 
# File 'generated/google/apis/speech_v1beta1/classes.rb', line 229

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) 


239
240
241
 
# File 'generated/google/apis/speech_v1beta1/classes.rb', line 239

def max_alternatives
  @max_alternatives
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) 


247
248
249
 
# File 'generated/google/apis/speech_v1beta1/classes.rb', line 247

def profanity_filter
  @profanity_filter
end

#sample_rate ⇒ Fixnum

Required 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). Corresponds to the JSON property sampleRate

Returns:

  • (Fixnum) 


257
258
259
 
# File 'generated/google/apis/speech_v1beta1/classes.rb', line 257

def sample_rate
  @sample_rate
end

#speech_context ⇒ Google::Apis::SpeechV1beta1::SpeechContext

Provides "hints" to the speech recognizer to favor specific words and phrases in the results. Corresponds to the JSON property speechContext

Returns:



263
264
265
 
# File 'generated/google/apis/speech_v1beta1/classes.rb', line 263

def speech_context
  @speech_context
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



270
271
272
273
274
275
276
277
 
# File 'generated/google/apis/speech_v1beta1/classes.rb', line 270

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