mindee 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 729bb9b6e8643c95c194583c4c7e217f9cbdc68149a72125767a2191291142be
-  data.tar.gz: cc2233ca32e0fadaf445e731417238b0fa272865f949fd0c91ef61916f86dfb4
+  metadata.gz: 7a4e7590c321e473df6da717d6854caf198ee8dc3d818502d6e588d14497c0da
+  data.tar.gz: b9922d76cbc0115dff59489b9c77757decd69fcfd8a6da445e0a38229cd85023
 SHA512:
-  metadata.gz: 162501228d7fed6ac0829aefcaae88390d43a91cd7b516a837471964b181fe084f9d200e6db447fb4c3b137c3f93ea801661e75ac151a087702143574b8ee9b6
-  data.tar.gz: 960d67e2a53626d3399628b9190972025df886efe50791dc72e5cb0d327f49c99352c66361ff952912b30288c562d3169d2f67ec49a0f8310ed47b40aeedb11d
+  metadata.gz: 01e9dce9c2ba44dea757f1061c4a368b9a675f75d8ab54dd74c06c7c70589aaa80fd320a241c51f618efec9d6ebae8aa9fa033233731e5c214e607464821deb1
+  data.tar.gz: 0467da78b85085e0df6cdae33e6135be4dd1be6c8d28f2c2888127c2340c114b404314f80741f0304aca4d34b19c6462ae8798fcb3936d5f2130860610b4ded3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Mindee Ruby API Library Changelog
 
+## v2.1.0 - 2023-01-30
+### Changes
+* :sparkles: Add financial document v1 support (Co-authored-by: Oriol Gual)
+* :sparkles: Add Proof of Address v1 support
+
 ## v2.0.0 - 2023-01-13
 ### ¡Breaking Changes!
 * :sparkles: add improved PDF merge system

data/bin/mindee.rb

@@ -10,6 +10,14 @@ DOCUMENTS = {
     help: "Custom document type from API builder",
     prediction: Mindee::Prediction::CustomV1,
   },
