Class: OCI::AiDocument::Models::GeneralProcessorConfig

Inherits:
ProcessorConfig show all
Defined in:
lib/oci/ai_document/models/general_processor_config.rb

Overview

The configuration of a general processor.

Constant Summary collapse

DOCUMENT_TYPE_ENUM = 
[
  DOCUMENT_TYPE_INVOICE = 'INVOICE'.freeze,
  DOCUMENT_TYPE_RECEIPT = 'RECEIPT'.freeze,
  DOCUMENT_TYPE_RESUME = 'RESUME'.freeze,
  DOCUMENT_TYPE_TAX_FORM = 'TAX_FORM'.freeze,
  DOCUMENT_TYPE_DRIVER_LICENSE = 'DRIVER_LICENSE'.freeze,
  DOCUMENT_TYPE_PASSPORT = 'PASSPORT'.freeze,
  DOCUMENT_TYPE_BANK_STATEMENT = 'BANK_STATEMENT'.freeze,
  DOCUMENT_TYPE_CHECK = 'CHECK'.freeze,
  DOCUMENT_TYPE_PAYSLIP = 'PAYSLIP'.freeze,
  DOCUMENT_TYPE_OTHERS = 'OTHERS'.freeze,
  DOCUMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from ProcessorConfig

ProcessorConfig::PROCESSOR_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ProcessorConfig

#processor_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ProcessorConfig

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ GeneralProcessorConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 79

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

  attributes['processorType'] = 'GENERAL'

  super(attributes)

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

  self.document_type = attributes[:'documentType'] if attributes[:'documentType']

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

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

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

  self.is_zip_output_enabled = attributes[:'isZipOutputEnabled'] unless attributes[:'isZipOutputEnabled'].nil?
  self.is_zip_output_enabled = false if is_zip_output_enabled.nil? && !attributes.key?(:'isZipOutputEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_zip_output_enabled = attributes[:'is_zip_output_enabled'] unless attributes[:'is_zip_output_enabled'].nil?
  self.is_zip_output_enabled = false if is_zip_output_enabled.nil? && !attributes.key?(:'isZipOutputEnabled') && !attributes.key?(:'is_zip_output_enabled') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#document_type ⇒ String

The document type.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 29

def document_type
  @document_type
end

#features ⇒ Array<OCI::AiDocument::Models::DocumentFeature>

[Required] The types of document analysis requested.

Returns:



33
34
35
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 33

def features
  @features
end

#is_zip_output_enabled ⇒ BOOLEAN

Whether or not to generate a ZIP file containing the results.

Returns:

  • (BOOLEAN) 


37
38
39
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 37

def is_zip_output_enabled
  @is_zip_output_enabled
end

#language ⇒ String

The document language, abbreviated according to the BCP 47 Language-Tag syntax.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 41

def language
  @language
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'processor_type': :'processorType',
    'document_type': :'documentType',
    'features': :'features',
    'is_zip_output_enabled': :'isZipOutputEnabled',
    'language': :'language'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'processor_type': :'String',
    'document_type': :'String',
    'features': :'Array<OCI::AiDocument::Models::DocumentFeature>',
    'is_zip_output_enabled': :'BOOLEAN',
    'language': :'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



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 128

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

  self.class == other.class &&
    processor_type == other.processor_type &&
    document_type == other.document_type &&
    features == other.features &&
    is_zip_output_enabled == other.is_zip_output_enabled &&
    language == other.language
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 162

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


142
143
144
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 151

def hash
  [processor_type, document_type, features, is_zip_output_enabled, language].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 195

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



189
190
191
 
# File 'lib/oci/ai_document/models/general_processor_config.rb', line 189

def to_s
  to_hash.to_s
end