Class: OCI::AiDocument::Models::AnalyzeDocumentDetails
- Inherits:
-
Object
- Object
- OCI::AiDocument::Models::AnalyzeDocumentDetails
- Defined in:
- lib/oci/ai_document/models/analyze_document_details.rb
Overview
The details of how to analyze a document.
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 ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The compartment identifier.
-
#document ⇒ OCI::AiDocument::Models::DocumentDetails
This attribute is required.
-
#document_type ⇒ String
The document type.
-
#features ⇒ Array<OCI::AiDocument::Models::DocumentFeature>
[Required] The types of document analysis requested.
-
#language ⇒ String
The document language, abbreviated according to the BCP 47 syntax.
- #ocr_data ⇒ OCI::AiDocument::Models::AnalyzeDocumentResult
- #output_location ⇒ OCI::AiDocument::Models::OutputLocation
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ AnalyzeDocumentDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ AnalyzeDocumentDetails
Initializes the object
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 93 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.features = attributes[:'features'] if attributes[:'features'] self.document = attributes[:'document'] if attributes[:'document'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.output_location = attributes[:'outputLocation'] if attributes[:'outputLocation'] raise 'You cannot provide both :outputLocation and :output_location' if attributes.key?(:'outputLocation') && attributes.key?(:'output_location') self.output_location = attributes[:'output_location'] if attributes[:'output_location'] self.language = attributes[:'language'] if attributes[:'language'] 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.ocr_data = attributes[:'ocrData'] if attributes[:'ocrData'] raise 'You cannot provide both :ocrData and :ocr_data' if attributes.key?(:'ocrData') && attributes.key?(:'ocr_data') self.ocr_data = attributes[:'ocr_data'] if attributes[:'ocr_data'] end |
Instance Attribute Details
#compartment_id ⇒ String
The compartment identifier.
34 35 36 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 34 def compartment_id @compartment_id end |
#document ⇒ OCI::AiDocument::Models::DocumentDetails
This attribute is required.
30 31 32 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 30 def document @document end |
#document_type ⇒ String
The document type.
45 46 47 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 45 def document_type @document_type end |
#features ⇒ Array<OCI::AiDocument::Models::DocumentFeature>
[Required] The types of document analysis requested.
26 27 28 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 26 def features @features end |
#language ⇒ String
The document language, abbreviated according to the BCP 47 syntax.
41 42 43 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 41 def language @language end |
#ocr_data ⇒ OCI::AiDocument::Models::AnalyzeDocumentResult
48 49 50 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 48 def ocr_data @ocr_data end |
#output_location ⇒ OCI::AiDocument::Models::OutputLocation
37 38 39 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 37 def output_location @output_location end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 51 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'features': :'features', 'document': :'document', 'compartment_id': :'compartmentId', 'output_location': :'outputLocation', 'language': :'language', 'document_type': :'documentType', 'ocr_data': :'ocrData' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 66 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'features': :'Array<OCI::AiDocument::Models::DocumentFeature>', 'document': :'OCI::AiDocument::Models::DocumentDetails', 'compartment_id': :'String', 'output_location': :'OCI::AiDocument::Models::OutputLocation', 'language': :'String', 'document_type': :'String', 'ocr_data': :'OCI::AiDocument::Models::AnalyzeDocumentResult' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 145 def ==(other) return true if equal?(other) self.class == other.class && features == other.features && document == other.document && compartment_id == other.compartment_id && output_location == other.output_location && language == other.language && document_type == other.document_type && ocr_data == other.ocr_data end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 181 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
161 162 163 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 161 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
170 171 172 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 170 def hash [features, document, compartment_id, output_location, language, document_type, ocr_data].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
214 215 216 217 218 219 220 221 222 223 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 214 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
208 209 210 |
# File 'lib/oci/ai_document/models/analyze_document_details.rb', line 208 def to_s to_hash.to_s end |