+  "proof-of-address" => {
+    help: 'Proof of Address',
+    prediction: Mindee::Prediction::ProofOfAddressV1,
+  },
+  "financial-document" => {
+    help: 'Financial Document',
+    prediction: Mindee::Prediction::FinancialDocumentV1,
+  },
   "invoice" => {
     help: 'Invoice',
     prediction: Mindee::Prediction::InvoiceV4,

data/docs/ruby-api-builder.md

@@ -1,34 +1,32 @@
-The Ruby  OCR SDK supports [custom-built API](https://developers.mindee.com/docs/build-your-first-document-parsing-api)
-from the API Builder.
+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)
+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 may be different from yours. To modify this to your own custom API,
-> change the `config_custom_doc` call with your own parameters.
+> We used a data model that will be different from yours.
+> To modify this to your own custom API, change the `add_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', # optional, can be set in environment
-).config_custom_doc(
-  'wsnine',
+mindee_client = Mindee::Client.new(api_key: 'my-api-key').add_endpoint(
   'john',
+  'wnine',
   version: '1.1' # optional, if not set, use the latest version of the model
 )
 
 # Load a file from disk and parse it
-w9_data = mindee_client.doc_from_path('/path/to/file.pdf').parse('wsnine')
+result = mindee_client.doc_from_path('/path/to/file.ext')
+  .parse(Mindee::Prediction::CustomV1, endpoint_name: 'wnine')
 
-# Print a brief summary of the parsed data
-puts w9_data.document.to_s
+# Print a summary of the document prediction in RST format
+puts result
 ```
 
 If the `version` argument is set, you'll be required to update it every time a new model is trained.
@@ -39,7 +37,8 @@ The client calls the `parse` method when parsing your custom document, which wil
 The document type must be specified when calling the parse method.
 
 ```ruby
-result = mindee_client.doc_from_path('/path/to/custom_file').parse('wsnine')
+result = mindee_client.doc_from_path('/path/to/custom_file')
+  .parse(Mindee::Prediction::CustomV1, endpoint_name: 'wnine')
 puts result
 ```
 
@@ -49,13 +48,13 @@ puts result
 > you **must** specify your account name when calling the `parse` method:
 
 ```ruby
-mindee_client = Mindee::Client.new.config_custom_doc(
+mindee_client = Mindee::Client.new.add_endpoint(
   'receipt',
   'john'
 )
 
 result = mindee_client.doc_from_path('/path/to/receipt.jpg')
-  .parse('receipt', username: 'john')
+  .parse(Mindee::Prediction::CustomV1, account_name: 'john')
 ```
 
 ## Document Fields
@@ -64,64 +63,58 @@ All the fields defined in the API builder when creating your custom document are
 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 either via the `fields` attribute, or as their own attributes set at run-time.
+Value fields can be accessed via the `fields` attribute.
 
-Classification fields can be accessed either via the `classifications` attribute, or as their own attributes set at run-time.
+Classification fields can be accessed via the `classifications` attribute.
 
 > 📘 **Info**
 >
 > Both document level and page level objects work in the same way.
 
-### Run-time Attributes
-Individual field values can be accessed simply by using the field's API name, in the examples below we'll use the `address` field.
+### 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
-puts w9_data.document.address.values
+pp result.inference.prediction.fields[:address].values
 
 # list of all values
-puts w9_data.document.address.contents_list
+puts result.inference.prediction.fields[:address].contents_list
 
 # default string representation
-puts w9_data.document.address.to_s
+puts result.inference.prediction.fields[:address].to_s
 
 # custom string representation
-puts w9_data.document.address.contents_str(separator: '_')
+puts result.inference.prediction.fields[:address].contents_str(separator: '_')
 ```
 
-### Fields property
-In addition to accessing a value field directly, it's possible to access it through the `fields` attribute.
-It's 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.
-
-```ruby
-# raw data, list of each word object
-puts w9_data.document.fields[:address].values
-```
-
-This makes it simple to iterate over all the fields:
+To iterate over all the fields:
 ```ruby
-w9_data.document.fields.each do |name, info|
+result.inference.prediction.fields.each do |name, info|
   puts name
   puts info.values
 end
 ```
 
-### Classifications property
-In addition to accessing a classification field directly, it's possible to access it through the `classifications` attribute.
-It's a hashmap with the following structure:
+### 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 w9_data.document.classifications[:doc_type].value
+puts result.document.classifications[:doc_type].value
 ```
 
-This makes it simple to iterate over all the fields:
+To iterate over all the classifications:
 ```ruby
-w9_data.document.classifications.each do |name, info|
+result.document.classifications.each do |name, info|
   puts name
   puts info.value
 end

data/docs/ruby-getting-started.md

@@ -45,7 +45,7 @@ cd mindee-api-ruby
 bundle install
 ```
 
-## Updating the Library
+### Updating the Library
 It is important to always check the version of the Mindee OCR SDK you are using, as new and updated
 features won’t work on older versions.
 

data/docs/ruby-invoice-ocr.md

@@ -19,7 +19,7 @@ puts result.inference.prediction
 ```
 
 Output:
-```shell
+```
 :Locale: en; en; CAD;
 :Document type: INVOICE
 :Invoice number: 14
@@ -48,8 +48,10 @@ Code                   QTY      Price     Amount     Tax (Rate)         Descript
 ====================== ======== ========= ========== ================== ====================================
 ```
 
-**Note:** Line item descriptions are truncated here only for display purposes.
-The full text is available in the [details](#line-items).
+> 📘 **Info**
+>
+> Line item descriptions are truncated here only for display purposes.
+> The full text is available in the [details](#line-items).
 
 ## Fields
 Each prediction object contains a set of different fields.
@@ -91,11 +93,12 @@ puts result.inference.prediction.customer_name.value
 puts result.inference.prediction.customer_address.value
 ```
 
-**`customer_company_registration`** (Array<CompanyRegistration>): Customer's company registration
+**`customer_company_registrations`** (Array<CompanyRegistration>): Customer's company registration
 
 ```ruby
 result.inference.prediction.customer_company_registrations.each do |registration|
-  puts registration
+  puts registration.value
+  puts registration.type
 end
 ```
 
@@ -184,14 +187,10 @@ Each object in the list contains an extra attribute:
 
 * `type` (String): Type of company registration number among predefined categories.
 ```ruby
-# Show the type of the first registration
-puts result.inference.prediction.supplier_company_registrations[0].type
-```
-
-* `value` (String): Value of the company identifier
-```ruby
-# Show the value of the first registration
-puts result.inference.prediction.supplier_company_registrations[0].value
+result.inference.prediction.supplier_company_registrations.each do |registration|
+  puts registration.value
+  puts registration.type
+end
 ```
 
 ### Taxes

data/docs/ruby-passport-ocr.md

@@ -19,7 +19,7 @@ puts result.inference.prediction
 ```
 
 Output:
-```shell
+```
 :Full name: HENERT PUDARSAN
 :Given names: HENERT
 :Surname: PUDARSAN

data/docs/ruby-receipt-ocr.md

@@ -19,7 +19,7 @@ puts result.inference.prediction
 ```
 
 Output:
-```shell
+```
 :Locale: en-US; en; US; USD;
 :Date: 2014-07-07
 :Category: food

data/lib/mindee/client.rb

@@ -23,8 +23,8 @@ module Mindee
     #  API Builder. Do not set for standard (off the shelf) endpoints.
     #
     # @param account_name [String] For custom endpoints, your account or organization username on the API Builder.
-    #  This is normally not required unless you have a custom endpoint which has the
-    #  same name as standard (off the shelf) endpoint.
+    #  This is normally not required unless you have a custom endpoint which has the same name as a
+    #  standard (off the shelf) endpoint.
     #  Do not set for standard (off the shelf) endpoints.
     #
     # @param include_words [Boolean] Whether to include the full text for each page.
@@ -121,7 +121,7 @@ module Mindee
     )
       @doc_configs[[account_name, endpoint_name]] = DocumentConfig.new(
         Prediction::CustomV1,
-        [HTTP::CustomEndpoint.new(account_name, endpoint_name, version, @api_key)]
+        HTTP::CustomEndpoint.new(account_name, endpoint_name, version, @api_key)
       )
       self
     end
@@ -163,42 +163,46 @@ module Mindee
 
     private
 
+    def standard_document_config(prediction_class, endpoint_name, version)
+      DocumentConfig.new(
+        prediction_class,
+        HTTP::StandardEndpoint.new(endpoint_name, version, @api_key)
+      )
+    end
+
     def init_default_endpoints
-      @doc_configs[['mindee', Prediction::InvoiceV4.name]] = DocumentConfig.new(
-        Prediction::InvoiceV4,
-        [HTTP::StandardEndpoint.new('invoices', '4', @api_key)]
+      @doc_configs[['mindee', Prediction::ProofOfAddressV1.name]] = standard_document_config(
+        Prediction::ProofOfAddressV1, 'proof_of_address', '1'
+      )
+      @doc_configs[['mindee', Prediction::FinancialDocumentV1.name]] = standard_document_config(
+        Prediction::FinancialDocumentV1, 'financial_document', '1'
+      )
+      @doc_configs[['mindee', Prediction::InvoiceV4.name]] = standard_document_config(
+        Prediction::InvoiceV4, 'invoices', '4'
       )
-      @doc_configs[['mindee', Prediction::ReceiptV4.name]] = DocumentConfig.new(
-        Prediction::ReceiptV4,
-        [HTTP::StandardEndpoint.new('expense_receipts', '4', @api_key)]
+      @doc_configs[['mindee', Prediction::ReceiptV4.name]] = standard_document_config(
+        Prediction::ReceiptV4, 'expense_receipts', '4'
       )
-      @doc_configs[['mindee', Prediction::PassportV1.name]] = DocumentConfig.new(
-        Prediction::PassportV1,
-        [HTTP::StandardEndpoint.new('passport', '1', @api_key)]
+      @doc_configs[['mindee', Prediction::PassportV1.name]] = standard_document_config(
+        Prediction::PassportV1, 'passport', '1'
       )
-      @doc_configs[['mindee', Prediction::EU::LicensePlateV1.name]] = DocumentConfig.new(
-        Prediction::EU::LicensePlateV1,
-        [HTTP::StandardEndpoint.new('license_plates', '1', @api_key)]
+      @doc_configs[['mindee', Prediction::EU::LicensePlateV1.name]] = standard_document_config(
+        Prediction::EU::LicensePlateV1, 'license_plates', '1'
       )
-      @doc_configs[['mindee', Prediction::ShippingContainerV1.name]] = DocumentConfig.new(
-        Prediction::ShippingContainerV1,
-        [HTTP::StandardEndpoint.new('shipping_containers', '1', @api_key)]
+      @doc_configs[['mindee', Prediction::ShippingContainerV1.name]] = standard_document_config(
+        Prediction::ShippingContainerV1, 'shipping_containers', '1'
       )
-      @doc_configs[['mindee', Prediction::US::BankCheckV1.name]] = DocumentConfig.new(
-        Prediction::US::BankCheckV1,
-        [HTTP::StandardEndpoint.new('bank_check', '1', @api_key)]
+      @doc_configs[['mindee', Prediction::US::BankCheckV1.name]] = standard_document_config(
+        Prediction::US::BankCheckV1, 'bank_check', '1'
       )
-      @doc_configs[['mindee', Prediction::FR::BankAccountDetailsV1.name]] = DocumentConfig.new(
-        Prediction::FR::BankAccountDetailsV1,
-        [HTTP::StandardEndpoint.new('bank_account_details', '1', @api_key)]
+      @doc_configs[['mindee', Prediction::FR::BankAccountDetailsV1.name]] = standard_document_config(
+        Prediction::FR::BankAccountDetailsV1, 'bank_account_details', '1'
       )
-      @doc_configs[['mindee', Prediction::FR::CarteVitaleV1.name]] = DocumentConfig.new(
-        Prediction::FR::CarteVitaleV1,
-        [HTTP::StandardEndpoint.new('carte_vitale', '1', @api_key)]
+      @doc_configs[['mindee', Prediction::FR::CarteVitaleV1.name]] = standard_document_config(
+        Prediction::FR::CarteVitaleV1, 'carte_vitale', '1'
       )
-      @doc_configs[['mindee', Prediction::FR::IdCardV1.name]] = DocumentConfig.new(
-        Prediction::FR::IdCardV1,
-        [HTTP::StandardEndpoint.new('idcard_fr', '1', @api_key)]
+      @doc_configs[['mindee', Prediction::FR::IdCardV1.name]] = standard_document_config(
+        Prediction::FR::IdCardV1, 'idcard_fr', '1'
       )
       self
     end

data/lib/mindee/document_config.rb

@@ -11,14 +11,14 @@ module Mindee
   # Specific client for sending a document to the API.
   class DocumentConfig
     # Array of possible Mindee::Endpoint to be used.
-    # @return [Array<Mindee::HTTP::Endpoint>]
-    attr_reader :endpoints
+    # @return [Mindee::HTTP::Endpoint]
+    attr_reader :endpoint
 
     # @param prediction_class [Class<Mindee::Prediction::Prediction>]
-    # @param endpoints [Array<Mindee::HTTP::Endpoint>]
-    def initialize(prediction_class, endpoints)
+    # @param endpoint [Mindee::HTTP::Endpoint]
+    def initialize(prediction_class, endpoint)
       @prediction_class = prediction_class
-      @endpoints = endpoints
+      @endpoint = endpoint
     end
 
     # Call the prediction API.
@@ -28,16 +28,8 @@ module Mindee
     # @param cropper [Boolean]
     # @return [Mindee::DocumentResponse]
     def predict(input_doc, include_words, close_file, cropper)
-      check_api_keys
+      check_api_key
       response = predict_request(input_doc, include_words, close_file, cropper)
-      parse_response(response)
-    end
-
-    private
-
-    # @param response [Net::HTTPResponse]
-    # @return [Mindee::DocumentResponse]
-    def parse_response(response)
       hashed_response = JSON.parse(response.body, object_class: Hash)
       return Document.new(@prediction_class, hashed_response['document']) if (200..299).include?(response.code.to_i)
 
@@ -45,24 +37,24 @@ module Mindee
       raise error
     end
 
+    private
+
     # @param input_doc [Mindee::InputDocument]
     # @param include_words [Boolean]
     # @param close_file [Boolean]
     # # @param cropper [Boolean]
     # @return [Net::HTTPResponse]
     def predict_request(input_doc, include_words, close_file, cropper)
-      @endpoints[0].predict_req_post(input_doc, include_words: include_words, close_file: close_file, cropper: cropper)
+      @endpoint.predict_req_post(input_doc, include_words: include_words, close_file: close_file, cropper: cropper)
     end
 
-    def check_api_keys
-      @endpoints.each do |endpoint|
-        next unless endpoint.api_key.nil? || endpoint.api_key.empty?
+    def check_api_key
+      return unless @endpoint.api_key.nil? || @endpoint.api_key.empty?
 
-        raise "Missing API key for '#{@document_type}', " \
-              "check your Client Configuration.\n" \
-              'You can set this using the ' \
-              "'#{HTTP::API_KEY_ENV_NAME}' environment variable."
-      end
+      raise "Missing API key for '#{@document_type}', " \
+            "check your Client Configuration.\n" \
+            'You can set this using the ' \
+            "'#{HTTP::API_KEY_ENV_NAME}' environment variable."
     end
   end
 end

data/lib/mindee/parsing/prediction/financial_document/financial_document_v1.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+require_relative '../common_fields'
+require_relative '../base'
+require_relative 'invoice_line_item'
+
+module Mindee
+  module Prediction
+    # Invoice document.
+    class FinancialDocumentV1 < Prediction
+      # Locale information.
+      # @return [Mindee::Locale]
+      attr_reader :locale
+      # The nature of the invoice.
+      # @return [Mindee::TextField]
+      attr_reader :document_type
+      # The total amount with tax included.
+      # @return [Mindee::AmountField]
+      attr_reader :total_amount
+      # The total amount without the tax value.
+      # @return [Mindee::AmountField]
+      attr_reader :total_net
+      # The total tax.
+      # @return [Mindee::AmountField]
+      attr_reader :total_tax
+      # The creation date of the invoice.
+      # @return [Mindee::DateField]
+      attr_reader :date
+      # The invoice number.
+      # @return [Mindee::TextField]
+      attr_reader :invoice_number
+      # List of Reference numbers including PO number.
+      # @return [Mindee::TextField]
+      attr_reader :reference_numbers
+      # The due date of the invoice.
+      # @return [Mindee::DateField]
+      attr_reader :due_date
+      # The list of taxes.
+      # @return [Array<Mindee::TaxField>]
+      attr_reader :taxes
+      # The name of the customer.
+      # @return [Mindee::TextField]
+      attr_reader :customer_name
+      # The address of the customer.
+      # @return [Mindee::TextField]
+      attr_reader :customer_address
+      # The company registration information for the customer.
+      # @return [Array<Mindee::CompanyRegistration>]
+      attr_reader :customer_company_registrations
+      # The supplier's name.
+      # @return [Mindee::TextField]
+      attr_reader :supplier_name
+      # The supplier's address.
+      # @return [Mindee::TextField]
+      attr_reader :supplier_address
+      # The payment information.
+      # @return [Array<Mindee::PaymentDetails>]
+      attr_reader :supplier_payment_details
+      # The supplier's company registration information.
+      # @return [Array<Mindee::CompanyRegistration>]
+      attr_reader :supplier_company_registrations
+      # Line items details.
+      # @return [Array<Mindee::InvoiceLineItem>]
+      attr_reader :line_items
+      # Time as seen on the receipt in HH:MM format.
+      # @return [Mindee::TextField]
+      attr_reader :time
+      # The receipt category among predefined classes.
+      # @return [Mindee::TextField]
+      attr_reader :category
+      # The receipt sub-category among predefined classes.
+      # @return [Mindee::TextField]
+      attr_reader :subcategory
+      # A classification field, that can return 4 values : 'EXPENSE RECEIPT' ,
+      # 'CREDIT CARD RECEIPT', 'INVOICE', 'CREDIT NOTE'
+      # @return [Mindee::TextField]
+      attr_reader :document_type # rubocop:todo Lint/DuplicateMethods
+      # Total amount of tip and gratuity. Both typed and handwritten characters are supported.
+      # @return [Mindee::AmountField]
+      attr_reader :tip
+
+      # @param prediction [Hash]
+      # @param page_id [Integer, nil]
+      def initialize(prediction, page_id) # rubocop:todo Metrics/AbcSize
+        super
+
+        @time = TextField.new(prediction['time'], page_id)
+        @category = TextField.new(prediction['category'], page_id)
+        @subcategory = TextField.new(prediction['subcategory'], page_id)
+        @document_type = TextField.new(prediction['document_type'], page_id)
+        @tip = AmountField.new(prediction['tip'], page_id)
+        @locale = Locale.new(prediction['locale'])
+        @document_type = TextField.new(prediction['document_type'], page_id)
+        @total_amount = AmountField.new(prediction['total_amount'], page_id)
+        @total_net = AmountField.new(prediction['total_net'], page_id)
+        @customer_address = TextField.new(prediction['customer_address'], page_id)
+        @customer_name = TextField.new(prediction['customer_name'], page_id)
+        @date = DateField.new(prediction['date'], page_id)
+        @due_date = DateField.new(prediction['due_date'], page_id)
+        @invoice_number = TextField.new(prediction['invoice_number'], page_id)
+        @supplier_name = TextField.new(prediction['supplier_name'], page_id)
+        @supplier_address = TextField.new(prediction['supplier_address'], page_id)
+
+        @reference_numbers = []
+        prediction['reference_numbers'].each do |item|
+          @reference_numbers.push(TextField.new(item, page_id))
+        end
+        @customer_company_registrations = []
+        prediction['customer_company_registrations'].each do |item|
+          @customer_company_registrations.push(CompanyRegistration.new(item, page_id))
+        end
+        @taxes = []
+        prediction['taxes'].each do |item|
+          @taxes.push(TaxField.new(item, page_id))
+        end
+        @supplier_payment_details = []
+        prediction['supplier_payment_details'].each do |item|
+          @supplier_payment_details.push(PaymentDetails.new(item, page_id))
+        end
+        @supplier_company_registrations = []
+        prediction['supplier_company_registrations'].each do |item|
+          @supplier_company_registrations.push(CompanyRegistration.new(item, page_id))
+        end
+
+        @total_tax = AmountField.new(
+          { value: nil, confidence: 0.0 }, page_id
+        )
+
+        @line_items = []
+        prediction['line_items'].each do |item|
+          @line_items.push(InvoiceLineItem.new(item, page_id))
+        end
+        reconstruct(page_id)
+      end
+
+      def to_s
+        customer_company_registrations = @customer_company_registrations.map(&:value).join('; ')
+        supplier_payment_details = @supplier_payment_details.map(&:to_s).join("\n                 ")
+        supplier_company_registrations = @supplier_company_registrations.map(&:to_s).join('; ')
+        reference_numbers = @reference_numbers.map(&:to_s).join(', ')
+        taxes = @taxes.join("\n       ")
+        out_str = String.new
+        out_str << "\n:Document type: #{@document_type}".rstrip
+        out_str << "\n:Category: #{@category}".rstrip
+        out_str << "\n:Subcategory: #{@subcategory}".rstrip
+        out_str << "\n:Locale: #{@locale}".rstrip
+        out_str << "\n:Date: #{@date}".rstrip
+        out_str << "\n:Due date: #{@due_date}".rstrip
+        out_str << "\n:Time: #{@time}".rstrip
+        out_str << "\n:Number: #{@invoice_number}".rstrip
+        out_str << "\n:Reference numbers: #{reference_numbers}".rstrip
+        out_str << "\n:Supplier name: #{@supplier_name}".rstrip
+        out_str << "\n:Supplier address: #{@supplier_address}".rstrip
+        out_str << "\n:Supplier company registrations: #{supplier_company_registrations}".rstrip
+        out_str << "\n:Supplier payment details: #{supplier_payment_details}".rstrip
+
+        out_str << "\n:Customer name: #{@customer_name}".rstrip
+        out_str << "\n:Customer address: #{@customer_address}".rstrip
+        out_str << "\n:Customer company registrations: #{customer_company_registrations}".rstrip
+
+        out_str << "\n:Tip: #{@tip}".rstrip
+
+        out_str << "\n:Taxes: #{taxes}".rstrip
+        out_str << "\n:Total taxes: #{@total_tax}".rstrip
+        out_str << "\n:Total net: #{@total_net}".rstrip
+        out_str << "\n:Total amount: #{@total_amount}".rstrip
+
+        out_str << line_items_to_s
+
+        out_str[1..].to_s
+      end
+
+      private
+
+      def line_items_to_s
+        line_item_separator = "#{'=' * 22} #{'=' * 8} #{'=' * 9} #{'=' * 10} #{'=' * 18} #{'=' * 36}"
+        line_items = @line_items.map(&:to_s).join("\n")
+
+        out_str = String.new
+        out_str << "\n\n:Line Items:"
+
+        return out_str if line_items.empty?
+
+        out_str << "\n#{line_item_separator}"
+        out_str << "\nCode                   QTY      Price     Amount     Tax (Rate)         Description"
+        out_str << "\n#{line_item_separator}"
+        out_str << "\n#{line_items}"
+        out_str << "\n#{line_item_separator}"
+      end
+
+      def reconstruct(page_id)
+        construct_total_tax_from_taxes(page_id)
+        return unless page_id.nil?
+
+        construct_total_excl_from_tcc_and_taxes(page_id)
+        construct_total_incl_from_taxes_plus_excl(page_id)
+        construct_total_tax_from_totals(page_id)
+      end
+
+      def construct_total_excl_from_tcc_and_taxes(page_id)
+        return if @total_amount.value.nil? || taxes.empty? || !@total_net.value.nil?
+
+        total_excl = {
+          'value' => @total_amount.value - @taxes.map(&:value).sum,
+          'confidence' => TextField.array_confidence(@taxes) * @total_amount.confidence,
+        }
+        @total_net = AmountField.new(total_excl, page_id, reconstructed: true)
+      end
+
+      def construct_total_incl_from_taxes_plus_excl(page_id)
+        return if @total_net.value.nil? || @taxes.empty? || !@total_amount.value.nil?
+
+        total_incl = {
+          'value' => @taxes.map(&:value).sum + @total_net.value,
+          'confidence' => TextField.array_confidence(@taxes) * @total_net.confidence,
+        }
+        @total_amount = AmountField.new(total_incl, page_id, reconstructed: true)
+      end
+
+      def construct_total_tax_from_taxes(page_id)
+        return if @taxes.empty?
+
+        total_tax = {
+          'value' => @taxes.map(&:value).sum,
+          'confidence' => TextField.array_confidence(@taxes),
+        }
+        return unless total_tax['value'].positive?
+
+        @total_tax = AmountField.new(total_tax, page_id, reconstructed: true)
+      end
+
+      def construct_total_tax_from_totals(page_id)
+        return if !@total_tax.value.nil? || @total_amount.value.nil? || @total_net.value.nil?
+
+        total_tax = {
+          'value' => @total_amount.value - @total_net.value,
+          'confidence' => TextField.array_confidence(@taxes),
+        }
+        return unless total_tax['value'] >= 0
+
+        @total_tax = AmountField.new(total_tax, page_id, reconstructed: true)
+      end
+    end
+  end
+end

data/lib/mindee/parsing/prediction/financial_document/invoice_line_item.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../common_fields/base'
+
+module Mindee
+  # Line items for invoices
+  class InvoiceLineItem
+    # @return [String] The product code referring to the item.
+    attr_reader :product_code
+    # @return [String]
+    attr_reader :description
+    # @return [Float]
+    attr_reader :quantity
+    # @return [Float]
+    attr_reader :unit_price
+    # @return [Float]
+    attr_reader :total_amount
+    # @return [Float] The item tax rate percentage.
+    attr_reader :tax_rate
+    # @return [Float]
+    attr_reader :tax_amount
+    # @return [Float]
+    attr_reader :confidence
+    # @return [Integer]
+    attr_reader :page_id
+    # @return [Mindee::Geometry::Quadrilateral]
+    attr_reader :bounding_box
+    # @return [Array<Mindee::Geometry::Polygon>]
+    attr_reader :polygon
+
+    def initialize(prediction, page_id)
+      @product_code = prediction['product_code']
+      @quantity = prediction['quantity']
+      @unit_price = prediction['unit_price']
+      @total_amount = prediction['total_amount']
+      @tax_amount = prediction['tax_amount']
+      @tax_rate = prediction['tax_rate']
+      @description = prediction['description']
+      @page_id = page_id
+    end
+
+    def to_s
+      tax = Field.float_to_string(@tax_amount)
+      tax << " (#{Field.float_to_string(@tax_rate)}%)" unless @tax_rate.nil?
+
+      description = @description.nil? ? '' : @description
+      description = "#{description[0..32]}..." if description.size > 35
+
+      out_str = String.new
+      out_str << format('%- 22s', @product_code)
+      out_str << " #{format('%- 8s', Field.float_to_string(@quantity))}"
+      out_str << " #{format('%- 9s', Field.float_to_string(@unit_price))}"
+      out_str << " #{format('%- 10s', Field.float_to_string(@total_amount))}"
+      out_str << " #{format('%- 18s', tax)}"
+      out_str << " #{description}"
+    end
+  end
+end

data/lib/mindee/parsing/prediction/proof_of_address/proof_of_address_v1.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'mrz'
+
+require_relative '../common_fields'
+require_relative '../base'
+
+module Mindee
+  module Prediction
+    # Passport document.
+    class ProofOfAddressV1 < Prediction
+      # ISO 639-1 code, works best with ca, de, en, es, fr, it, nl and pt.
+      # @return [Mindee::Locale]
+      attr_reader :locale
+      # ISO date yyyy-mm-dd. Works both for European and US dates.
+      # @return [Mindee::DateField]
+      attr_reader :date
+      # All extracted ISO date yyyy-mm-dd. Works both for European and US dates.
+      # @return [Array<Mindee::DateField>]
+      attr_reader :dates
+      # Address of the document's issuer.
+      # @return [Mindee::TextField]
+      attr_reader :issuer_address
+      # Generic: VAT NUMBER, TAX ID, COMPANY REGISTRATION NUMBER or country specific.
+      # @return [Array<Mindee::CompanyRegistration>]
+      attr_reader :issuer_company_registration
+      # Name of the person or company issuing the document.
+      # @return [Mindee::TextField]
+      attr_reader :issuer_name
+      # Address of the recipient.
+      # @return [Mindee::TextField]
+      attr_reader :recipient_address
+      # Generic: VAT NUMBER, TAX ID, COMPANY REGISTRATION NUMBER or country specific.
+      # @return [Array<Mindee::CompanyRegistration>]
+      attr_reader :recipient_company_registration
+      # Name of the document's recipient.
+      # @return [Mindee::TextField]
+      attr_reader :recipient_name
+
+      # @param prediction [Hash]
+      # @param page_id [Integer, nil]
+      def initialize(prediction, page_id)
+        super
+        @locale = Locale.new(prediction['locale'])
+        @date = DateField.new(prediction['date'], page_id)
+        @dates = []
+        prediction['dates'].each do |item|
+          @dates.push(DateField.new(item, page_id))
+        end
+        @issuer_name = TextField.new(prediction['issuer_name'], page_id)
+        @issuer_address = TextField.new(prediction['issuer_address'], page_id)
+        @issuer_company_registration = []
+        prediction['issuer_company_registration'].each do |item|
+          @issuer_company_registration.push(CompanyRegistration.new(item, page_id))
+        end
+        @recipient_name = TextField.new(prediction['recipient_name'], page_id)
+        @recipient_address = TextField.new(prediction['recipient_address'], page_id)
+        @recipient_company_registration = []
+        prediction['recipient_company_registration'].each do |item|
+          @recipient_company_registration.push(CompanyRegistration.new(item, page_id))
+        end
+      end
+
+      def to_s
+        recipient_company_registrations = @recipient_company_registration.join(' ')
+        issuer_company_registrations = @issuer_company_registration.join(' ')
+        dates = @dates.join("\n        ")
+        out_str = String.new
+        out_str << "\n:Locale: #{@locale}".rstrip
+        out_str << "\n:Issuer name: #{@issuer_name}".rstrip
+        out_str << "\n:Issuer Address: #{@issuer_address}".rstrip
+        out_str << "\n:Issuer Company Registrations: #{issuer_company_registrations}".rstrip
+        out_str << "\n:Recipient name: #{@recipient_name}".rstrip
+        out_str << "\n:Recipient Address: #{@recipient_address}".rstrip
+        out_str << "\n:Recipient Company Registrations: #{recipient_company_registrations}".rstrip
+        out_str << "\n:Issuance date: #{@date}".rstrip
+        out_str << "\n:Dates: #{dates}".rstrip
+        out_str[1..].to_s
+      end
+    end
+  end
+end

data/lib/mindee/parsing/prediction/receipt/receipt_v4.rb

@@ -40,6 +40,9 @@ module Mindee
       # Whether the document is an expense receipt or a credit card receipt.
       # @return [Mindee::TextField]
       attr_reader :document_type
+      # Total amount of tip and gratuity. Both typed and handwritten characters are supported.
+      # @return [Mindee::AmountField]
+      attr_reader :tip
 
       # @param prediction [Hash]
       # @param page_id [Integer, nil]

data/lib/mindee/parsing/prediction.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'prediction/custom/custom_v1'
+require_relative 'prediction/proof_of_address/proof_of_address_v1'
+require_relative 'prediction/financial_document/financial_document_v1'
 require_relative 'prediction/invoice/invoice_v4'
 require_relative 'prediction/passport/passport_v1'
 require_relative 'prediction/receipt/receipt_v4'

data/lib/mindee/version.rb

@@ -2,7 +2,7 @@
 
 # Mindee
 module Mindee
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 
   def self.find_platform
     host = RbConfig::CONFIG['host_os']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -164,12 +164,15 @@ files:
 - lib/mindee/parsing/prediction/custom/custom_v1.rb
 - lib/mindee/parsing/prediction/custom/fields.rb
 - lib/mindee/parsing/prediction/eu/license_plate/license_plate_v1.rb
+- lib/mindee/parsing/prediction/financial_document/financial_document_v1.rb
+- lib/mindee/parsing/prediction/financial_document/invoice_line_item.rb
 - lib/mindee/parsing/prediction/fr/bank_account_details/bank_account_details_v1.rb
 - lib/mindee/parsing/prediction/fr/carte_vitale/carte_vitale_v1.rb
 - lib/mindee/parsing/prediction/fr/id_card/id_card_v1.rb
 - lib/mindee/parsing/prediction/invoice/invoice_line_item.rb
 - lib/mindee/parsing/prediction/invoice/invoice_v4.rb
 - lib/mindee/parsing/prediction/passport/passport_v1.rb
+- lib/mindee/parsing/prediction/proof_of_address/proof_of_address_v1.rb
 - lib/mindee/parsing/prediction/receipt/receipt_v4.rb
 - lib/mindee/parsing/prediction/shipping_container/shipping_container_v1.rb
 - lib/mindee/parsing/prediction/us/bank_check/bank_check_v1.rb