mindee 2.2.0 → 3.0.0

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module InvoiceSplitter
+      # Page Group for Invoice Splitter class
+      class PageGroup
+        # @return[Array<Integer>]
+        attr_reader :page_indexes
+
+        # @return[Float, nil]
+        attr_reader :confidence
+
+        # @param prediction[Hash]
+        def initialize(prediction)
+          @page_indexes = prediction['page_indexes']
+          @confidence = prediction['confidence'].nil? ? 0.0 : Float(prediction['confidence'])
+        end
+
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << ":Page indexes: #{@page_indexes.join(', ')}"
+          out_str
+        end
+      end
+
+      # Invoice Splitter V1 document prediction.
+      class InvoiceSplitterV1Document < Mindee::Parsing::Common::Prediction
+        # @return[Array<Mindee::Product::PageGroup>]
+        attr_reader :invoice_page_groups
+
+        # @param prediction [Hash]
+        # @param _page_id [Integer, nil]
+        def initialize(prediction, _page_id)
+          super()
+          construct_invoice_page_groups_from_prediction(prediction)
+        end
+
+        def construct_invoice_page_groups_from_prediction(prediction)
+          @invoice_page_groups = []
+          return unless prediction.key?('invoice_page_groups') && prediction['invoice_page_groups'].any?
+
+          prediction['invoice_page_groups'].each do |page_group_prediction|
+            @invoice_page_groups.append(PageGroup.new(page_group_prediction))
+          end
+        end
+
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n:Invoice Page Groups:"
+          if !@invoice_page_groups.nil? && @invoice_page_groups.any?
+            @invoice_page_groups.map do |page|
+              out_str << "\n  #{page}"
+            end
+          end
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

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

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

