mindee 3.1.0 → 3.2.0

data/lib/mindee/product/us/driver_license/driver_license_v1_document.rb

@@ -10,78 +10,78 @@ module Mindee
         class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # US driver license holders address
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :address
           # US driver license holders date of birth
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :date_of_birth
           # Document Discriminator Number of the US Driver License
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :dd_number
           # US driver license holders class
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :dl_class
           # ID number of the US Driver License.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :driver_license_id
           # US driver license holders endorsements
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :endorsements
           # Date on which the documents expires.
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :expiry_date
           # US driver license holders eye colour
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :eye_color
           # US driver license holders first name(s)
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :first_name
           # US driver license holders hair colour
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :hair_color
           # US driver license holders hight
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :height
           # Date on which the documents was issued.
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :issued_date
           # US driver license holders last name
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :last_name
           # US driver license holders restrictions
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :restrictions
           # US driver license holders gender
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :sex
           # US State
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :state
           # US driver license holders weight
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :weight
 
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
             super()
-            @address = TextField.new(prediction['address'], page_id)
+            @address = StringField.new(prediction['address'], page_id)
             @date_of_birth = DateField.new(prediction['date_of_birth'], page_id)
-            @dd_number = TextField.new(prediction['dd_number'], page_id)
-            @dl_class = TextField.new(prediction['dl_class'], page_id)
-            @driver_license_id = TextField.new(prediction['driver_license_id'], page_id)
-            @endorsements = TextField.new(prediction['endorsements'], page_id)
+            @dd_number = StringField.new(prediction['dd_number'], page_id)
+            @dl_class = StringField.new(prediction['dl_class'], page_id)
+            @driver_license_id = StringField.new(prediction['driver_license_id'], page_id)
+            @endorsements = StringField.new(prediction['endorsements'], page_id)
             @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-            @eye_color = TextField.new(prediction['eye_color'], page_id)
-            @first_name = TextField.new(prediction['first_name'], page_id)
-            @hair_color = TextField.new(prediction['hair_color'], page_id)
-            @height = TextField.new(prediction['height'], page_id)
+            @eye_color = StringField.new(prediction['eye_color'], page_id)
+            @first_name = StringField.new(prediction['first_name'], page_id)
+            @hair_color = StringField.new(prediction['hair_color'], page_id)
+            @height = StringField.new(prediction['height'], page_id)
             @issued_date = DateField.new(prediction['issued_date'], page_id)
-            @last_name = TextField.new(prediction['last_name'], page_id)
-            @restrictions = TextField.new(prediction['restrictions'], page_id)
-            @sex = TextField.new(prediction['sex'], page_id)
-            @state = TextField.new(prediction['state'], page_id)
-            @weight = TextField.new(prediction['weight'], page_id)
+            @last_name = StringField.new(prediction['last_name'], page_id)
+            @restrictions = StringField.new(prediction['restrictions'], page_id)
+            @sex = StringField.new(prediction['sex'], page_id)
+            @state = StringField.new(prediction['state'], page_id)
+            @weight = StringField.new(prediction['weight'], page_id)
           end
 
           # @return [String]

