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



253
254
255
 
# File 'generated/google/apis/speech_v1/classes.rb', line 253

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

Instance Attribute Details

#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) 


199
200
201
 
# File 'generated/google/apis/speech_v1/classes.rb', line 199

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) 


207
208
209
 
# File 'generated/google/apis/speech_v1/classes.rb', line 207

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) 


216
217
218
 
# File 'generated/google/apis/speech_v1/classes.rb', line 216

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) 


226
227
228
 
# File 'generated/google/apis/speech_v1/classes.rb', line 226

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) 


234
235
236
 
# File 'generated/google/apis/speech_v1/classes.rb', line 234

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) 


246
247
248
 
# File 'generated/google/apis/speech_v1/classes.rb', line 246

def sample_rate_hertz
  @sample_rate_hertz
end

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

Optional A means to provide context to assist the speech recognition. Corresponds to the JSON property speechContexts

Returns:



251
252
253
 
# File 'generated/google/apis/speech_v1/classes.rb', line 251

def speech_contexts
  @speech_contexts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



258
259
260
261
262
263
264
265
266
 
# File 'generated/google/apis/speech_v1/classes.rb', line 258

def update!(**args)
  @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)
  @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)
end