Class: OCI::AiLanguage::Models::NamedEntityRecognitionEvaluationResult

Inherits:
EvaluationResultSummary show all
Defined in:
lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb

Overview

Possible NER model error analysis

Instance Attribute Summary collapse

Attributes inherited from EvaluationResultSummary

#defined_tags, #freeform_tags, #model_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from EvaluationResultSummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ NamedEntityRecognitionEvaluationResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb', line 63

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['modelType'] = 'NAMED_ENTITY_RECOGNITION'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  self.true_entities = attributes[:'trueEntities'] if attributes[:'trueEntities']

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

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

  self.predicted_entities = attributes[:'predictedEntities'] if attributes[:'predictedEntities']

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

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

Instance Attribute Details

#predicted_entities ⇒ Array<OCI::AiLanguage::Models::EntityLabelErrorAnalysis>

[Required] List of true(actual) entities in test data for NER model

Returns:



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

def predicted_entities
  @predicted_entities
end

#record ⇒ String

[Required] For CSV format location is rowId(1 is header) and for JSONL location is jsonL line sequence(1 is metadata)

Returns:

  • (String) 


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

def record
  @record
end

#true_entities ⇒ Array<OCI::AiLanguage::Models::EntityLabelErrorAnalysis>

[Required] List of true(actual) entities in test data for NER model

Returns:



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

def true_entities
  @true_entities
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'record': :'record',
    'true_entities': :'trueEntities',
    'predicted_entities': :'predictedEntities'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'record': :'String',
    'true_entities': :'Array<OCI::AiLanguage::Models::EntityLabelErrorAnalysis>',
    'predicted_entities': :'Array<OCI::AiLanguage::Models::EntityLabelErrorAnalysis>'
    # 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



95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb', line 95

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

  self.class == other.class &&
    model_type == other.model_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    record == other.record &&
    true_entities == other.true_entities &&
    predicted_entities == other.predicted_entities
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb', line 130

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


110
111
112
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb', line 110

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb', line 119

def hash
  [model_type, freeform_tags, defined_tags, record, true_entities, predicted_entities].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb', line 163

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



157
158
159
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_result.rb', line 157

def to_s
  to_hash.to_s
end