Class: OCI::AiLanguage::Models::HealthEntity

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

Overview

Health entity object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HealthEntity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 103

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

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

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

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

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

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

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

  self.matched_concepts = attributes[:'matchedConcepts'] if attributes[:'matchedConcepts']

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

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

Instance Attribute Details

#assertions ⇒ Array<OCI::AiLanguage::Models::AssertionDetails>

list of all assertions associated with this entity.

Returns:



45
46
47
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 45

def assertions
  @assertions
end

#category ⇒ String

Entity category e.g, MEDICAL_CONDITION, MEDICATION, GENERAL, ANATOMY

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 37

def category
  @category
end

#id ⇒ String

[Required] Unique id of the entity

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 41

def id
  @id
end

#length ⇒ Integer

[Required] Length of entity text

Returns:

  • (Integer) 


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

def length
  @length
end

#matched_concepts ⇒ Array<OCI::AiLanguage::Models::MelConcept>

This contains the list of matched concepts which are ranked by the relevant score with the input text

Returns:



49
50
51
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 49

def matched_concepts
  @matched_concepts
end

#offset ⇒ Integer

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

Returns:

  • (Integer) 


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

def offset
  @offset
end

#score ⇒ Float

[Required] Score or confidence for detected entity.

Returns:

  • (Float) 


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

def score
  @score
end

#sub_type ⇒ String

Sub-type of entity text like GPE for LOCATION type

Returns:

  • (String) 


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

def sub_type
  @sub_type
end

#text ⇒ String

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

Returns:

  • (String) 


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

def text
  @text
end

#type ⇒ String

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

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'offset': :'offset',
    'length': :'length',
    'text': :'text',
    'type': :'type',
    'sub_type': :'subType',
    'score': :'score',
    'category': :'category',
    'id': :'id',
    'assertions': :'assertions',
    'matched_concepts': :'matchedConcepts'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'offset': :'Integer',
    'length': :'Integer',
    'text': :'String',
    'type': :'String',
    'sub_type': :'String',
    'score': :'Float',
    'category': :'String',
    'id': :'String',
    'assertions': :'Array<OCI::AiLanguage::Models::AssertionDetails>',
    'matched_concepts': :'Array<OCI::AiLanguage::Models::MelConcept>'
    # 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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 145

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

  self.class == other.class &&
    offset == other.offset &&
    length == other.length &&
    text == other.text &&
    type == other.type &&
    sub_type == other.sub_type &&
    score == other.score &&
    category == other.category &&
    id == other.id &&
    assertions == other.assertions &&
    matched_concepts == other.matched_concepts
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 184

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


164
165
166
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 164

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 173

def hash
  [offset, length, text, type, sub_type, score, category, id, assertions, matched_concepts].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 217

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



211
212
213
 
# File 'lib/oci/ai_language/models/health_entity.rb', line 211

def to_s
  to_hash.to_s
end