Class: OCI::AiLanguage::Models::BatchDetectHealthEntityDetails

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

Overview

The documents details for health entities detect call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchDetectHealthEntityDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/ai_language/models/batch_detect_health_entity_details.rb', line 74

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

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

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

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

  self.link_ontologies = attributes[:'linkOntologies'] if attributes[:'linkOntologies']

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

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

  self.is_detect_assertions = attributes[:'isDetectAssertions'] unless attributes[:'isDetectAssertions'].nil?
  self.is_detect_assertions = false if is_detect_assertions.nil? && !attributes.key?(:'isDetectAssertions') # rubocop:disable Style/StringLiterals

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

  self.is_detect_assertions = attributes[:'is_detect_assertions'] unless attributes[:'is_detect_assertions'].nil?
  self.is_detect_assertions = false if is_detect_assertions.nil? && !attributes.key?(:'isDetectAssertions') && !attributes.key?(:'is_detect_assertions') # rubocop:disable Style/StringLiterals

  self.is_detect_relationships = attributes[:'isDetectRelationships'] unless attributes[:'isDetectRelationships'].nil?
  self.is_detect_relationships = false if is_detect_relationships.nil? && !attributes.key?(:'isDetectRelationships') # rubocop:disable Style/StringLiterals

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

  self.is_detect_relationships = attributes[:'is_detect_relationships'] unless attributes[:'is_detect_relationships'].nil?
  self.is_detect_relationships = false if is_detect_relationships.nil? && !attributes.key?(:'isDetectRelationships') && !attributes.key?(:'is_detect_relationships') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#documentsArray<OCI::AiLanguage::Models::TextDocument>

[Required] List of Documents for detect health entities.



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

def documents
  @documents
end

#endpoint_idString

[Required] The endpoint which have to be used for inferencing.

Returns:

  • (String)


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

def endpoint_id
  @endpoint_id
end

#is_detect_assertionsBOOLEAN

is assertion on input text required. default value true.

Returns:

  • (BOOLEAN)


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

def is_detect_assertions
  @is_detect_assertions
end

#is_detect_relationshipsBOOLEAN

is relationship on input text required. default value true.

Returns:

  • (BOOLEAN)


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

def is_detect_relationships
  @is_detect_relationships
end

List of NLP health ontologies to be linked

Returns:

  • (Array<String>)


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

def link_ontologies
  @link_ontologies
end

#profileOCI::AiLanguage::Models::Profile



32
33
34
# File 'lib/oci/ai_language/models/batch_detect_health_entity_details.rb', line 32

def profile
  @profile
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'endpoint_id': :'endpointId',
    'documents': :'documents',
    'link_ontologies': :'linkOntologies',
    'is_detect_assertions': :'isDetectAssertions',
    'is_detect_relationships': :'isDetectRelationships',
    'profile': :'profile'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'endpoint_id': :'String',
    'documents': :'Array<OCI::AiLanguage::Models::TextDocument>',
    'link_ontologies': :'Array<String>',
    'is_detect_assertions': :'BOOLEAN',
    'is_detect_relationships': :'BOOLEAN',
    'profile': :'OCI::AiLanguage::Models::Profile'
    # 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



120
121
122
123
124
125
126
127
128
129
130
# File 'lib/oci/ai_language/models/batch_detect_health_entity_details.rb', line 120

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

  self.class == other.class &&
    endpoint_id == other.endpoint_id &&
    documents == other.documents &&
    link_ontologies == other.link_ontologies &&
    is_detect_assertions == other.is_detect_assertions &&
    is_detect_relationships == other.is_detect_relationships &&
    profile == other.profile
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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/oci/ai_language/models/batch_detect_health_entity_details.rb', line 155

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


135
136
137
# File 'lib/oci/ai_language/models/batch_detect_health_entity_details.rb', line 135

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



144
145
146
# File 'lib/oci/ai_language/models/batch_detect_health_entity_details.rb', line 144

def hash
  [endpoint_id, documents, link_ontologies, is_detect_assertions, is_detect_relationships, profile].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
197
# File 'lib/oci/ai_language/models/batch_detect_health_entity_details.rb', line 188

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



182
183
184
# File 'lib/oci/ai_language/models/batch_detect_health_entity_details.rb', line 182

def to_s
  to_hash.to_s
end