Class: OCI::AiLanguage::Models::HealthEntityDocumentResult

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

Overview

The document response for health entity detect call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HealthEntityDocumentResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/ai_language/models/health_entity_document_result.rb', line 68

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

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

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

  self.resolved_entities = attributes[:'resolvedEntities'] if attributes[:'resolvedEntities']

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

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

  self.language_code = attributes[:'languageCode'] if attributes[:'languageCode']

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

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

Instance Attribute Details

#entities ⇒ Array<OCI::AiLanguage::Models::HealthEntity>

[Required] List of detected entities.

Returns:



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

def entities
  @entities
end

#key ⇒ String

[Required] Document unique identifier defined by the user.

Returns:

  • (String) 


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

def key
  @key
end

#language_code ⇒ String

[Required] Language code of the document. Please refer to respective model API documentation for supported languages.

Returns:

  • (String) 


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

def language_code
  @language_code
end

#relations ⇒ Array<OCI::AiLanguage::Models::RelationEntity>

List of succeeded document response.

Returns:



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

def relations
  @relations
end

#resolved_entities ⇒ Hash<String, OCI::AiLanguage::Models::ResolvedEntities>

[Required] Map of resolved entities by entity type

Returns:



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

def resolved_entities
  @resolved_entities
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/ai_language/models/health_entity_document_result.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'entities': :'entities',
    'relations': :'relations',
    'resolved_entities': :'resolvedEntities',
    'language_code': :'languageCode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/ai_language/models/health_entity_document_result.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'entities': :'Array<OCI::AiLanguage::Models::HealthEntity>',
    'relations': :'Array<OCI::AiLanguage::Models::RelationEntity>',
    'resolved_entities': :'Hash<String, OCI::AiLanguage::Models::ResolvedEntities>',
    'language_code': :'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



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

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

  self.class == other.class &&
    key == other.key &&
    entities == other.entities &&
    relations == other.relations &&
    resolved_entities == other.resolved_entities &&
    language_code == other.language_code
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



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

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


114
115
116
 
# File 'lib/oci/ai_language/models/health_entity_document_result.rb', line 114

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [key, entities, relations, resolved_entities, language_code].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/ai_language/models/health_entity_document_result.rb', line 167

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



161
162
163
 
# File 'lib/oci/ai_language/models/health_entity_document_result.rb', line 161

def to_s
  to_hash.to_s
end