Class: OCI::AiLanguage::Models::Entity

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

Overview

entity object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Entity

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

  • :type (String) —

    The value to assign to the #type property

  • :is_pii (BOOLEAN) —

    The value to assign to the #is_pii property

  • :score (Float) —

    The value to assign to the #score property



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/ai_language/models/entity.rb', line 78

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.type = attributes[:'type'] if attributes[:'type']

  self.is_pii = attributes[:'isPii'] unless attributes[:'isPii'].nil?

  raise 'You cannot provide both :isPii and :is_pii' if attributes.key?(:'isPii') && attributes.key?(:'is_pii')

  self.is_pii = attributes[:'is_pii'] unless attributes[:'is_pii'].nil?

  self.score = attributes[:'score'] if attributes[:'score']
end

Instance Attribute Details

#is_pii ⇒ BOOLEAN

This flag is to indicate if it is PII entity or not.

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/ai_language/models/entity.rb', line 30

def is_pii
  @is_pii
end

#length ⇒ Integer

Length of entity text

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/ai_language/models/entity.rb', line 18

def length
  @length
end

#offset ⇒ Integer

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

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/oci/ai_language/models/entity.rb', line 14

def offset
  @offset
end

#score ⇒ Float

Score or confidence of extracted entity type. Example: 0.9999856066867399

Returns:

  • (Float) 


36
37
38
 
# File 'lib/oci/ai_language/models/entity.rb', line 36

def score
  @score
end

#text ⇒ String

Entity text like name of person, location, and so on.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/ai_language/models/entity.rb', line 22

def text
  @text
end

#type ⇒ String

Type of entity text like PER, LOC, GPE and NOPE.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/ai_language/models/entity.rb', line 26

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/ai_language/models/entity.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'offset': :'offset',
    'length': :'length',
    'text': :'text',
    'type': :'type',
    'is_pii': :'isPii',
    'score': :'score'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/ai_language/models/entity.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'offset': :'Integer',
    'length': :'Integer',
    'text': :'String',
    'type': :'String',
    'is_pii': :'BOOLEAN',
    'score': :'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



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/ai_language/models/entity.rb', line 108

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    offset == other.offset &&
    length == other.length &&
    text == other.text &&
    type == other.type &&
    is_pii == other.is_pii &&
    score == other.score
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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/ai_language/models/entity.rb', line 143

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


123
124
125
 
# File 'lib/oci/ai_language/models/entity.rb', line 123

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



132
133
134
 
# File 'lib/oci/ai_language/models/entity.rb', line 132

def hash
  [offset, length, text, type, is_pii, score].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/ai_language/models/entity.rb', line 176

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



170
171
172
 
# File 'lib/oci/ai_language/models/entity.rb', line 170

def to_s
  to_hash.to_s
end