data/lib/mindee/product/us/w9/w9_v1.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'w9_v1_document'
+require_relative 'w9_v1_page'
+
+module Mindee
+  module Product
+    module US
+      # US W9 module.
+      module W9
+        # US W9 V1 prediction inference.
+        class W9V1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'us_w9'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = W9V1Document.new
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(W9V1Page.new(page))
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/w9/w9_v1_document.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module US
+      module W9
+        # US W9 V1 document prediction.
+        class W9V1Document < Mindee::Parsing::Common::Prediction
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/w9/w9_v1_page.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'w9_v1_document'
+
+module Mindee
+  module Product
+    module US
+      module W9
+        # US W9 V1 page.
+        class W9V1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = W9V1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # US W9 V1 page prediction.
+        class W9V1PagePrediction < W9V1Document
+          include Mindee::Parsing::Standard
+
+          # The street address (number, street, and apt. or suite no.) of the applicant.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :address
+          # The business name or disregarded entity name, if different from Name.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :business_name
+          # The city, state, and ZIP code of the applicant.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :city_state_zip
+          # The employer identification number.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :ein
+          # Name as shown on the applicant's income tax return.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :name
+          # Position of the signature date on the document.
+          # @return [Mindee::Parsing::Standard::PositionField]
+          attr_reader :signature_date_position
+          # Position of the signature on the document.
+          # @return [Mindee::Parsing::Standard::PositionField]
+          attr_reader :signature_position
+          # The applicant's social security number.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :ssn
+          # The federal tax classification, which can vary depending on the revision date.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :tax_classification
+          # Depending on revision year, among S, C, P or D for Limited Liability Company Classification.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :tax_classification_llc
+          # Tax Classification Other Details.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :tax_classification_other_details
+          # The Revision month and year of the W9 form.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :w9_revision_date
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            @address = StringField.new(prediction['address'], page_id)
+            @business_name = StringField.new(prediction['business_name'], page_id)
+            @city_state_zip = StringField.new(prediction['city_state_zip'], page_id)
+            @ein = StringField.new(prediction['ein'], page_id)
+            @name = StringField.new(prediction['name'], page_id)
+            @signature_date_position = PositionField.new(prediction['signature_date_position'], page_id)
+            @signature_position = PositionField.new(prediction['signature_position'], page_id)
+            @ssn = StringField.new(prediction['ssn'], page_id)
+            @tax_classification = StringField.new(prediction['tax_classification'], page_id)
+            @tax_classification_llc = StringField.new(prediction['tax_classification_llc'], page_id)
+            @tax_classification_other_details = StringField.new(prediction['tax_classification_other_details'], page_id)
+            @w9_revision_date = StringField.new(prediction['w9_revision_date'], page_id)
+            super()
+          end
+
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n:Name: #{@name}".rstrip
+            out_str << "\n:SSN: #{@ssn}".rstrip
+            out_str << "\n:Address: #{@address}".rstrip
+            out_str << "\n:City State Zip: #{@city_state_zip}".rstrip
+            out_str << "\n:Business Name: #{@business_name}".rstrip
+            out_str << "\n:EIN: #{@ein}".rstrip
+            out_str << "\n:Tax Classification: #{@tax_classification}".rstrip
+            out_str << "\n:Tax Classification Other Details: #{@tax_classification_other_details}".rstrip
+            out_str << "\n:W9 Revision Date: #{@w9_revision_date}".rstrip
+            out_str << "\n:Signature Position: #{@signature_position}".rstrip
+            out_str << "\n:Signature Date Position: #{@signature_date_position}".rstrip
+            out_str << "\n:Tax Classification LLC: #{@tax_classification_llc}".rstrip
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'product/barcode_reader/barcode_reader_v1'
 require_relative 'product/custom/custom_v1'
 require_relative 'product/proof_of_address/proof_of_address_v1'
 require_relative 'product/financial_document/financial_document_v1'
 require_relative 'product/invoice/invoice_v4'
+require_relative 'product/cropper/cropper_v1'
+require_relative 'product/multi_receipts_detector/multi_receipts_detector_v1'
 require_relative 'product/passport/passport_v1'
 require_relative 'product/receipt/receipt_v4'
 require_relative 'product/receipt/receipt_v5'
@@ -12,6 +15,8 @@ require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
 require_relative 'product/fr/carte_vitale/carte_vitale_v1'
 require_relative 'product/fr/id_card/id_card_v1'
+require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
 require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/driver_license/driver_license_v1'
+require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

@@ -2,8 +2,10 @@
 
 # Mindee
 module Mindee
-  VERSION = '3.1.0'
+  # Current version.
+  VERSION = '3.2.0'
 
+  # Finds and return the current platform.
   # @return [String]
   def self.find_platform
     host = RbConfig::CONFIG['host_os']
@@ -18,5 +20,7 @@ module Mindee
       return os unless (regexp =~ host).nil?
     end
   end
+
+  # Current platform.
   PLATFORM = find_platform.freeze
 end

data/lib/mindee.rb

@@ -3,8 +3,55 @@
 require 'mindee/client'
 
 module Mindee
+  # Mindee internal http module.
   module HTTP
+    # Global Mindee HTTP error handler.
     class HttpError < StandardError
     end
   end
+
+  # PDF-specific operations.
+  module PDF
+  end
+
+  # Document handling.
+  module Input
+    # Document source handling.
+    module Source
+    end
+  end
+
+  # Parsing internals and fields.
+  module Parsing
+    # Common fields and functions.
+    module Common
+    end
+
+    # Custom fields and functions.
+    module Custom
+    end
+
+    # Standard fields and functions.
+    module Standard
+    end
+  end
+
+  # Document input-related internals.
+  module Input
+  end
+
+  # Collection of all internal products.
+  module Product
+    # Europe-specific products.
+    module EU
+    end
+
+    # France-specific products.
+    module FR
+    end
+
+    # US-specific products.
+    module US
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -117,27 +117,45 @@ files:
 - Rakefile
 - bin/console
 - bin/mindee.rb
+- docs/bank_account_details_v2.md
+- docs/bank_check_v1.md
+- docs/barcode_reader_v1.md
+- docs/carte_vitale_v1.md
 - docs/code_samples/bank_account_details_v1.txt
 - docs/code_samples/bank_account_details_v2.txt
 - docs/code_samples/bank_check_v1.txt
+- docs/code_samples/barcode_reader_v1.txt
 - docs/code_samples/carte_vitale_v1.txt
