Class: PureCloud::Keyword

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/keyword.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Keyword

Initializes the object

Parameters:

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

    Model attributes in the form of hash



124
125
126
127
128
129
130
131
132
133
134
135
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 124

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes.has_key?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

  
  if attributes.has_key?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

  
  if attributes.has_key?(:'phrase')
    
    
    self.phrase = attributes[:'phrase']
    
  
  end

  
  if attributes.has_key?(:'confidence')
    
    
    self.confidence = attributes[:'confidence']
    
  
  end

  
  if attributes.has_key?(:'agentScoreModifier')
    
    
    self.agent_score_modifier = attributes[:'agentScoreModifier']
    
  
  end

  
  if attributes.has_key?(:'customerScoreModifier')
    
    
    self.customer_score_modifier = attributes[:'customerScoreModifier']
    
  
  end

  
  if attributes.has_key?(:'alternateSpellings')
    
    if (value = attributes[:'alternateSpellings']).is_a?(Array)
      self.alternate_spellings = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'pronunciations')
    
    if (value = attributes[:'pronunciations']).is_a?(Array)
      self.pronunciations = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'antiWords')
    
    if (value = attributes[:'antiWords']).is_a?(Array)
      self.anti_words = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'antiPronunciations')
    
    if (value = attributes[:'antiPronunciations']).is_a?(Array)
      self.anti_pronunciations = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'spotabilityIndex')
    
    
    self.spotability_index = attributes[:'spotabilityIndex']
    
  
  end

  
  if attributes.has_key?(:'marginOfError')
    
    
    self.margin_of_error = attributes[:'marginOfError']
    
  
  end

  
  if attributes.has_key?(:'pronunciation')
    
    
    self.pronunciation = attributes[:'pronunciation']
    
  
  end

  
end

Instance Attribute Details

#agent_score_modifier ⇒ Object

A modifier to the evaluation score when the phrase is spotted in the agent channel



32
33
34
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 32

def agent_score_modifier
  @agent_score_modifier
end

#alternate_spellings ⇒ Object

Other spellings of the phrase that can be added to reduce missed spots (false negatives).



38
39
40
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 38

def alternate_spellings
  @alternate_spellings
end

#anti_pronunciations ⇒ Object

The phonetic spellings for the antiWords.



47
48
49
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 47

def anti_pronunciations
  @anti_pronunciations
end

#anti_words ⇒ Object

Words that are similar to the phrase but not desired. Added to reduce incorrect spots (false positives).



44
45
46
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 44

def anti_words
  @anti_words
end

#confidence ⇒ Object

A sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives.



29
30
31
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 29

def confidence
  @confidence
end

#customer_score_modifier ⇒ Object

A modifier to the evaluation score when the phrase is spotted in the customer channel



35
36
37
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 35

def customer_score_modifier
  @customer_score_modifier
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 21

def id
  @id
end

#margin_of_error ⇒ Object

Returns the value of attribute margin_of_error.



52
53
54
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 52

def margin_of_error
  @margin_of_error
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 23

def name
  @name
end

#phrase ⇒ Object

The word or phrase which is being looked for with speech recognition.



26
27
28
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 26

def phrase
  @phrase
end

#pronunciation ⇒ Object

Returns the value of attribute pronunciation.



54
55
56
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 54

def pronunciation
  @pronunciation
end

#pronunciations ⇒ Object

The phonetic spellings for the phrase and alternate spellings.



41
42
43
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 41

def pronunciations
  @pronunciations
end

#spotability_index ⇒ Object

A prediction of how easy it is to unambiguously spot the keyword within its language based on spelling.



50
51
52
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 50

def spotability_index
  @spotability_index
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 57

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'phrase' => :'phrase',
    
    :'confidence' => :'confidence',
    
    :'agent_score_modifier' => :'agentScoreModifier',
    
    :'customer_score_modifier' => :'customerScoreModifier',
    
    :'alternate_spellings' => :'alternateSpellings',
    
    :'pronunciations' => :'pronunciations',
    
    :'anti_words' => :'antiWords',
    
    :'anti_pronunciations' => :'antiPronunciations',
    
    :'spotability_index' => :'spotabilityIndex',
    
    :'margin_of_error' => :'marginOfError',
    
    :'pronunciation' => :'pronunciation'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 90

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'phrase' => :'String',
    
    :'confidence' => :'Integer',
    
    :'agent_score_modifier' => :'Integer',
    
    :'customer_score_modifier' => :'Integer',
    
    :'alternate_spellings' => :'Array<String>',
    
    :'pronunciations' => :'Array<String>',
    
    :'anti_words' => :'Array<String>',
    
    :'anti_pronunciations' => :'Array<String>',
    
    :'spotability_index' => :'Float',
    
    :'margin_of_error' => :'Float',
    
    :'pronunciation' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 413

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      phrase == o.phrase &&
      confidence == o.confidence &&
      agent_score_modifier == o.agent_score_modifier &&
      customer_score_modifier == o.customer_score_modifier &&
      alternate_spellings == o.alternate_spellings &&
      pronunciations == o.pronunciations &&
      anti_words == o.anti_words &&
      anti_pronunciations == o.anti_pronunciations &&
      spotability_index == o.spotability_index &&
      margin_of_error == o.margin_of_error &&
      pronunciation == o.pronunciation
end

#_deserialize(type, value) ⇒ Object 



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 463

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 523

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

build the object from hash



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 444

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


433
434
435
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 433

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



439
440
441
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 439

def hash
  [id, name, phrase, confidence, agent_score_modifier, customer_score_modifier, alternate_spellings, pronunciations, anti_words, anti_pronunciations, spotability_index, margin_of_error, pronunciation].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



260
261
262
263
264
265
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 260

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



506
507
508
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 506

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



511
512
513
514
515
516
517
518
519
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 511

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



501
502
503
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 501

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
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
337
338
339
340
341
342
343
 
# File 'lib/purecloudclient_v2a/models/keyword.rb', line 269

def valid?
  
  
  
  
  
  
  
  
  
  
  if @phrase.nil?
    return false
  end

  
  
  
  
  
  if @confidence.nil?
    return false
  end

  
  
  
  
  
  if @agent_score_modifier.nil?
    return false
  end

  
  
  
  
  
  if @customer_score_modifier.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end