data/lib/mindee/product/passport/passport_v1.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'passport_v1_document'
+require_relative 'passport_v1_page'
+
+module Mindee
+  module Product
+    module Passport
+      # International Passport V1 prediction inference.
+      class PassportV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'passport'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = PassportV1Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            @pages.push(PassportV1Page.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/{parsing/prediction/fr/id_card/id_card_v1.rb → product/passport/passport_v1_document.rb}

@@ -1,80 +1,80 @@
 # frozen_string_literal: true
 
-require_relative '../../common_fields'
-require_relative '../../base'
+require_relative '../../parsing'
 
 module Mindee
-  module Prediction
-    module FR
-      # Carte Nationale d'Identité v1 prediction results.
-      class IdCardV1 < Prediction
-        # The side of the document which is visible.
-        # @return [Mindee::TextField]
-        attr_reader :document_side
-        # The identification card number.
-        # @return [Mindee::TextField]
-        attr_reader :id_number
-        # 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 date of birth of the card holder.
-        # @return [Mindee::DateField]
+  module Product
+    module Passport
+      # International Passport V1 document prediction.
+      class PassportV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The date of birth of the passport holder.
+        # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :birth_date
-        # The place of birth of the card holder.
-        # @return [Mindee::TextField]
+        # The place of birth of the passport holder.
+        # @return [Mindee::Parsing::Standard::TextField]
         attr_reader :birth_place
-        # The expiry date of the identification card.
-        # @return [Mindee::DateField]
+        # The country's 3 letter code (ISO 3166-1 alpha-3).
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :country
+        # The expiry date of the passport.
+        # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :expiry_date
-        # The name of the issuing authority.
-        # @return [Mindee::TextField]
-        attr_reader :authority
-        # The gender of the card holder.
-        # @return [Mindee::TextField]
+        # The gender of the passport holder.
+        # @return [Mindee::Parsing::Standard::TextField]
         attr_reader :gender
+        # The given name(s) of the passport holder.
+        # @return [Array<Mindee::Parsing::Standard::TextField>]
+        attr_reader :given_names
+        # The passport's identification number.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :id_number
+        # The date the passport was issued.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :issuance_date
         # Machine Readable Zone, first line
-        # @return [Mindee::TextField]
+        # @return [Mindee::Parsing::Standard::TextField]
         attr_reader :mrz1
         # Machine Readable Zone, second line
-        # @return [Mindee::TextField]
+        # @return [Mindee::Parsing::Standard::TextField]
         attr_reader :mrz2
+        # The surname of the passport holder.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :surname
 
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super
-          @document_side = TextField.new(prediction['document_side'], page_id) if page_id
-          @authority = TextField.new(prediction['authority'], page_id)
-          @id_number = TextField.new(prediction['id_number'], page_id)
-          @given_names = []
-          prediction['given_names'].each do |item|
-            @given_names.push(TextField.new(item, page_id))
-          end
-          @surname = TextField.new(prediction['surname'], page_id)
+          super()
           @birth_date = DateField.new(prediction['birth_date'], page_id)
           @birth_place = TextField.new(prediction['birth_place'], page_id)
+          @country = TextField.new(prediction['country'], page_id)
           @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-          @authority = TextField.new(prediction['authority'], 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)
+          @issuance_date = DateField.new(prediction['issuance_date'], 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:Document Side: #{@document_side}".rstrip if @document_side
-          out_str << "\n:Identity Number: #{@id_number}".rstrip
+          out_str << "\n:Country Code: #{@country}".rstrip
+          out_str << "\n:ID 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:Date of Issue: #{@issuance_date}".rstrip
+          out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
           out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
           out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
           out_str[1..].to_s

data/lib/mindee/product/passport/passport_v1_page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'passport_v1_document'
+
+module Mindee
+  module Product
+    module Passport
+      # International Passport V1 page.
+      class PassportV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = PassportV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # International Passport V1 page prediction.
+      class PassportV1PagePrediction < PassportV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/proof_of_address/proof_of_address_v1.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'proof_of_address_v1_document'
+require_relative 'proof_of_address_v1_page'
+
+module Mindee
+  module Product
+    module ProofOfAddress
+      # Proof of Address V1 prediction inference.
+      class ProofOfAddressV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'proof_of_address'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = ProofOfAddressV1Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            @pages.push(ProofOfAddressV1Page.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/proof_of_address/proof_of_address_v1_document.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module ProofOfAddress
+      # Proof of Address V1 document prediction.
+      class ProofOfAddressV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The date the document was issued.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :date
+        # List of dates found on the document.
+        # @return [Array<Mindee::Parsing::Standard::DateField>]
+        attr_reader :dates
+        # The address of the document's issuer.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :issuer_address
+        # List of company registrations found for the issuer.
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        attr_reader :issuer_company_registration
+        # The name of the person or company issuing the document.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :issuer_name
+        # The locale detected on the document.
+        # @return [Mindee::Parsing::Standard::Locale]
+        attr_reader :locale
+        # The address of the recipient.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :recipient_address
+        # List of company registrations found for the recipient.
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        attr_reader :recipient_company_registration
+        # The name of the person or company receiving the document.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :recipient_name
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @date = DateField.new(prediction['date'], page_id)
+          @dates = []
+          prediction['dates'].each do |item|
+            @dates.push(DateField.new(item, page_id))
+          end
+          @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
+          @issuer_name = TextField.new(prediction['issuer_name'], page_id)
+          @locale = Locale.new(prediction['locale'], 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
+          @recipient_name = TextField.new(prediction['recipient_name'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          issuer_company_registration = @issuer_company_registration.join("\n #{' ' * 30}")
+          recipient_company_registration = @recipient_company_registration.join("\n #{' ' * 33}")
+          dates = @dates.join("\n #{' ' * 7}")
+          out_str = String.new
+          out_str << "\n:Locale: #{@locale}".rstrip
+          out_str << "\n:Issuer Name: #{@issuer_name}".rstrip
+          out_str << "\n:Issuer Company Registrations: #{issuer_company_registration}".rstrip
+          out_str << "\n:Issuer Address: #{@issuer_address}".rstrip
+          out_str << "\n:Recipient Name: #{@recipient_name}".rstrip
+          out_str << "\n:Recipient Company Registrations: #{recipient_company_registration}".rstrip
+          out_str << "\n:Recipient Address: #{@recipient_address}".rstrip
+          out_str << "\n:Dates: #{dates}".rstrip
+          out_str << "\n:Date of Issue: #{@date}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/proof_of_address/proof_of_address_v1_page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'proof_of_address_v1_document'
+
+module Mindee
+  module Product
+    module ProofOfAddress
+      # Proof of Address V1 page.
+      class ProofOfAddressV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = ProofOfAddressV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Proof of Address V1 page prediction.
+      class ProofOfAddressV1PagePrediction < ProofOfAddressV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/receipt/receipt_v4.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'receipt_v4_document'
+require_relative 'receipt_v4_page'
+
+module Mindee
+  module Product
+    module Receipt
+      # Expense Receipt V4 prediction inference.
+      class ReceiptV4 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'expense_receipts'
+        @endpoint_version = '4'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = ReceiptV4Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            @pages.push(ReceiptV4Page.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/receipt/receipt_v4_document.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Receipt
+      # Expense Receipt V4 document prediction.
+      class ReceiptV4Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # Where the purchase was made, the language, and the currency.
+        # @return [Mindee::Parsing::Standard::Locale]
+        attr_reader :locale
+        # Total including taxes
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_amount
+        # Total amount of the purchase excluding taxes.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_net
+        # Total tax amount of the purchase.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_tax
+        # The purchase date.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :date
+        # The name of the supplier or merchant, as seen on the receipt.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :supplier
+        # List of taxes detected on the receipt.
+        # @return [Mindee::Parsing::Standard::Taxes]
+        attr_reader :taxes
+        # Time as seen on the receipt in HH:MM format.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :time
+        # The receipt category among predefined classes.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :category
+        # The receipt sub-category among predefined classes.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :subcategory
+        # Whether the document is an expense receipt or a credit card receipt.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :document_type
+        # Total amount of tip and gratuity. Both typed and handwritten characters are supported.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :tip
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @locale = Locale.new(prediction['locale'])
+          @total_amount = AmountField.new(prediction['total_amount'], page_id)
+          @total_net = AmountField.new(prediction['total_net'], page_id)
+          @total_tax = AmountField.new(prediction['total_tax'], page_id)
+          @tip = AmountField.new(prediction['tip'], page_id)
+          @date = DateField.new(prediction['date'], page_id)
+          @category = ClassificationField.new(prediction['category'], page_id)
+          @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
+          @document_type = ClassificationField.new(prediction['document_type'], page_id)
+          @supplier = TextField.new(prediction['supplier'], page_id)
+          @time = TextField.new(prediction['time'], page_id)
+          @taxes = Taxes.new(prediction['taxes'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n:Locale: #{@locale}".rstrip
+          out_str << "\n:Date: #{@date}".rstrip
+          out_str << "\n:Category: #{@category}".rstrip
+          out_str << "\n:Subcategory: #{@subcategory}".rstrip
+          out_str << "\n:Document type: #{@document_type}".rstrip
+          out_str << "\n:Time: #{@time}".rstrip
+          out_str << "\n:Supplier name: #{@supplier}".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:Tip: #{@tip}".rstrip
+          out_str << "\n:Total amount: #{@total_amount}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/receipt/receipt_v4_page.rb

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

data/lib/mindee/product/receipt/receipt_v5.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'receipt_v5_document'
+require_relative 'receipt_v5_page'
+
+module Mindee
+  module Product
+    module Receipt
+      # Expense Receipt V5 prediction inference.
+      class ReceiptV5 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'expense_receipts'
+        @endpoint_version = '5'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = ReceiptV5Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            @pages.push(ReceiptV5Page.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