Class: OCI::AiLanguage::Models::NamedEntityRecognitionEvaluationResults

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

Overview

Named entity recognition model testing and evaluation results

Instance Attribute Summary collapse

Attributes inherited from EvaluationResults

#model_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from EvaluationResults

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ NamedEntityRecognitionEvaluationResults

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
87
88
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_results.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.metrics = attributes[:'metrics'] if attributes[:'metrics']

  self.entity_metrics = attributes[:'entityMetrics'] if attributes[:'entityMetrics']

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

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

  self.confusion_matrix = attributes[:'confusionMatrix'] if attributes[:'confusionMatrix']

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

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

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

Instance Attribute Details

#confusion_matrix ⇒ Hash<String, OCI::AiLanguage::Models::ConfusionMatrixDetails>

class level confusion matrix

Returns:



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

def confusion_matrix
  @confusion_matrix
end

#entity_metrics ⇒ Array<OCI::AiLanguage::Models::EntityMetrics>

List of entity metrics

Returns:



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

def entity_metrics
  @entity_metrics
end

#labels ⇒ Array<String>

labels

Returns:

  • (Array<String>) 


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

def labels
  @labels
end

#metrics ⇒ OCI::AiLanguage::Models::NamedEntityRecognitionModelMetrics

Returns:



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

def metrics
  @metrics
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_results.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'metrics': :'metrics',
    'entity_metrics': :'entityMetrics',
    'confusion_matrix': :'confusionMatrix',
    'labels': :'labels'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'metrics': :'OCI::AiLanguage::Models::NamedEntityRecognitionModelMetrics',
    'entity_metrics': :'Array<OCI::AiLanguage::Models::EntityMetrics>',
    'confusion_matrix': :'Hash<String, OCI::AiLanguage::Models::ConfusionMatrixDetails>',
    'labels': :'Array<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



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

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

  self.class == other.class &&
    model_type == other.model_type &&
    metrics == other.metrics &&
    entity_metrics == other.entity_metrics &&
    confusion_matrix == other.confusion_matrix &&
    labels == other.labels
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



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

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


111
112
113
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_results.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_results.rb', line 120

def hash
  [model_type, metrics, entity_metrics, confusion_matrix, labels].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



158
159
160
 
# File 'lib/oci/ai_language/models/named_entity_recognition_evaluation_results.rb', line 158

def to_s
  to_hash.to_s
end