Class: PureCloud::Keyword

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Keyword

Returns a new instance of Keyword.



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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/purecloud/models/keyword.rb', line 90

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

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'phrase']
    self.phrase = attributes[:'phrase']
  end
  
  if attributes[:'confidence']
    self.confidence = attributes[:'confidence']
  end
  
  if attributes[:'agentScoreModifier']
    self.agent_score_modifier = attributes[:'agentScoreModifier']
  end
  
  if attributes[:'customerScoreModifier']
    self.customer_score_modifier = attributes[:'customerScoreModifier']
  end
  
  if attributes[:'alternateSpellings']
    if (value = attributes[:'alternateSpellings']).is_a?(Array)
      self.alternate_spellings = value
    end
  end
  
  if attributes[:'spotabilityIndex']
    self.spotability_index = attributes[:'spotabilityIndex']
  end
  
  if attributes[:'marginOfError']
    self.margin_of_error = attributes[:'marginOfError']
  end
  
  if attributes[:'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/purecloud/models/keyword.rb', line 32

def agent_score_modifier
  @agent_score_modifier
end

#alternate_spellings ⇒ Object

Returns the value of attribute alternate_spellings.



37
38
39
 
# File 'lib/purecloud/models/keyword.rb', line 37

def alternate_spellings
  @alternate_spellings
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/purecloud/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/purecloud/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/purecloud/models/keyword.rb', line 21

def id
  @id
end

#margin_of_error ⇒ Object

Returns the value of attribute margin_of_error.



42
43
44
 
# File 'lib/purecloud/models/keyword.rb', line 42

def margin_of_error
  @margin_of_error
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/purecloud/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/purecloud/models/keyword.rb', line 26

def phrase
  @phrase
end

#pronunciation ⇒ Object

Returns the value of attribute pronunciation.



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

def pronunciation
  @pronunciation
end

#spotability_index ⇒ Object

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



40
41
42
 
# File 'lib/purecloud/models/keyword.rb', line 40

def spotability_index
  @spotability_index
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloud/models/keyword.rb', line 47

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

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/purecloud/models/keyword.rb', line 74

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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/purecloud/models/keyword.rb', line 142

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 &&
      spotability_index == o.spotability_index &&
      margin_of_error == o.margin_of_error &&
      pronunciation == o.pronunciation
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/keyword.rb', line 187

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/purecloud/models/keyword.rb', line 247

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/purecloud/models/keyword.rb', line 168

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

Returns:

  • (Boolean)

See Also:

  • `==` method


158
159
160
 
# File 'lib/purecloud/models/keyword.rb', line 158

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



163
164
165
 
# File 'lib/purecloud/models/keyword.rb', line 163

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



230
231
232
 
# File 'lib/purecloud/models/keyword.rb', line 230

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



235
236
237
238
239
240
241
242
243
 
# File 'lib/purecloud/models/keyword.rb', line 235

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 



225
226
227
 
# File 'lib/purecloud/models/keyword.rb', line 225

def to_s
  to_hash.to_s
end