Class: OCI::AiLanguage::Models::SentimentAspect

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/sentiment_aspect.rb

Overview

Sentiment aspect object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SentimentAspect

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :offset (Integer) —

    The value to assign to the #offset property

  • :length (Integer) —

    The value to assign to the #length property

  • :text (String) —

    The value to assign to the #text property

  • :sentiment (String) —

    The value to assign to the #sentiment property

  • :scores (Hash<String, Float>) —

    The value to assign to the #scores property



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 70

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

Instance Attribute Details

#length ⇒ Integer

Length of aspect text.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 17

def length
  @length
end

#offset ⇒ Integer

The number of Unicode code points preceding this entity in the submitted text.

Returns:

  • (Integer) 


13
14
15
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 13

def offset
  @offset
end

#scores ⇒ Hash<String, Float>

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

Returns:

  • (Hash<String, Float>) 


31
32
33
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 31

def scores
  @scores
end

#sentiment ⇒ String

The highest-score sentiment for the aspect text.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 25

def sentiment
  @sentiment
end

#text ⇒ String

Aspect text.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 21

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'offset': :'offset',
    'length': :'length',
    'text': :'text',
    'sentiment': :'sentiment',
    'scores': :'scores'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 47

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 94

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 128

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


108
109
110
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 117

def hash
  [offset, length, text, sentiment, scores].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 161

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



155
156
157
 
# File 'lib/oci/ai_language/models/sentiment_aspect.rb', line 155

def to_s
  to_hash.to_s
end