Class: OCI::AiVision::Models::DocumentClassificationFeature

Inherits:
DocumentFeature
  • Object
show all
Defined in:
lib/oci/ai_vision/models/document_classification_feature.rb

Overview

Identifying the document type.

Constant Summary

Constants inherited from DocumentFeature

OCI::AiVision::Models::DocumentFeature::FEATURE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DocumentFeature

#feature_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DocumentFeature

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DocumentClassificationFeature

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :max_results (Integer) —

    The value to assign to the #max_results property

  • :model_id (String) —

    The value to assign to the #model_id property



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 50

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

  attributes['featureType'] = 'DOCUMENT_CLASSIFICATION'

  super(attributes)

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

  self.max_results = attributes[:'maxResults'] if attributes[:'maxResults']

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

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

  self.model_id = attributes[:'modelId'] if attributes[:'modelId']

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

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

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of results to return.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 14

def max_results
  @max_results
end

#model_id ⇒ String

The custom model ID.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 18

def model_id
  @model_id
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
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'feature_type': :'featureType',
    'max_results': :'maxResults',
    'model_id': :'modelId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 32

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'feature_type': :'String',
    'max_results': :'Integer',
    'model_id': :'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



80
81
82
83
84
85
86
87
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 80

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

  self.class == other.class &&
    feature_type == other.feature_type &&
    max_results == other.max_results &&
    model_id == other.model_id
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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 112

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


92
93
94
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 92

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



101
102
103
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 101

def hash
  [feature_type, max_results, model_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 145

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



139
140
141
 
# File 'lib/oci/ai_vision/models/document_classification_feature.rb', line 139

def to_s
  to_hash.to_s
end