Class: OCI::AiLanguage::Models::ResolvedEntity

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

Overview

Resolved entity.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResolvedEntity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :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

  • :value (Hash<String, String>) —

    The value to assign to the #value property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 75

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

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

Instance Attribute Details

#id ⇒ String

[Required] id of the resolved entity in input

Returns:

  • (String) 


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

def id
  @id
end

#length ⇒ Integer

[Required] length of resolved entity in input

Returns:

  • (Integer) 


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

def length
  @length
end

#offset ⇒ Integer

[Required] offset of resolved entity in input

Returns:

  • (Integer) 


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

def offset
  @offset
end

#text ⇒ String

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

Returns:

  • (String) 


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

def text
  @text
end

#type ⇒ String

[Required] Type of entity text like PER, LOC.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 29

def type
  @type
end

#value ⇒ Hash<String, String>

[Required] key and value pair for resolved entities. keys can be specific for each type of resolved entity. Values can be instances of resolvedEntity, arrays of resolvedEntities, primitives, or custom JSON.

Returns:

  • (Hash<String, String>) 


33
34
35
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 33

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 36

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

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 50

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



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 101

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

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 136

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


116
117
118
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 125

def hash
  [id, offset, length, text, type, value].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 169

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



163
164
165
 
# File 'lib/oci/ai_language/models/resolved_entity.rb', line 163

def to_s
  to_hash.to_s
end