mindee 2.0.0 → 2.1.1

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 document.
+      # @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 document.
+      # @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 supplier's 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 invoice or receipt category among predefined classes.
+      # @return [Mindee::TextField]
+      attr_reader :category
+      # The invoice or 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/passport/passport_v1.rb

@@ -1,19 +1,8 @@
 # frozen_string_literal: true
 
-require 'mrz'
-
 require_relative '../common_fields'
 require_relative '../base'
 
-# We need to do this disgusting thing to avoid the following error message:
-# td3 line one does not match the required format (MRZ::InvalidFormatError)
-#
-# See:
-# https://github.com/streetspotr/mrz/issues/2
-# https://github.com/streetspotr/mrz/pull/3
-#
-MRZ::TD3Parser::FORMAT_ONE = %r{\A(.{2})(.{3})([^<]+)<(.*)\z}.freeze
-
 module Mindee
   module Prediction
     # Passport document.
@@ -78,7 +67,6 @@ module Mindee
         end
         @full_name = construct_full_name(page_id)
         @mrz = construct_mrz(page_id)
-        check_mrz
       end
 
       def to_s
@@ -107,57 +95,6 @@ module Mindee
 
       private
 
-      def check_mrz
-        return if @mrz1.value.nil? || @mrz2.value.nil?
-
-        mrz = MRZ.parse([@mrz1.value, @mrz2.value])
-        checks = {
-          mrz_valid: valid_mrz?(mrz),
-          mrz_valid_birth_date: valid_birth_date?(mrz),
-          mrz_valid_expiry_date: valid_expiry_date?(mrz),
-          mrz_valid_id_number: valid_id_number?(mrz),
-          mrz_valid_surname: valid_surname?(mrz),
-          mrz_valid_country: valid_country?(mrz),
-        }
-        @checklist.merge!(checks)
-      end
-
-      def valid_mrz?(mrz)
-        check = mrz.valid?
-        @mrz.confidence = 1.0 if check
-        check
-      end
-
-      def valid_birth_date?(mrz)
-        check = mrz.valid_birth_date? && mrz.birth_date == @birth_date.date_object
-        @birth_date.confidence = 1.0 if check
-        check
-      end
-
-      def valid_expiry_date?(mrz)
-        check = mrz.valid_expiration_date? && mrz.expiration_date == @expiry_date.date_object
-        @expiry_date.confidence = 1.0 if check
-        check
-      end
-
-      def valid_id_number?(mrz)
-        check = mrz.valid_document_number? && mrz.document_number == @id_number.value
-        @id_number.confidence = 1.0 if check
-        check
-      end
-
-      def valid_surname?(mrz)
-        check = mrz.last_name == @surname.value
-        @surname.confidence = 1.0 if check
-        check
-      end
-
-      def valid_country?(mrz)
-        check = mrz.nationality == @country.value
-        @country.confidence = 1.0 if check
-        check
-      end
-
       def construct_full_name(page_id)
         return unless @surname.value &&
                       !@given_names.empty? &&

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+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.1'
 
   def self.find_platform
     host = RbConfig::CONFIG['host_os']