mindee 2.2.0 → 3.0.0

data/lib/mindee/parsing/prediction/custom/fields.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  # Document classification (custom docs)
-  class ClassificationField
-    # The classification value
-    # @return [String]
-    attr_reader :value
-    # The confidence score, value will be between 0.0 and 1.0
-    # @return [Float]
-    attr_accessor :confidence
-
-    # @param prediction [Hash]
-    def initialize(prediction)
-      @value = prediction['value']
-      @confidence = prediction['confidence']
-    end
-
-    def to_s
-      @value
-    end
-  end
-
-  # Field in a list.
-  class ListFieldItem
-    # The confidence score, value will be between 0.0 and 1.0
-    # @return [Float]
-    attr_accessor :confidence
-    # @return [Mindee::Geometry::Quadrilateral]
-    attr_reader :bounding_box
-    # @return [Mindee::Geometry::Polygon]
-    attr_reader :polygon
-    attr_reader :content
-
-    # @param prediction [Hash]
-    def initialize(prediction)
-      @content = prediction['content']
-      @confidence = prediction['confidence']
-      @polygon = Geometry.polygon_from_prediction(prediction['polygon'])
-      @bounding_box = Geometry.get_bounding_box(@polygon) unless @polygon.nil? || @polygon.empty?
-    end
-
-    # @return [String]
-    def to_s
-      @content.to_s
-    end
-  end
-
-  # Field where actual values are kept in a list (custom docs).
-  class ListField
-    # @return [Array<Mindee::ListFieldItem>]
-    attr_reader :values
-    # @return [Integer, nil]
-    attr_reader :page_id
-    # true if the field was reconstructed or computed using other fields.
-    # @return [Boolean]
-    attr_reader :reconstructed
-    # The confidence score, value will be between 0.0 and 1.0
-    # @return [Float]
-    attr_accessor :confidence
-
-    # @param prediction [Hash]
-    # @param page_id [Integer, nil]
-    # @param reconstructed [Boolean]
-    def initialize(prediction, page_id, reconstructed: false)
-      @values = []
-      @confidence = prediction['confidence']
-      @page_id = page_id || prediction['page_id']
-      @reconstructed = reconstructed
-
-      prediction['values'].each do |field|
-        @values.push(ListFieldItem.new(field))
-      end
-    end
-
-    # @return [Array]
-    def contents_list
-      @values.map(&:content)
-    end
-
-    # @return [String]
-    def contents_str(separator: ' ')
-      @values.map(&:to_s).join(separator)
-    end
-
-    # @return [String]
-    def to_s
-      contents_str(separator: ' ')
-    end
-  end
-end

data/lib/mindee/parsing/prediction/eu/license_plate/license_plate_v1.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../common_fields'
-require_relative '../../base'
-
-module Mindee
-  module Prediction
-    module EU
-      # License Plate v1 prediction results.
-      class LicensePlateV1 < Prediction
-        # List of all license plates found in the image.
-        # @return [Array<Mindee::TextField>]
-        attr_reader :license_plates
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @license_plates = []
-          prediction['license_plates'].each do |item|
-            @license_plates.push(TextField.new(item, page_id))
-          end
-        end
-
-        def to_s
-          license_plates = @license_plates.join("\n #{' ' * 16}")
-          out_str = String.new
-          out_str << "\n:License Plates: #{license_plates}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,237 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields'
-require_relative '../base'
-require_relative 'financial_document_v1_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::FinancialDocumentV1LineItem>]
-      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(FinancialDocumentV1LineItem.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 << "\n:Line Items:"
-        out_str << line_items_to_s
-        out_str[1..].to_s
-      end
-
-      private
-
-      def line_item_separator(char)
-        "  +#{char * 22}+#{char * 9}+#{char * 9}+#{char * 10}+#{char * 18}+#{char * 38}+"
-      end
-
-      def line_items_to_s
-        return '' if @line_items.empty?
-
-        line_items = @line_items.map(&:to_s).join("\n#{line_item_separator('-')}\n  ")
-        out_str = String.new
-        out_str << "\n#{line_item_separator('-')}"
-        out_str << "\n  | Code#{' ' * 17}| QTY     | Price   | Amount   | Tax (Rate)       | Description#{' ' * 26}|"
-        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/financial_document_v1_line_item.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields/base'
-
-module Mindee
-  # Line items for invoices
-  class FinancialDocumentV1LineItem
-    # @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
-
-    # @return String
-    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('| %- 20s', @product_code)
-      out_str << " #{format('| %- 7s', Field.float_to_string(@quantity))}"
-      out_str << " #{format('| %- 7s', Field.float_to_string(@unit_price))}"
-      out_str << " #{format('| %- 8s', Field.float_to_string(@total_amount))}"
-      out_str << " #{format('| %- 16s', tax)}"
-      out_str << " #{format('| %- 37s', description)}"
-      out_str << '|'
-    end
-  end
-end

data/lib/mindee/parsing/prediction/fr/bank_account_details/bank_account_details_v1.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../common_fields'
-require_relative '../../base'
-
-module Mindee
-  module Prediction
-    module FR
-      # Bank Account Details v1 prediction results.
-      class BankAccountDetailsV1 < Prediction
-        # The International Bank Account Number (IBAN).
-        # @return [Mindee::TextField]
-        attr_reader :iban
-        # The name of the account holder as seen on the document.
-        # @return [Mindee::TextField]
-        attr_reader :account_holder_name
-        # The bank's SWIFT Business Identifier Code (BIC).
-        # @return [Mindee::TextField]
-        attr_reader :swift
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @iban = TextField.new(prediction['iban'], page_id)
-          @account_holder_name = TextField.new(prediction['account_holder_name'], page_id)
-          @swift = TextField.new(prediction['swift'], page_id)
-        end
-
-        def to_s
-          out_str = String.new
-          out_str << "\n:IBAN: #{@iban}".rstrip
-          out_str << "\n:Account Holder's Name: #{@account_holder_name}".rstrip
-          out_str << "\n:SWIFT Code: #{@swift}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end

data/lib/mindee/parsing/prediction/fr/carte_vitale/carte_vitale_v1.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../common_fields'
-require_relative '../../base'
-
-module Mindee
-  module Prediction
-    module FR
-      # Carte Vitale v1 prediction results.
-      class CarteVitaleV1 < Prediction
-        # The given name(s) of the card holder.
-        # @return [Array<Mindee::TextField>]
-        attr_reader :given_names
-        # The surname of the card holder.
-        # @return [Mindee::TextField]
-        attr_reader :surname
-        # The Social Security Number (Numéro de Sécurité Sociale) of the card holder
-        # @return [Mindee::TextField]
-        attr_reader :social_security
-        # The date the card was issued.
-        # @return [Mindee::DateField]
-        attr_reader :issuance_date
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @given_names = []
-          prediction['given_names'].each do |item|
-            @given_names.push(TextField.new(item, page_id))
-          end
-          @surname = TextField.new(prediction['surname'], page_id)
-          @social_security = TextField.new(prediction['social_security'], page_id)
-          @issuance_date = DateField.new(prediction['issuance_date'], page_id)
-        end
-
-        def to_s
-          given_names = @given_names.join("\n #{' ' * 15}")
-          out_str = String.new
-          out_str << "\n:Given Name(s): #{given_names}".rstrip
-          out_str << "\n:Surname: #{@surname}".rstrip
-          out_str << "\n:Social Security Number: #{@social_security}".rstrip
-          out_str << "\n:Issuance Date: #{@issuance_date}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end