+- docs/code_samples/cropper_v1.txt
 - docs/code_samples/custom_v1.txt
 - docs/code_samples/default.txt
 - docs/code_samples/expense_receipts_v4.txt
 - docs/code_samples/expense_receipts_v5.txt
 - docs/code_samples/financial_document_v1.txt
 - docs/code_samples/idcard_fr_v1.txt
+- docs/code_samples/idcard_fr_v2.txt
 - docs/code_samples/invoice_splitter_v1_async.txt
 - docs/code_samples/invoices_v4.txt
 - docs/code_samples/license_plates_v1.txt
+- docs/code_samples/multi_receipts_detector_v1.txt
 - docs/code_samples/passport_v1.txt
 - docs/code_samples/proof_of_address_v1.txt
 - docs/code_samples/us_driver_license_v1.txt
-- docs/ruby-api-builder.md
-- docs/ruby-getting-started.md
-- docs/ruby-invoice-ocr.md
-- docs/ruby-passport-ocr.md
-- docs/ruby-receipt-ocr.md
+- docs/code_samples/us_w9_v1.txt
+- docs/cropper_v1.md
+- docs/custom_v1.md
+- docs/expense_receipts_v5.md
+- docs/financial_document_v1.md
+- docs/getting_started.md
+- docs/idcard_fr_v2.md
+- docs/invoice_splitter_v1.md
+- docs/invoices_v4.md
+- docs/license_plates_v1.md
+- docs/multi_receipts_detector_v1.md
+- docs/passport_v1.md
+- docs/proof_of_address_v1.md
+- docs/us_driver_license_v1.md
+- docs/us_w9_v1.md
 - lib/mindee.rb
 - lib/mindee/client.rb
 - lib/mindee/geometry.rb
@@ -147,14 +165,15 @@ files:
 - lib/mindee/geometry/quadrilateral.rb
 - lib/mindee/geometry/utils.rb
 - lib/mindee/http.rb
+- lib/mindee/http/.rubocop.yml
 - lib/mindee/http/endpoint.rb
+- lib/mindee/http/error.rb
 - lib/mindee/input.rb
 - lib/mindee/input/sources.rb
 - lib/mindee/parsing.rb
 - lib/mindee/parsing/common.rb
 - lib/mindee/parsing/common/api_response.rb
 - lib/mindee/parsing/common/document.rb
-- lib/mindee/parsing/common/error.rb
 - lib/mindee/parsing/common/inference.rb
 - lib/mindee/parsing/common/ocr.rb
 - lib/mindee/parsing/common/ocr/mvision_v1.rb
@@ -175,13 +194,19 @@ files:
 - lib/mindee/parsing/standard/locale_field.rb
 - lib/mindee/parsing/standard/payment_details_field.rb
 - lib/mindee/parsing/standard/position_field.rb
+- lib/mindee/parsing/standard/string_field.rb
 - lib/mindee/parsing/standard/tax_field.rb
-- lib/mindee/parsing/standard/text_field.rb
 - lib/mindee/pdf.rb
 - lib/mindee/pdf/pdf_processing.rb
 - lib/mindee/pdf/pdf_tools.rb
 - lib/mindee/product.rb
 - lib/mindee/product/.rubocop.yml
+- lib/mindee/product/barcode_reader/barcode_reader_v1.rb
+- lib/mindee/product/barcode_reader/barcode_reader_v1_document.rb
+- lib/mindee/product/barcode_reader/barcode_reader_v1_page.rb
+- lib/mindee/product/cropper/cropper_v1.rb
+- lib/mindee/product/cropper/cropper_v1_document.rb
+- lib/mindee/product/cropper/cropper_v1_page.rb
 - lib/mindee/product/custom/custom_v1.rb
 - lib/mindee/product/custom/custom_v1_document.rb
 - lib/mindee/product/custom/custom_v1_page.rb
@@ -205,6 +230,9 @@ files:
 - lib/mindee/product/fr/id_card/id_card_v1.rb
 - lib/mindee/product/fr/id_card/id_card_v1_document.rb
 - lib/mindee/product/fr/id_card/id_card_v1_page.rb
+- lib/mindee/product/fr/id_card/id_card_v2.rb
+- lib/mindee/product/fr/id_card/id_card_v2_document.rb
+- lib/mindee/product/fr/id_card/id_card_v2_page.rb
 - lib/mindee/product/invoice/invoice_v4.rb
 - lib/mindee/product/invoice/invoice_v4_document.rb
 - lib/mindee/product/invoice/invoice_v4_line_item.rb
@@ -212,6 +240,9 @@ files:
 - lib/mindee/product/invoice_splitter/invoice_splitter_v1.rb
 - lib/mindee/product/invoice_splitter/invoice_splitter_v1_document.rb
 - lib/mindee/product/invoice_splitter/invoice_splitter_v1_page.rb
+- lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rb
+- lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb
+- lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb
 - lib/mindee/product/passport/passport_v1.rb
 - lib/mindee/product/passport/passport_v1_document.rb
 - lib/mindee/product/passport/passport_v1_page.rb
@@ -231,6 +262,9 @@ files:
 - lib/mindee/product/us/driver_license/driver_license_v1.rb
 - lib/mindee/product/us/driver_license/driver_license_v1_document.rb
 - lib/mindee/product/us/driver_license/driver_license_v1_page.rb
+- lib/mindee/product/us/w9/w9_v1.rb
+- lib/mindee/product/us/w9/w9_v1_document.rb
+- lib/mindee/product/us/w9/w9_v1_page.rb
 - lib/mindee/version.rb
 - mindee.gemspec
 homepage: https://github.com/mindee/mindee-api-ruby

data/docs/ruby-api-builder.md

@@ -1,123 +0,0 @@
-The Ruby  OCR SDK supports [custom-built API](https://developers.mindee.com/docs/build-your-first-document-parsing-api) from the API Builder.
-
-If your document isn't covered by one of Mindee's Off-the-Shelf APIs, you can create your own API using the
-[API Builder](https://developers.mindee.com/docs/overview).
-
-For the following examples, we are using our own [W9s custom API](https://developers.mindee.com/docs/w9-forms-ocr),
-created with the [API Builder](https://developers.mindee.com/docs/overview).
-
-> 📘 **Info**
->
-> We used a data model that will be different from yours.
-> To modify this to your own custom API, change the `mindee_client.create_endpoint` call with your own parameters.
-
-```ruby
-require 'mindee'
-
-# Init a new client and configure your custom document
-mindee_client = Mindee::Client.new(api_key: 'my-api-key')
-
-# Create an endpoint for your custom product
-custom_endpoint = mindee_client.create_endpoint(
-  account_name: 'john',
-  endpoint_name: 'wnine',
-  version: '1.1' # optional, if not set, uses the latest version of the model
-)
-```
-
-> **Note:** If the `version` argument is set, you'll be required to update it every time a new model is trained.
-> This is probably not needed for development but essential for production use.
-
-## Parsing Documents
-The client calls the `parse` method when parsing your custom document, which will return an object that you can send to the API.
-If your document is not an OTS API, the document's endpoint must be specified when calling the `parse` method.
-
-```ruby
-mindee_client.parse(
-  input_source,
-  Mindee::Product::Custom::CustomV1,
-  endpoint: custom_endpoint
-)
-
-
-# Print a summary of the document prediction in RST format
-puts result.document
-```
-
-> 📘 **Info**
->
-> If your custom document has the same name as one of the [off-the-shelf APIs](https://developers.mindee.com/docs/what-is-off-the-shelf-api) document,
-> you **must** specify your account name when creating the `create_endpoint` method:
-
-```ruby
-custom_endpoint = mindee_client.create_endpoint(
-  endpoint_name: 'receipt',
-  account_name: 'john'
-)
-```
-
-## Document Fields
-All the fields defined in the API builder when creating your custom document are available.
-
-In custom documents, each field will hold an array of all the words in the document which are related to that field.
-Each word is an object that has the text content, geometry information, and confidence score.
-
-Value fields can be accessed via the `fields` attribute.
-
-Classification fields can be accessed via the `classifications` attribute.
-
-> 📘 **Info**
->
-> Both document level and page level objects work in the same way.
-
-### Fields Attribute
-The `fields` attribute is a hashmap with the following structure:
-
-* key: the API name of the field, as a `symbol`
-* value: a `ListField` object which has a `values` attribute, containing a list of all values found for the field.
-
-Individual field values can be accessed by using the field's API name, in the examples below we'll use the `address` field.
-
-```ruby
-# raw data, list of each word object
-pp result.document.inference.prediction.fields[:address].values
-
-# list of all values
-puts result.document.inference.prediction.fields[:address].contents_list
-
-# default string representation
-puts result.document.inference.prediction.fields[:address].to_s
-
-# custom string representation
-puts result.document.inference.prediction.fields[:address].contents_str(separator: '_')
-```
-
-To iterate over all the fields:
-```ruby
-result.document.inference.prediction.fields.each do |name, info|
-  puts name
-  puts info.values
-end
-```
-
-### Classifications Attribute
-The `classifications` attribute is a hashmap with the following structure:
-
-* key: the API name of the field, as a `symbol`
-* value: a `ClassificationField` object which has a `value` attribute, containing a string representation of the detected classification.
-
-```ruby
-# raw data, list of each word object
-puts result.document.classifications[:doc_type].value
-```
-
-To iterate over all the classifications:
-```ruby
-result.document.classifications.each do |name, info|
-  puts name
-  puts info.value
-end
-```
-
-## Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)