Class: OCI::AiDocument::Models::KeyValueDetectionModelMetrics

Inherits:
ModelMetrics
  • Object
show all
Defined in:
lib/oci/ai_document/models/key_value_detection_model_metrics.rb

Overview

Metrics for Document Key Value Detection Model.

Constant Summary

Constants inherited from ModelMetrics

ModelMetrics::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ModelMetrics

#dataset_summary, #model_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ModelMetrics

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ KeyValueDetectionModelMetrics

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 53

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

  attributes['modelType'] = 'KEY_VALUE_EXTRACTION'

  super(attributes)

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

  self.label_metrics_report = attributes[:'labelMetricsReport'] if attributes[:'labelMetricsReport']

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

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

  self.overall_metrics_report = attributes[:'overallMetricsReport'] if attributes[:'overallMetricsReport']

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

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

Instance Attribute Details

#label_metrics_report ⇒ Array<OCI::AiDocument::Models::KeyValueDetectionLabelMetricsReport>

[Required] List of metrics entries per label.

Returns:



14
15
16
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 14

def label_metrics_report
  @label_metrics_report
end

#overall_metrics_report ⇒ OCI::AiDocument::Models::KeyValueDetectionOverallMetricsReport

This attribute is required.

Returns:



18
19
20
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 18

def overall_metrics_report
  @overall_metrics_report
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'dataset_summary': :'datasetSummary',
    'label_metrics_report': :'labelMetricsReport',
    'overall_metrics_report': :'overallMetricsReport'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'dataset_summary': :'OCI::AiDocument::Models::DatasetSummary',
    'label_metrics_report': :'Array<OCI::AiDocument::Models::KeyValueDetectionLabelMetricsReport>',
    'overall_metrics_report': :'OCI::AiDocument::Models::KeyValueDetectionOverallMetricsReport'
    # 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



83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 83

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

  self.class == other.class &&
    model_type == other.model_type &&
    dataset_summary == other.dataset_summary &&
    label_metrics_report == other.label_metrics_report &&
    overall_metrics_report == other.overall_metrics_report
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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 116

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


96
97
98
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 96

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



105
106
107
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 105

def hash
  [model_type, dataset_summary, label_metrics_report, overall_metrics_report].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 149

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



143
144
145
 
# File 'lib/oci/ai_document/models/key_value_detection_model_metrics.rb', line 143

def to_s
  to_hash.to_s
end