mindee 4.12.0 → 5.0.0.beta1

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_splitter_v1_invoice_page_groups'
+
+module Mindee
+  module V1
+    module Product
+      module InvoiceSplitter
+        # Invoice Splitter API version 1.4 document data.
+        class InvoiceSplitterV1Document < Mindee::V1::Parsing::Common::Prediction
+          include Mindee::V1::Parsing::Standard
+
+          # List of page groups. Each group represents a single invoice within a multi-invoice document.
+          # @return [Mindee::V1::Product::InvoiceSplitter::InvoiceSplitterV1InvoicePageGroups]
+          attr_reader :invoice_page_groups
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @invoice_page_groups = Product::InvoiceSplitter::InvoiceSplitterV1InvoicePageGroups.new(
+              prediction['invoice_page_groups'], page_id
+            )
+          end
+
+          # @return [String]
+          def to_s
+            invoice_page_groups = invoice_page_groups_to_s
+            out_str = String.new
+            out_str << "\n:Invoice Page Groups:"
+            out_str << invoice_page_groups
+            out_str[1..].to_s
+          end
+
+          private
+
+          # @param char [String]
+          # @return [String]
+          def invoice_page_groups_separator(char)
+            out_str = String.new
+            out_str << '  '
+            out_str << "+#{char * 74}"
+            out_str << '+'
+            out_str
+          end
+
+          # @return [String]
+          def invoice_page_groups_to_s
+            return '' if @invoice_page_groups.empty?
+
+            line_items = @invoice_page_groups.map(&:to_table_line).join("\n#{invoice_page_groups_separator('-')}\n  ")
+            out_str = String.new
+            out_str << "\n#{invoice_page_groups_separator('-')}"
+            out_str << "\n  |"
+            out_str << ' Page Indexes                                                             |'
+            out_str << "\n#{invoice_page_groups_separator('=')}"
+            out_str << "\n  #{line_items}"
+            out_str << "\n#{invoice_page_groups_separator('-')}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module InvoiceSplitter
+        # List of page groups. Each group represents a single invoice within a multi-invoice document.
+        class InvoiceSplitterV1InvoicePageGroup < Mindee::V1::Parsing::Standard::FeatureField
+          include Mindee::V1::Parsing::Standard
+
+          # List of page indexes that belong to the same invoice (group).
+          # @return [Array<Integer>]
+          attr_reader :page_indexes
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @page_indexes = prediction['page_indexes']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:page_indexes] = format_for_display(@page_indexes)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:page_indexes] = @page_indexes.join(', ')
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 73s', printable[:page_indexes])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Page Indexes: #{printable[:page_indexes]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'invoice_splitter_v1_invoice_page_group'
+
+module Mindee
+  module V1
+    module Product
+      module InvoiceSplitter
+        # List of page groups. Each group represents a single invoice within a multi-invoice document.
+        class InvoiceSplitterV1InvoicePageGroups < Array
+          # Entries.
+          # @return [Array<InvoiceSplitterV1InvoicePageGroup>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              InvoiceSplitter::InvoiceSplitterV1InvoicePageGroup.new(entry, page_id)
+            end
+            super(entries)
+          end
+
+          # Creates a line of rST table-compliant string separators.
+          # @param char [String] Character to use as a separator.
+          # @return [String]
+          def self.line_items_separator(char)
+            out_str = String.new
+            out_str << "+#{char * 74}"
+            out_str
+          end
+
+          # @return [String]
+          def to_s
+            return '' if empty?
+
+            lines = map do |entry|
+              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+            end.join
+            out_str = String.new
+            out_str << "\n#{self.class.line_items_separator('-')}\n "
+            out_str << ' | Page Indexes                                                            '
+            out_str << " |\n#{self.class.line_items_separator('=')}"
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'invoice_splitter_v1_document'
+
+module Mindee
+  module V1
+    module Product
+      module InvoiceSplitter
+        # Invoice Splitter API version 1.4 page data.
+        class InvoiceSplitterV1Page < Mindee::V1::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            InvoiceSplitterV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
+          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
+end

