mindee 2.2.0 → 3.0.0

data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1_document.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module CarteVitale
+        # Carte Vitale V1 document prediction.
+        class CarteVitaleV1Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The given name(s) of the card holder.
+          # @return [Array<Mindee::Parsing::Standard::TextField>]
+          attr_reader :given_names
+          # The date the card was issued.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :issuance_date
+          # The Social Security Number (Numéro de Sécurité Sociale) of the card holder
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :social_security
+          # The surname of the card holder.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :surname
+
+          # @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
+            @issuance_date = DateField.new(prediction['issuance_date'], page_id)
+            @social_security = TextField.new(prediction['social_security'], page_id)
+            @surname = TextField.new(prediction['surname'], page_id)
+          end
+
+          # @return [String]
+          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
+end

data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1_page.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'carte_vitale_v1_document'
+
+module Mindee
+  module Product
+    module FR
+      module CarteVitale
+        # Carte Vitale V1 page.
+        class CarteVitaleV1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = CarteVitaleV1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Carte Vitale V1 page prediction.
+        class CarteVitaleV1PagePrediction < CarteVitaleV1Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/id_card/id_card_v1.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v1_document'
+require_relative 'id_card_v1_page'
+
+module Mindee
+  module Product
+    module FR
+      module IdCard
+        # Carte Nationale d'Identité V1 prediction inference.
+        class IdCardV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'idcard_fr'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = IdCardV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(IdCardV1Page.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/fr/id_card/id_card_v1_document.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module IdCard
+        # Carte Nationale d'Identité V1 document prediction.
+        class IdCardV1Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The name of the issuing authority.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :authority
+          # The date of birth of the card holder.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :birth_date
+          # The place of birth of the card holder.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :birth_place
+          # The expiry date of the identification card.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :expiry_date
+          # The gender of the card holder.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :gender
+          # The given name(s) of the card holder.
+          # @return [Array<Mindee::Parsing::Standard::TextField>]
+          attr_reader :given_names
+          # The identification card number.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :id_number
+          # Machine Readable Zone, first line
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :mrz1
+          # Machine Readable Zone, second line
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :mrz2
+          # The surname of the card holder.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :surname
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @authority = TextField.new(prediction['authority'], page_id)
+            @birth_date = DateField.new(prediction['birth_date'], page_id)
+            @birth_place = TextField.new(prediction['birth_place'], page_id)
+            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+            @gender = TextField.new(prediction['gender'], page_id)
+            @given_names = []
+            prediction['given_names'].each do |item|
+              @given_names.push(TextField.new(item, page_id))
+            end
+            @id_number = TextField.new(prediction['id_number'], page_id)
+            @mrz1 = TextField.new(prediction['mrz1'], page_id)
+            @mrz2 = TextField.new(prediction['mrz2'], page_id)
+            @surname = TextField.new(prediction['surname'], page_id)
+          end
+
+          # @return [String]
+          def to_s
+            given_names = @given_names.join("\n #{' ' * 15}")
+            out_str = String.new
+            out_str << "\n:Identity Number: #{@id_number}".rstrip
+            out_str << "\n:Given Name(s): #{given_names}".rstrip
+            out_str << "\n:Surname: #{@surname}".rstrip
+            out_str << "\n:Date of Birth: #{@birth_date}".rstrip
+            out_str << "\n:Place of Birth: #{@birth_place}".rstrip
+            out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+            out_str << "\n:Issuing Authority: #{@authority}".rstrip
+            out_str << "\n:Gender: #{@gender}".rstrip
+            out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
+            out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
+            out_str[1..].to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/id_card/id_card_v1_page.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v1_document'
+
+module Mindee
+  module Product
+    module FR
+      module IdCard
+        # Carte Nationale d'Identité V1 page.
+        class IdCardV1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = IdCardV1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Carte Nationale d'Identité V1 page prediction.
+        class IdCardV1PagePrediction < IdCardV1Document
+          include Mindee::Parsing::Standard
+
+          # The side of the document which is visible.
+          # @return [Mindee::Parsing::Standard::ClassificationField]
+          attr_reader :document_side
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            @document_side = ClassificationField.new(prediction['document_side'], page_id)
+            super(prediction, page_id)
+          end
+
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n:Document Side: #{@document_side}".rstrip
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/invoice/invoice_v4.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_v4_document'
+require_relative 'invoice_v4_page'
+
+module Mindee
+  module Product
+    module Invoice
+      # Invoice document.
+      class InvoiceV4 < Mindee::Parsing::Common::Inference
+        include Mindee::Parsing::Common
+        @endpoint_name = 'invoices'
+        @endpoint_version = '4'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = InvoiceV4Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            @pages.push(InvoiceV4Page.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

data/lib/mindee/product/invoice/invoice_v4_document.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_v4_line_item'
+
+module Mindee
+  module Product
+    module Invoice
+      # Invoice V4 document prediction.
+      class InvoiceV4Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+
+        # Locale information.
+        # @return [Mindee::Parsing::Standard::Locale]
+        attr_reader :locale
+        # The nature of the invoice.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :document_type
+        # The total amount with tax included.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_amount
+        # The total amount without the tax value.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_net
+        # The total tax.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_tax
+        # The creation date of the invoice.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :date
+        # The invoice number.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :invoice_number
+        # List of Reference numbers including PO number.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :reference_numbers
+        # The due date of the invoice.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :due_date
+        # The list of taxes.
+        # @return [Mindee::Parsing::Standard::Taxes]
+        attr_reader :taxes
+        # The name of the customer.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :customer_name
+        # The address of the customer.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :customer_address
+        # The company registration information for the customer.
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        attr_reader :customer_company_registrations
+        # The supplier's name.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :supplier_name
+        # The supplier's address.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :supplier_address
+        # The payment information.
+        # @return [Array<Mindee::Parsing::Standard::PaymentDetails>]
+        attr_reader :supplier_payment_details
+        # The supplier's company registration information.
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        attr_reader :supplier_company_registrations
+        # Line items details.
+        # @return [Array<Mindee::InvoiceV4LineItem>]
+        attr_reader :line_items
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @locale = Locale.new(prediction['locale'])
+          @document_type = ClassificationField.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 = Taxes.new(prediction['taxes'], page_id)
+          @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(InvoiceV4LineItem.new(item, page_id))
+          end
+          reconstruct(page_id)
+        end
+
+        # @return [String]
+        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(', ')
+          out_str = String.new
+          out_str << "\n:Locale: #{@locale}".rstrip
+          out_str << "\n:Document type: #{@document_type}".rstrip
+          out_str << "\n:Invoice number: #{@invoice_number}".rstrip
+          out_str << "\n:Reference numbers: #{reference_numbers}".rstrip
+          out_str << "\n:Invoice date: #{@date}".rstrip
+          out_str << "\n:Invoice due date: #{@due_date}".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:Taxes:#{@taxes}".rstrip
+          out_str << "\n:Total net: #{@total_net}".rstrip
+          out_str << "\n:Total tax: #{@total_tax}".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 #{' ' * 25}|"
+          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
+end

data/lib/mindee/product/invoice/invoice_v4_line_item.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Invoice
+      # Line items for Invoice V4
+      class InvoiceV4LineItem
+        include Mindee::Parsing::Common
+        include Mindee::Parsing::Standard
+        # @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
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        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
+  end
+end

data/lib/mindee/product/invoice/invoice_v4_page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_v4_document'
+
+module Mindee
+  module Product
+    module Invoice
+      # Invoice V4 page.
+      class InvoiceV4Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = InvoiceV4PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Invoice V4 page prediction.
+      class InvoiceV4PagePrediction < InvoiceV4Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/invoice_splitter/invoice_splitter_v1.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_splitter_v1_document'
+require_relative 'invoice_splitter_v1_page'
+
+module Mindee
+  module Product
+    module InvoiceSplitter
+      # Invoice Splitter V1 prediction inference.
+      class InvoiceSplitterV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'invoice_splitter'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = InvoiceSplitterV1Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            @pages.push(InvoiceSplitterV1Page.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