Class: Freeclimb::GetSpeech

Inherits:
PerclCommand show all
Defined in:
lib/freeclimb/models/get_speech.rb

Overview

The ‘GetSpeech` command enables the Caller to respond to the application using a supported language. Unlike DTMF entry, which implicitly restricts the user to using the available buttons on the phone key pad, speech input allows for flexible audio inputs based on grammar. FreeClimb supports grammars written using GRXML compatible with the Microsoft Speech Platform. `GetSpeech` is only supported on a single call leg. It is not supported when there are two or more call legs connected (as in within a Conference).

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PerclCommand

#command

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PerclCommand

openapi_discriminator_name, #to_percl_hash

Constructor Details

#initialize(attributes = {}) ⇒ GetSpeech

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/freeclimb/models/get_speech.rb', line 136

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::GetSpeech` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if !self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::GetSpeech`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super

  if attributes.key?(:action_url)
    self.action_url = attributes[:action_url]
  end

  if attributes.key?(:grammar_type)
    self.grammar_type = attributes[:grammar_type]
  end

  if attributes.key?(:grammar_file)
    self.grammar_file = attributes[:grammar_file]
  end

  if attributes.key?(:grammar_rule)
    self.grammar_rule = attributes[:grammar_rule]
  end

  if attributes.key?(:play_beep)
    self.play_beep = attributes[:play_beep]
  end

  if attributes.key?(:prompts)
    if (value = attributes[:prompts]).is_a?(Array)
      self.prompts = value
    end
  end

  if attributes.key?(:no_input_timeout_ms)
    self.no_input_timeout_ms = attributes[:no_input_timeout_ms]
  end

  if attributes.key?(:recognition_timeout_ms)
    self.recognition_timeout_ms = attributes[:recognition_timeout_ms]
  end

  if attributes.key?(:confidence_threshold)
    self.confidence_threshold = attributes[:confidence_threshold]
  end

  if attributes.key?(:sensitivity_level)
    self.sensitivity_level = attributes[:sensitivity_level]
  end

  if attributes.key?(:speech_complete_timeout_ms)
    self.speech_complete_timeout_ms = attributes[:speech_complete_timeout_ms]
  end

  if attributes.key?(:speech_incomplete_timeout_ms)
    self.speech_incomplete_timeout_ms = attributes[:speech_incomplete_timeout_ms]
  end

  if attributes.key?(:privacy_mode)
    self.privacy_mode = attributes[:privacy_mode]
  end
  self.command = "GetSpeech"
end

Instance Attribute Details

#action_url ⇒ Object

When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call.



18
19
20
 
# File 'lib/freeclimb/models/get_speech.rb', line 18

def action_url
  @action_url
end

#confidence_threshold ⇒ Object

When a recognition resource recognizes a spoken phrase, it associates a confidence level with that match. Parameter ‘confidenceThreshold` specifies what confidence level is considered a successful match. Values are between 0.0 and 1.0.



41
42
43
 
# File 'lib/freeclimb/models/get_speech.rb', line 41

def confidence_threshold
  @confidence_threshold
end

#grammar_file ⇒ Object

The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL.



23
24
25
 
# File 'lib/freeclimb/models/get_speech.rb', line 23

def grammar_file
  @grammar_file
end

#grammar_rule ⇒ Object

The grammar rule within the specified grammar file to use for speech recognition. This attribute is optional if ‘grammarType` is `URL` and ignored if `grammarType` is `BUILTIN`.



26
27
28
 
# File 'lib/freeclimb/models/get_speech.rb', line 26

def grammar_rule
  @grammar_rule
end

#grammar_type ⇒ Object

Returns the value of attribute grammar_type.



20
21
22
 
# File 'lib/freeclimb/models/get_speech.rb', line 20

def grammar_type
  @grammar_type
end

#no_input_timeout_ms ⇒ Object

When recognition is started and there is no speech detected for ‘noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation.



35
36
37
 
# File 'lib/freeclimb/models/get_speech.rb', line 35

def no_input_timeout_ms
  @no_input_timeout_ms
end

#play_beep ⇒ Object

Indicates whether a beep should be played just before speech recognition is initiated so that the speaker can start to speak.



29
30
31
 
# File 'lib/freeclimb/models/get_speech.rb', line 29

def play_beep
  @play_beep
end

#privacy_mode ⇒ Object

Parameter privacyMode will not log the ‘text` as required by PCI compliance.



53
54
55
 
# File 'lib/freeclimb/models/get_speech.rb', line 53

def privacy_mode
  @privacy_mode
end

#prompts ⇒ Object

The JSON array of PerCL commands to nest within the ‘GetSpeech` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the caller. This allows for playing menu options to the caller and to prompt for the expected input. These commands stop executing when the caller begins to input speech.



32
33
34
 
# File 'lib/freeclimb/models/get_speech.rb', line 32

def prompts
  @prompts
end

#recognition_timeout_ms ⇒ Object

When playback of prompts ends and there is no match for ‘recognitionTimeoutMs` milliseconds, the recognizer will terminate the recognition operation.



