Class: OCI::AiVision::Models::DocumentFeature

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

Overview

The type of document analysis. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

FEATURE_TYPE_ENUM = 
[
  FEATURE_TYPE_LANGUAGE_CLASSIFICATION = 'LANGUAGE_CLASSIFICATION'.freeze,
  FEATURE_TYPE_TEXT_DETECTION = 'TEXT_DETECTION'.freeze,
  FEATURE_TYPE_TABLE_DETECTION = 'TABLE_DETECTION'.freeze,
  FEATURE_TYPE_KEY_VALUE_DETECTION = 'KEY_VALUE_DETECTION'.freeze,
  FEATURE_TYPE_DOCUMENT_CLASSIFICATION = 'DOCUMENT_CLASSIFICATION'.freeze,
  FEATURE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentFeature

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :feature_type (String) —

    The value to assign to the #feature_type property



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 77

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

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

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

Instance Attribute Details

#feature_type ⇒ String

[Required] The type of document analysis requested. The allowed values are: - LANGUAGE_CLASSIFICATION: Detect the language. - TEXT_DETECTION: Recognize text. - TABLE_DETECTION: Detect and extract data in tables. - KEY_VALUE_DETECTION: Extract form fields. - DOCUMENT_CLASSIFICATION: Identify the type of document.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 31

def feature_type
  @feature_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'feature_type': :'featureType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 56

def self.get_subtype(object_hash)
  type = object_hash[:'featureType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::AiVision::Models::DocumentTableDetectionFeature' if type == 'TABLE_DETECTION'
  return 'OCI::AiVision::Models::DocumentKeyValueDetectionFeature' if type == 'KEY_VALUE_DETECTION'
  return 'OCI::AiVision::Models::DocumentClassificationFeature' if type == 'DOCUMENT_CLASSIFICATION'
  return 'OCI::AiVision::Models::DocumentTextDetectionFeature' if type == 'TEXT_DETECTION'
  return 'OCI::AiVision::Models::DocumentLanguageClassificationFeature' if type == 'LANGUAGE_CLASSIFICATION'

  # TODO: Log a warning when the subtype is not found.
  'OCI::AiVision::Models::DocumentFeature'
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 43

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



110
111
112
113
114
115
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 110

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

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 140

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


120
121
122
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 120

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 129

def hash
  [feature_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 173

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



167
168
169
 
# File 'lib/oci/ai_vision/models/document_feature.rb', line 167

def to_s
  to_hash.to_s
end