Class: OCI::AiDocument::Models::KeyValueDetectionLabelMetricsReport

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

Overview

Label Metrics report for Key Value Detection Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KeyValueDetectionLabelMetricsReport

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



61
62
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_document/models/key_value_detection_label_metrics_report.rb', line 61

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

  self.document_count = attributes[:'documentCount'] if attributes[:'documentCount']

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

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

  self.mean_average_precision = attributes[:'meanAveragePrecision'] if attributes[:'meanAveragePrecision']

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

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

  self.confidence_entries = attributes[:'confidenceEntries'] if attributes[:'confidenceEntries']

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

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

Instance Attribute Details

#confidence_entries ⇒ Array<OCI::AiDocument::Models::KeyValueDetectionConfidenceEntry>

[Required] List of key value detection confidence report.

Returns:



25
26
27
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 25

def confidence_entries
  @confidence_entries
end

#document_count ⇒ Integer

Total test documents in the label.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 17

def document_count
  @document_count
end

#label ⇒ String

Label name

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 13

def label
  @label
end

#mean_average_precision ⇒ Float

[Required] Mean average precision under different thresholds

Returns:

  • (Float) 


21
22
23
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 21

def mean_average_precision
  @mean_average_precision
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
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'label': :'label',
    'document_count': :'documentCount',
    'mean_average_precision': :'meanAveragePrecision',
    'confidence_entries': :'confidenceEntries'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'label': :'String',
    'document_count': :'Integer',
    'mean_average_precision': :'Float',
    'confidence_entries': :'Array<OCI::AiDocument::Models::KeyValueDetectionConfidenceEntry>'
    # 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
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 95

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

  self.class == other.class &&
    label == other.label &&
    document_count == other.document_count &&
    mean_average_precision == other.mean_average_precision &&
    confidence_entries == other.confidence_entries
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



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

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


108
109
110
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 117

def hash
  [label, document_count, mean_average_precision, confidence_entries].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 161

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



155
156
157
 
# File 'lib/oci/ai_document/models/key_value_detection_label_metrics_report.rb', line 155

def to_s
  to_hash.to_s
end