Class: PureCloud::Annotation

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/annotation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Annotation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



123
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
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 123

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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'keywordConfidenceThreshold')
    self.keyword_confidence_threshold = attributes[:'keywordConfidenceThreshold']
  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?(:'selfUri')
    self.self_uri = attributes[:'selfUri']
  end

end

Instance Attribute Details

#agent_score_modifier ⇒ Object

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



65
66
67
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 65

def agent_score_modifier
  @agent_score_modifier
end

#confidence ⇒ Object

Actual confidence that this is an accurate match.



44
45
46
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 44

def confidence
  @confidence
end

#customer_score_modifier ⇒ Object

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



68
69
70
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 68

def customer_score_modifier
  @customer_score_modifier
end

#description ⇒ Object

Text of annotation.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 38

def description
  @description
end

#duration_ms ⇒ Object

Duration of annotation in milliseconds.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 32

def duration_ms
  @duration_ms
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 22

def id
  @id
end

#keyword_confidence_threshold ⇒ Object

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



62
63
64
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 62

def keyword_confidence_threshold
  @keyword_confidence_threshold
end

#keyword_name ⇒ Object

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



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 41

def keyword_name
  @keyword_name
end

#keyword_set_id ⇒ Object

A unique identifier for the keyword set to which this spotted keyword belongs.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 47

def keyword_set_id
  @keyword_set_id
end

#keyword_set_name ⇒ Object

The keyword set to which this spotted keyword belongs.



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 50

def keyword_set_name
  @keyword_set_name
end

#location ⇒ Object

Offset of annotation in milliseconds.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 29

def location
  @location
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 24

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



71
72
73
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 71

def self_uri
  @self_uri
end

#time_begin ⇒ Object

Beginning time offset of the keyword spot match.



56
57
58
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 56

def time_begin
  @time_begin
end

#time_end ⇒ Object

Ending time offset of the keyword spot match.



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 59

def time_end
  @time_end
end

#type ⇒ Object

Returns the value of attribute type.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 26

def type
  @type
end

#user ⇒ Object

User that created this annotation (if any).



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 35

def user
  @user
end

#utterance ⇒ Object

The phonetic spellings for the phrase and alternate spellings.



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 53

def utterance
  @utterance
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'type' => :'type',
    :'location' => :'location',
    :'duration_ms' => :'durationMs',
    :'user' => :'user',
    :'description' => :'description',
    :'keyword_name' => :'keywordName',
    :'confidence' => :'confidence',
    :'keyword_set_id' => :'keywordSetId',
    :'keyword_set_name' => :'keywordSetName',
    :'utterance' => :'utterance',
    :'time_begin' => :'timeBegin',
    :'time_end' => :'timeEnd',
    :'keyword_confidence_threshold' => :'keywordConfidenceThreshold',
    :'agent_score_modifier' => :'agentScoreModifier',
    :'customer_score_modifier' => :'customerScoreModifier',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 98

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'location' => :'Integer',
    :'duration_ms' => :'Integer',
    :'user' => :'User',
    :'description' => :'String',
    :'keyword_name' => :'String',
    :'confidence' => :'Float',
    :'keyword_set_id' => :'String',
    :'keyword_set_name' => :'String',
    :'utterance' => :'String',
    :'time_begin' => :'String',
    :'time_end' => :'String',
    :'keyword_confidence_threshold' => :'String',
    :'agent_score_modifier' => :'String',
    :'customer_score_modifier' => :'String',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      type == o.type &&
      location == o.location &&
      duration_ms == o.duration_ms &&
      user == o.user &&
      description == o.description &&
      keyword_name == o.keyword_name &&
      confidence == o.confidence &&
      keyword_set_id == o.keyword_set_id &&
      keyword_set_name == o.keyword_set_name &&
      utterance == o.utterance &&
      time_begin == o.time_begin &&
      time_end == o.time_end &&
      keyword_confidence_threshold == o.keyword_confidence_threshold &&
      agent_score_modifier == o.agent_score_modifier &&
      customer_score_modifier == o.customer_score_modifier &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 280

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 340

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 261

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


250
251
252
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 256

def hash
  [id, name, type, location, duration_ms, user, description, keyword_name, confidence, keyword_set_id, keyword_set_name, utterance, time_begin, time_end, keyword_confidence_threshold, agent_score_modifier, customer_score_modifier, self_uri].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



205
206
207
208
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 205

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



323
324
325
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 323

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



328
329
330
331
332
333
334
335
336
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 328

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 



318
319
320
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 318

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



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/purecloudplatformclientv2/models/annotation.rb', line 212

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

  if @customer_score_modifier.nil?
    return false
  end

end