Class: OCI::AiDocument::Models::DocumentClassificationConfidenceEntry

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

Overview

Confidence Entry.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentClassificationConfidenceEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :threshold (Float) —

    The value to assign to the #threshold property

  • :precision (Float) —

    The value to assign to the #precision property

  • :recall (Float) —

    The value to assign to the #recall property

  • :f1_score (Float) —

    The value to assign to the #f1_score property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/ai_document/models/document_classification_confidence_entry.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.threshold = attributes[:'threshold'] if attributes[:'threshold']

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

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

  self.f1_score = attributes[:'f1Score'] if attributes[:'f1Score']

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

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

Instance Attribute Details

#f1_score ⇒ Float

[Required] f1Score under the threshold

Returns:

  • (Float) 


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

def f1_score
  @f1_score
end

#precision ⇒ Float

[Required] Precision under the threshold

Returns:

  • (Float) 


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

def precision
  @precision
end

#recall ⇒ Float

[Required] Recall under the threshold

Returns:

  • (Float) 


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

def recall
  @recall
end

#threshold ⇒ Float

[Required] Threshold used to calculate precision and recall.

Returns:

  • (Float) 


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

def threshold
  @threshold
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/document_classification_confidence_entry.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'threshold': :'threshold',
    'precision': :'precision',
    'recall': :'recall',
    'f1_score': :'f1Score'
    # 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/document_classification_confidence_entry.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'threshold': :'Float',
    'precision': :'Float',
    'recall': :'Float',
    'f1_score': :'Float'
    # 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



87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/ai_document/models/document_classification_confidence_entry.rb', line 87

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

  self.class == other.class &&
    threshold == other.threshold &&
    precision == other.precision &&
    recall == other.recall &&
    f1_score == other.f1_score
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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/ai_document/models/document_classification_confidence_entry.rb', line 120

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


100
101
102
 
# File 'lib/oci/ai_document/models/document_classification_confidence_entry.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/ai_document/models/document_classification_confidence_entry.rb', line 109

def hash
  [threshold, precision, recall, f1_score].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/ai_document/models/document_classification_confidence_entry.rb', line 153

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



147
148
149
 
# File 'lib/oci/ai_document/models/document_classification_confidence_entry.rb', line 147

def to_s
  to_hash.to_s
end