38
39
40
 
# File 'lib/freeclimb/models/get_speech.rb', line 38

def recognition_timeout_ms
  @recognition_timeout_ms
end

#sensitivity_level ⇒ Object

The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0



44
45
46
 
# File 'lib/freeclimb/models/get_speech.rb', line 44

def sensitivity_level
  @sensitivity_level
end

#speech_complete_timeout_ms ⇒ Object

Parameter ‘speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds.



47
48
49
 
# File 'lib/freeclimb/models/get_speech.rb', line 47

def speech_complete_timeout_ms
  @speech_complete_timeout_ms
end

#speech_incomplete_timeout_ms ⇒ Object

Parameter ‘speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance.



50
51
52
 
# File 'lib/freeclimb/models/get_speech.rb', line 50

def speech_incomplete_timeout_ms
  @speech_incomplete_timeout_ms
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



97
98
99
 
# File 'lib/freeclimb/models/get_speech.rb', line 97

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/freeclimb/models/get_speech.rb', line 78

def self.attribute_map
  {
    action_url: :actionUrl,
    grammar_type: :grammarType,
    grammar_file: :grammarFile,
    grammar_rule: :grammarRule,
    play_beep: :playBeep,
    prompts: :prompts,
    no_input_timeout_ms: :noInputTimeoutMs,
    recognition_timeout_ms: :recognitionTimeoutMs,
    confidence_threshold: :confidenceThreshold,
    sensitivity_level: :sensitivityLevel,
    speech_complete_timeout_ms: :speechCompleteTimeoutMs,
    speech_incomplete_timeout_ms: :speechIncompleteTimeoutMs,
    privacy_mode: :privacyMode
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



268
269
270
 
# File 'lib/freeclimb/models/get_speech.rb', line 268

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



128
129
130
131
132
 
# File 'lib/freeclimb/models/get_speech.rb', line 128

def self.openapi_all_of
  [
    :PerclCommand
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
125
 
# File 'lib/freeclimb/models/get_speech.rb', line 121

def self.openapi_nullable
  Set.new([
    :grammar_type
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/freeclimb/models/get_speech.rb', line 102

def self.openapi_types
  {
    action_url: :String,
    grammar_type: :GrammarType,
    grammar_file: :String,
    grammar_rule: :String,
    play_beep: :Boolean,
    prompts: :"Array<PerclCommand>",
    no_input_timeout_ms: :Integer,
    recognition_timeout_ms: :Integer,
    confidence_threshold: :Float,
    sensitivity_level: :Float,
    speech_complete_timeout_ms: :Integer,
    speech_incomplete_timeout_ms: :Integer,
    privacy_mode: :Boolean
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/freeclimb/models/get_speech.rb', line 235

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    action_url == other.action_url &&
    grammar_type == other.grammar_type &&
    grammar_file == other.grammar_file &&
    grammar_rule == other.grammar_rule &&
    play_beep == other.play_beep &&
    prompts == other.prompts &&
    no_input_timeout_ms == other.no_input_timeout_ms &&
    recognition_timeout_ms == other.recognition_timeout_ms &&
    confidence_threshold == other.confidence_threshold &&
    sensitivity_level == other.sensitivity_level &&
    speech_complete_timeout_ms == other.speech_complete_timeout_ms &&
    speech_incomplete_timeout_ms == other.speech_incomplete_timeout_ms &&
    privacy_mode == other.privacy_mode && super
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/freeclimb/models/get_speech.rb', line 299

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Freeclimb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/freeclimb/models/get_speech.rb', line 370

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/freeclimb/models/get_speech.rb', line 275

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send(:"#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


255
256
257
 
# File 'lib/freeclimb/models/get_speech.rb', line 255

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/freeclimb/models/get_speech.rb', line 261

def hash
  [action_url, grammar_type, grammar_file, grammar_rule, play_beep, prompts, no_input_timeout_ms, recognition_timeout_ms, confidence_threshold, sensitivity_level, speech_complete_timeout_ms, speech_incomplete_timeout_ms, privacy_mode].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/freeclimb/models/get_speech.rb', line 210

def list_invalid_properties
  invalid_properties = super
  if @action_url.nil?
    invalid_properties.push('invalid value for "action_url", action_url cannot be nil.')
  end

  if @grammar_file.nil?
    invalid_properties.push('invalid value for "grammar_file", grammar_file cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



346
347
348
 
# File 'lib/freeclimb/models/get_speech.rb', line 346

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/freeclimb/models/get_speech.rb', line 352

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



340
341
342
 
# File 'lib/freeclimb/models/get_speech.rb', line 340

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



225
226
227
228
229
230
231
 
# File 'lib/freeclimb/models/get_speech.rb', line 225

def valid?
  if @action_url.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end