class OCI::AiLanguage::Models::SentimentAspect

Aspect object.

Attributes

length[RW]

Length of text. @return [Integer]

offset[RW]

The number of Unicode code points preceding this entity in the submitted text. @return [Integer]

scores[RW]

Scores for each sentiment. Example: "{\"positive\": 1.0, \"negative\": 0.0}"

@return [Hash<String, Float>]

sentiment[RW]

The highest-score sentiment for the aspect text. @return [String]

text[RW]

Aspect text. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 33
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'offset': :'offset',
    'length': :'length',
    'text': :'text',
    'sentiment': :'sentiment',
    'scores': :'scores'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Integer] :offset The value to assign to the {#offset} property @option attributes [Integer] :length The value to assign to the {#length} property @option attributes [String] :text The value to assign to the {#text} property @option attributes [String] :sentiment The value to assign to the {#sentiment} property @option attributes [Hash<String, Float>] :scores The value to assign to the {#scores} property

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 69
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 }

  self.offset = attributes[:'offset'] if attributes[:'offset']

  self.length = attributes[:'length'] if attributes[:'length']

  self.text = attributes[:'text'] if attributes[:'text']

  self.sentiment = attributes[:'sentiment'] if attributes[:'sentiment']

  self.scores = attributes[:'scores'] if attributes[:'scores']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 46
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'offset': :'Integer',
    'length': :'Integer',
    'text': :'String',
    'sentiment': :'String',
    'scores': :'Hash<String, Float>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

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

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 93
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    offset == other.offset &&
    length == other.length &&
    text == other.text &&
    sentiment == other.sentiment &&
    scores == other.scores
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 127
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
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

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

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 107
def eql?(other)
  self == other
end
hash() click to toggle source

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

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 116
def hash
  [offset, length, text, sentiment, scores].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 160
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 154
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/ai_language/models/sentiment_aspect.rb, line 177
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