data/lib/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'multi_receipts_detector_v1_document'
+require_relative 'multi_receipts_detector_v1_page'
+
+module Mindee
+  module V1
+    module Product
+      # Multi Receipts Detector module.
+      module MultiReceiptsDetector
+        # Multi Receipts Detector API version 1 inference prediction.
+        class MultiReceiptsDetectorV1 < Mindee::V1::Parsing::Common::Inference
+          @endpoint_name = 'multi_receipts_detector'
+          @endpoint_version = '1'
+          @has_async = false
+          @has_sync = true
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = MultiReceiptsDetectorV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(MultiReceiptsDetectorV1Page.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
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module MultiReceiptsDetector
+        # Multi Receipts Detector API version 1.1 document data.
+        class MultiReceiptsDetectorV1Document < Mindee::V1::Parsing::Common::Prediction
+          include Mindee::V1::Parsing::Standard
+
+          # Positions of the receipts on the document.
+          # @return [Array<Mindee::V1::Parsing::Standard::PositionField>]
+          attr_reader :receipts
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @receipts = [] # : Array[Parsing::Standard::PositionField]
+            prediction['receipts'].each do |item|
+              @receipts.push(Parsing::Standard::PositionField.new(item, page_id))
+            end
+          end
+
+          # @return [String]
+          def to_s
+            receipts = @receipts.join("\n #{' ' * 18}")
+            out_str = String.new
+            out_str << "\n:List of Receipts: #{receipts}".rstrip
+            out_str[1..].to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'multi_receipts_detector_v1_document'
+
+module Mindee
+  module V1
+    module Product
+      module MultiReceiptsDetector
+        # Multi Receipts Detector API version 1.1 page data.
+        class MultiReceiptsDetectorV1Page < Mindee::V1::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            MultiReceiptsDetectorV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
+          end
+        end
+
+        # Multi Receipts Detector V1 page prediction.
+        class MultiReceiptsDetectorV1PagePrediction < MultiReceiptsDetectorV1Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'passport_v1_document'
+require_relative 'passport_v1_page'
+
+module Mindee
+  module V1
+    module Product
+      # Passport module.
+      module Passport
+        # Passport API version 1 inference prediction.
+        class PassportV1 < Mindee::V1::Parsing::Common::Inference
+          @endpoint_name = 'passport'
+          @endpoint_version = '1'
+          @has_async = false
+          @has_sync = true
+
+          # @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
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/passport/passport_v1_document.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module Passport
+        # Passport API version 1.1 document data.
+        class PassportV1Document < Mindee::V1::Parsing::Common::Prediction
+          include Mindee::V1::Parsing::Standard
+
+          # The date of birth of the passport holder.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :birth_date
+          # The place of birth of the passport holder.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :birth_place
+          # The country's 3 letter code (ISO 3166-1 alpha-3).
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :country
+          # The expiry date of the passport.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :expiry_date
+          # The gender of the passport holder.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :gender
+          # The given name(s) of the passport holder.
+          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+          attr_reader :given_names
+          # The passport's identification number.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :id_number
+          # The date the passport was issued.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :issuance_date
+          # Machine Readable Zone, first line
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :mrz1
+          # Machine Readable Zone, second line
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :mrz2
+          # The surname of the passport holder.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :surname
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @birth_date = Parsing::Standard::DateField.new(
+              prediction['birth_date'],
+              page_id
+            )
+            @birth_place = Parsing::Standard::StringField.new(
+              prediction['birth_place'],
+              page_id
+            )
+            @country = Parsing::Standard::StringField.new(
+              prediction['country'],
+              page_id
+            )
+            @expiry_date = Parsing::Standard::DateField.new(
+              prediction['expiry_date'],
+              page_id
+            )
+            @gender = Parsing::Standard::StringField.new(
+              prediction['gender'],
+              page_id
+            )
+            @given_names = [] # : Array[Parsing::Standard::StringField]
+            prediction['given_names'].each do |item|
+              @given_names.push(Parsing::Standard::StringField.new(item, page_id))
+            end
+            @id_number = Parsing::Standard::StringField.new(
+              prediction['id_number'],
+              page_id
+            )
+            @issuance_date = Parsing::Standard::DateField.new(
+              prediction['issuance_date'],
+              page_id
+            )
+            @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
+            @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
+            @surname = Parsing::Standard::StringField.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: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: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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'passport_v1_document'
+
+module Mindee
+  module V1
+    module Product
+      module Passport
+        # Passport API version 1.1 page data.
+        class PassportV1Page < Mindee::V1::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            PassportV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
+          end
+        end
+
+        # 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
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'receipt_v5_document'
+require_relative 'receipt_v5_page'
+
+module Mindee
+  module V1
+    module Product
+      # Receipt module.
+      module Receipt
+        # Receipt API version 5 inference prediction.
+        class ReceiptV5 < Mindee::V1::Parsing::Common::Inference
+          @endpoint_name = 'expense_receipts'
+          @endpoint_version = '5'
+          @has_async = true
+          @has_sync = true
+
+          # @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
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
+          end
+        end
+      end
+    end
+  end
+end