class PureCloud::Annotation

Attributes

absolute_duration_ms[RW]

Duration of annotation (milliseconds).

absolute_location[RW]

Offset of annotation (milliseconds) from start of recording.

agent_score_modifier[RW]

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

confidence[RW]

Actual confidence that this is an accurate match.

customer_score_modifier[RW]

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

description[RW]

Text of annotation.

duration_ms[RW]

Duration of annotation in milliseconds.

id[RW]

The globally unique identifier for the object.

keyword_confidence_threshold[RW]

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

keyword_name[RW]

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

keyword_set_id[RW]

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

keyword_set_name[RW]

The keyword set to which this spotted keyword belongs.

location[RW]

Offset of annotation in milliseconds.

name[RW]
recording_duration_ms[RW]

Duration of annotation (milliseconds), adjusted for any recording cuts.

recording_location[RW]

Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts

self_uri[RW]

The URI for this object

time_begin[RW]

Beginning time offset of the keyword spot match.

time_end[RW]

Ending time offset of the keyword spot match.

type[RW]
user[RW]

User that created this annotation (if any).

utterance[RW]

The phonetic spellings for the phrase and alternate spellings.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/annotation.rb, line 86
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'type' => :'type',
    
    :'location' => :'location',
    
    :'duration_ms' => :'durationMs',
    
    :'absolute_location' => :'absoluteLocation',
    
    :'absolute_duration_ms' => :'absoluteDurationMs',
    
    :'recording_location' => :'recordingLocation',
    
    :'recording_duration_ms' => :'recordingDurationMs',
    
    :'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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/annotation.rb, line 189
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?(:'absoluteLocation')
    
    
    self.absolute_location = attributes[:'absoluteLocation']
    
  
  end

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

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

  
  if attributes.has_key?(:'recordingDurationMs')
    
    
    self.recording_duration_ms = attributes[:'recordingDurationMs']
    
  
  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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/annotation.rb, line 137
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'type' => :'String',
    
    :'location' => :'Integer',
    
    :'duration_ms' => :'Integer',
    
    :'absolute_location' => :'Integer',
    
    :'absolute_duration_ms' => :'Integer',
    
    :'recording_location' => :'Integer',
    
    :'recording_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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/annotation.rb, line 622
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 &&
      absolute_location == o.absolute_location &&
      absolute_duration_ms == o.absolute_duration_ms &&
      recording_location == o.recording_location &&
      recording_duration_ms == o.recording_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) click to toggle source
# File lib/purecloudplatformclientv2/models/annotation.rb, line 681
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) click to toggle source

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

# File lib/purecloudplatformclientv2/models/annotation.rb, line 741
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) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/annotation.rb, line 662
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/annotation.rb, line 651
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/annotation.rb, line 657
def hash
  [id, name, type, location, duration_ms, absolute_location, absolute_duration_ms, recording_location, recording_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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/annotation.rb, line 398
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/annotation.rb, line 724
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/annotation.rb, line 729
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() click to toggle source
# File lib/purecloudplatformclientv2/models/annotation.rb, line 719
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/annotation.rb, line 407
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @agent_score_modifier.nil?
    return false
  end

  
  
  
  
  
  if @customer_score_modifier.nil?
    return false
  end

  
  
  
  
  
  
  
  
end