mindee 2.2.1 → 3.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -118,6 +118,7 @@ files:
 - bin/console
 - bin/mindee.rb
 - docs/code_samples/bank_account_details_v1.txt
+- docs/code_samples/bank_account_details_v2.txt
 - docs/code_samples/bank_check_v1.txt
 - docs/code_samples/carte_vitale_v1.txt
 - docs/code_samples/custom_v1.txt
@@ -126,11 +127,12 @@ files:
 - docs/code_samples/expense_receipts_v5.txt
 - docs/code_samples/financial_document_v1.txt
 - docs/code_samples/idcard_fr_v1.txt
+- docs/code_samples/invoice_splitter_v1_async.txt
 - docs/code_samples/invoices_v4.txt
 - docs/code_samples/license_plates_v1.txt
 - docs/code_samples/passport_v1.txt
 - docs/code_samples/proof_of_address_v1.txt
-- docs/code_samples/shipping_containers_v1.txt
+- docs/code_samples/us_driver_license_v1.txt
 - docs/ruby-api-builder.md
 - docs/ruby-getting-started.md
 - docs/ruby-invoice-ocr.md
@@ -138,46 +140,97 @@ files:
 - docs/ruby-receipt-ocr.md
 - lib/mindee.rb
 - lib/mindee/client.rb
-- lib/mindee/document_config.rb
 - lib/mindee/geometry.rb
+- lib/mindee/geometry/min_max.rb
+- lib/mindee/geometry/point.rb
+- lib/mindee/geometry/polygon.rb
+- lib/mindee/geometry/quadrilateral.rb
+- lib/mindee/geometry/utils.rb
+- lib/mindee/http.rb
 - lib/mindee/http/endpoint.rb
 - lib/mindee/input.rb
-- lib/mindee/input/pdf_processing.rb
 - lib/mindee/input/sources.rb
 - lib/mindee/parsing.rb
-- lib/mindee/parsing/document.rb
-- lib/mindee/parsing/error.rb
-- lib/mindee/parsing/inference.rb
-- lib/mindee/parsing/page.rb
-- lib/mindee/parsing/prediction.rb
-- lib/mindee/parsing/prediction/base.rb
-- lib/mindee/parsing/prediction/common_fields.rb
-- lib/mindee/parsing/prediction/common_fields/amount.rb
-- lib/mindee/parsing/prediction/common_fields/base.rb
-- lib/mindee/parsing/prediction/common_fields/company_registration.rb
-- lib/mindee/parsing/prediction/common_fields/date.rb
-- lib/mindee/parsing/prediction/common_fields/locale.rb
-- lib/mindee/parsing/prediction/common_fields/payment_details.rb
-- lib/mindee/parsing/prediction/common_fields/position.rb
-- lib/mindee/parsing/prediction/common_fields/tax.rb
-- lib/mindee/parsing/prediction/common_fields/text.rb
-- lib/mindee/parsing/prediction/custom/custom_v1.rb
-- lib/mindee/parsing/prediction/custom/fields.rb
-- lib/mindee/parsing/prediction/eu/license_plate/license_plate_v1.rb
-- lib/mindee/parsing/prediction/financial_document/financial_document_v1.rb
-- lib/mindee/parsing/prediction/financial_document/financial_document_v1_line_item.rb
-- lib/mindee/parsing/prediction/fr/bank_account_details/bank_account_details_v1.rb
-- lib/mindee/parsing/prediction/fr/carte_vitale/carte_vitale_v1.rb
-- lib/mindee/parsing/prediction/fr/id_card/id_card_v1.rb
-- lib/mindee/parsing/prediction/invoice/invoice_v4.rb
-- lib/mindee/parsing/prediction/invoice/invoice_v4_line_item.rb
-- lib/mindee/parsing/prediction/passport/passport_v1.rb
-- lib/mindee/parsing/prediction/proof_of_address/proof_of_address_v1.rb
-- lib/mindee/parsing/prediction/receipt/receipt_v4.rb
-- lib/mindee/parsing/prediction/receipt/receipt_v5.rb
-- lib/mindee/parsing/prediction/receipt/receipt_v5_line_item.rb
-- lib/mindee/parsing/prediction/shipping_container/shipping_container_v1.rb
-- lib/mindee/parsing/prediction/us/bank_check/bank_check_v1.rb
+- lib/mindee/parsing/common.rb
+- lib/mindee/parsing/common/api_response.rb
+- lib/mindee/parsing/common/document.rb
+- lib/mindee/parsing/common/error.rb
+- lib/mindee/parsing/common/inference.rb
+- lib/mindee/parsing/common/ocr.rb
+- lib/mindee/parsing/common/ocr/mvision_v1.rb
+- lib/mindee/parsing/common/ocr/ocr.rb
+- lib/mindee/parsing/common/orientation.rb
+- lib/mindee/parsing/common/page.rb
+- lib/mindee/parsing/common/prediction.rb
+- lib/mindee/parsing/common/product.rb
+- lib/mindee/parsing/custom.rb
+- lib/mindee/parsing/custom/classification_field.rb
+- lib/mindee/parsing/custom/list_field.rb
+- lib/mindee/parsing/standard.rb
+- lib/mindee/parsing/standard/amount_field.rb
+- lib/mindee/parsing/standard/base_field.rb
+- lib/mindee/parsing/standard/classification_field.rb
+- lib/mindee/parsing/standard/company_registration_field.rb
+- lib/mindee/parsing/standard/date_field.rb
+- lib/mindee/parsing/standard/locale_field.rb
+- lib/mindee/parsing/standard/payment_details_field.rb
+- lib/mindee/parsing/standard/position_field.rb
+- lib/mindee/parsing/standard/tax_field.rb
+- lib/mindee/parsing/standard/text_field.rb
+- lib/mindee/pdf.rb
+- lib/mindee/pdf/pdf_processing.rb
+- lib/mindee/pdf/pdf_tools.rb
+- lib/mindee/product.rb
+- lib/mindee/product/.rubocop.yml
+- lib/mindee/product/custom/custom_v1.rb
+- lib/mindee/product/custom/custom_v1_document.rb
+- lib/mindee/product/custom/custom_v1_page.rb
+- lib/mindee/product/eu/license_plate/license_plate_v1.rb
+- lib/mindee/product/eu/license_plate/license_plate_v1_document.rb
+- lib/mindee/product/eu/license_plate/license_plate_v1_page.rb
+- lib/mindee/product/financial_document/financial_document_v1.rb
+- lib/mindee/product/financial_document/financial_document_v1_document.rb
+- lib/mindee/product/financial_document/financial_document_v1_line_item.rb
+- lib/mindee/product/financial_document/financial_document_v1_page.rb
+- lib/mindee/product/fr/bank_account_details/bank_account_details_v1.rb
+- lib/mindee/product/fr/bank_account_details/bank_account_details_v1_document.rb
+- lib/mindee/product/fr/bank_account_details/bank_account_details_v1_page.rb
+- lib/mindee/product/fr/bank_account_details/bank_account_details_v2.rb
+- lib/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rb
+- lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb
+- lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb
+- lib/mindee/product/fr/carte_vitale/carte_vitale_v1.rb
+- lib/mindee/product/fr/carte_vitale/carte_vitale_v1_document.rb
+- lib/mindee/product/fr/carte_vitale/carte_vitale_v1_page.rb
+- lib/mindee/product/fr/id_card/id_card_v1.rb
+- lib/mindee/product/fr/id_card/id_card_v1_document.rb
+- lib/mindee/product/fr/id_card/id_card_v1_page.rb
+- lib/mindee/product/invoice/invoice_v4.rb
+- lib/mindee/product/invoice/invoice_v4_document.rb
+- lib/mindee/product/invoice/invoice_v4_line_item.rb
+- lib/mindee/product/invoice/invoice_v4_page.rb
+- lib/mindee/product/invoice_splitter/invoice_splitter_v1.rb
+- lib/mindee/product/invoice_splitter/invoice_splitter_v1_document.rb
+- lib/mindee/product/invoice_splitter/invoice_splitter_v1_page.rb
+- lib/mindee/product/passport/passport_v1.rb
+- lib/mindee/product/passport/passport_v1_document.rb
+- lib/mindee/product/passport/passport_v1_page.rb
+- lib/mindee/product/proof_of_address/proof_of_address_v1.rb
+- lib/mindee/product/proof_of_address/proof_of_address_v1_document.rb
+- lib/mindee/product/proof_of_address/proof_of_address_v1_page.rb
+- lib/mindee/product/receipt/receipt_v4.rb
+- lib/mindee/product/receipt/receipt_v4_document.rb
+- lib/mindee/product/receipt/receipt_v4_page.rb
+- lib/mindee/product/receipt/receipt_v5.rb
+- lib/mindee/product/receipt/receipt_v5_document.rb
+- lib/mindee/product/receipt/receipt_v5_line_item.rb
+- lib/mindee/product/receipt/receipt_v5_page.rb
+- lib/mindee/product/us/bank_check/bank_check_v1.rb
+- lib/mindee/product/us/bank_check/bank_check_v1_document.rb
+- lib/mindee/product/us/bank_check/bank_check_v1_page.rb
+- lib/mindee/product/us/driver_license/driver_license_v1.rb
+- lib/mindee/product/us/driver_license/driver_license_v1_document.rb
+- lib/mindee/product/us/driver_license/driver_license_v1_page.rb
 - lib/mindee/version.rb
 - mindee.gemspec
 homepage: https://github.com/mindee/mindee-api-ruby

data/docs/code_samples/shipping_containers_v1.txt

@@ -1,14 +0,0 @@
-require 'mindee'
-
-# Init a new client
-mindee_client = Mindee::Client.new(api_key: 'my-api-key')
-
-# Load a file from disk and parse it
-result = mindee_client.doc_from_path('/path/to/the/file.ext')
-  .parse(Mindee::Prediction::ShippingContainerV1)
-
-# Print a full summary of the parsed data in RST format
-puts result
-
-# Print the document-level parsed data
-# puts result.inference.prediction

data/lib/mindee/document_config.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-require_relative 'http/endpoint'
-require_relative 'parsing/document'
-require_relative 'parsing/error'
-require_relative 'parsing/prediction'
-
-module Mindee
-  # Specific client for sending a document to the API.
-  class DocumentConfig
-    # Array of possible Mindee::Endpoint to be used.
-    # @return [Mindee::HTTP::Endpoint]
-    attr_reader :endpoint
-
-    # @param prediction_class [Class<Mindee::Prediction::Prediction>]
-    # @param endpoint [Mindee::HTTP::Endpoint]
-    def initialize(prediction_class, endpoint)
-      @prediction_class = prediction_class
-      @endpoint = endpoint
-    end
-
-    # Call the prediction API.
-    # @param input_doc [Mindee::InputDocument]
-    # @param include_words [Boolean]
-    # @param close_file [Boolean]
-    # @param cropper [Boolean]
-    # @return [Mindee::DocumentResponse]
-    def predict(input_doc, include_words, close_file, cropper)
-      check_api_key
-      response = predict_request(input_doc, include_words, close_file, cropper)
-      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)
-
-      error = Parsing::Error.new(hashed_response['api_request']['error'])
-      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)
-      @endpoint.predict_req_post(input_doc, include_words: include_words, close_file: close_file, cropper: cropper)
-    end
-
-    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
-  end
-end

data/lib/mindee/parsing/document.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'inference'
-
-module Mindee
-  # Stores all response attributes.
-  class Document
-    # @return [Mindee::Inference]
-    attr_reader :inference
-    # @return [String] Filename sent to the API
-    attr_reader :name
-    # @return [String] Mindee ID of the document
-    attr_reader :id
-
-    # @param prediction_class [Class<Mindee::Prediction::Prediction>]
-    # @param http_response [Hash]
-    def initialize(prediction_class, http_response)
-      @id = http_response['id']
-      @name = http_response['name']
-      @inference = Mindee::Inference.new(prediction_class, http_response['inference'])
-    end
-
-    def to_s
-      out_str = String.new
-      out_str << "########\nDocument\n########"
-      out_str << "\n:Mindee ID: #{@id}"
-      out_str << "\n:Filename: #{@name}"
-      out_str << "\n\n#{@inference}"
-    end
-  end
-end

data/lib/mindee/parsing/error.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  module Parsing
-    # API Error
-    class Error < StandardError
-      # @return [String]
-      attr_reader :api_code
-      # @return [String]
-      attr_reader :api_details
-      # @return [String]
-      attr_reader :api_message
-
-      def initialize(error)
-        @api_code = error['code']
-        @api_details = error['details']
-        @api_message = error['message']
-        super("#{@api_code}: #{@api_details} - #{@api_message}")
-      end
-    end
-  end
-end

data/lib/mindee/parsing/inference.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'page'
-
-module Mindee
-  # Product information
-  class Product
-    attr_reader :name, :type, :version
-
-    # @param http_response [Hash]
-    def initialize(http_response)
-      @name = http_response['name']
-      @type = http_response['type']
-      @version = http_response['version']
-    end
-  end
-
-  # Inference holds all predictions
-  class Inference
-    # @return [Boolean]
-    attr_reader :is_rotation_applied
-    # @return [Array<Mindee::Page>]
-    attr_reader :pages
-    # @return [Mindee::Prediction]
-    attr_reader :prediction
-    # @return [Mindee::Product]
-    attr_reader :product
-
-    # @param prediction_class [Class<Mindee::Prediction::Prediction>]
-    # @param http_response [Hash]
-    def initialize(prediction_class, http_response)
-      @is_rotation_applied = http_response['is_rotation_applied']
-      @prediction = prediction_class.new(http_response['prediction'], nil)
-      @product = Product.new(http_response['product'])
-      @pages = []
-      http_response['pages'].each do |page|
-        @pages.push(Page.new(prediction_class, page))
-      end
-    end
-
-    def to_s
-      is_rotation_applied = @is_rotation_applied ? 'Yes' : 'No'
-      out_str = String.new
-      out_str << "Inference\n#########"
-      out_str << "\n:Product: #{@product.name} v#{@product.version}"
-      out_str << "\n:Rotation applied: #{is_rotation_applied}"
-      out_str << "\n\nPrediction\n=========="
-      out_str << "\n#{@prediction}"
-      out_str << "\n\nPage Predictions\n================\n\n"
-      out_str << @pages.map(&:to_s).join("\n\n")
-    end
-  end
-end

data/lib/mindee/parsing/page.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  # Page orientation
-  class Orientation
-    # @return [Integer]
-    attr_reader :page_id
-    # A prediction among these 3 possible outputs:
-    #   * 0 degrees: the page is already upright
-    #   * 90 degrees: the page must be rotated clockwise to be upright
-    #   * 270 degrees: the page must be rotated counterclockwise to be upright
-    # @return [Integer, nil]
-    attr_reader :value
-
-    # @param prediction [Hash]
-    # @param page_id [Integer]
-    def initialize(prediction, page_id)
-      @value = prediction['value']
-      @page_id = page_id
-    end
-  end
-
-  # Page object
-  class Page
-    # @return [Integer]
-    attr_reader :id
-    # @return [Mindee::Prediction]
-    attr_reader :prediction
-    # @return [Mindee::Orientation]
-    attr_reader :orientation
-
-    def initialize(prediction_class, page)
-      @id = page['id'].to_i
-      @prediction = prediction_class.new(page['prediction'], @id)
-      @orientation = Orientation.new(page['orientation'], @id)
-    end
-
-    def to_s
-      out_str = String.new
-      title = "Page #{@id}"
-      out_str << "#{title}\n"
-      out_str << ('-' * title.size)
-      out_str << "\n#{@prediction}"
-    end
-  end
-end

data/lib/mindee/parsing/prediction/base.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  module Prediction
-    # Base document object.
-    class Prediction
-      # document type
-      # @return [String]
-      attr_reader :document_type
-      # Validation checks for the document
-      # @return [Hash<Symbol, Boolean>]
-      attr_reader :checklist
-      # Original filename of the document
-      # @return [String, nil]
-      attr_reader :filename
-      # Detected MIME type of the document
-      # @return [String, nil]
-      attr_reader :file_mimetype
-
-      def initialize(_prediction, _page_id)
-        @checklist = {}
-      end
-
-      # @return [Boolean]
-      def all_checks
-        @checklist.all? { |_, value| value == true }
-      end
-    end
-  end
-end

data/lib/mindee/parsing/prediction/common_fields/amount.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Mindee
-  # Represents tax information.
-  class AmountField < Field
-    # Amount value as 3 decimal float
-    # @return [Float, nil]
-    attr_reader :value
-
-    def initialize(prediction, page_id, reconstructed: false)
-      super
-      @value = @value.round(3) unless @value.nil?
-    end
-
-    def to_s
-      Field.float_to_string(@value)
-    end
-  end
-end

data/lib/mindee/parsing/prediction/common_fields/base.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../geometry'
-
-module Mindee
-  # Base field object.
-  class Field
-    # @return [String, Float, Integer, Boolean]
-    attr_reader :value
-    # @return [Array<Array<Float>>]
-    attr_reader :bounding_box
-    # @return [Mindee::Geometry::Polygon]
-    attr_reader :polygon
-    # @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)
-      @value = prediction['value']
-      @confidence = prediction['confidence']
-      @polygon = Geometry.polygon_from_prediction(prediction['polygon'])
-      @bounding_box = Geometry.get_bounding_box(@polygon) unless @polygon.nil? || @polygon.empty?
-      @page_id = page_id || prediction['page_id']
-      @reconstructed = reconstructed
-    end
-
-    def to_s
-      @value ? @value.to_s : ''
-    end
-
-    # Multiply all the Mindee::Field confidences in the array.
-    def self.array_confidence(field_array)
-      product = 1
-      field_array.each do |field|
-        return 0.0 if field.confidence.nil?
-
-        product *= field.confidence
-      end
-      product.to_f
-    end
-
-    # Add all the Mindee::Field values in the array.
-    def self.array_sum(field_array)
-      arr_sum = 0
-      field_array.each do |field|
-        return 0.0 if field.value.nil?
-
-        arr_sum += field.value
-      end
-      arr_sum.to_f
-    end
-
-    # @param value [Float]
-    # @param min_precision [Integer]
-    def self.float_to_string(value, min_precision = 2)
-      return String.new if value.nil?
-
-      precision = value.to_f.to_s.split('.')[1].size
-      precision = [precision, min_precision].max
-      format_string = "%.#{precision}f"
-      format(format_string, value)
-    end
-  end
-end

data/lib/mindee/parsing/prediction/common_fields/company_registration.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  # Company registration number or code, and its type.
-  class CompanyRegistration < Field
-    # @return [String]
-    attr_reader :type
-
-    # @param prediction [Hash]
-    # @param page_id [Integer, nil]
-    # @param reconstructed [Boolean]
-    def initialize(prediction, page_id, reconstructed: false)
-      super
-      @type = prediction['type']
-    end
-  end
-end

data/lib/mindee/parsing/prediction/common_fields/date.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'date'
-
-require_relative 'base'
-
-module Mindee
-  # Represents a date.
-  class DateField < Field
-    # The date as a standard Ruby `Date` object.
-    # @return [Date, nil]
-    attr_reader :date_object
-    # The ISO 8601 representation of the date, regardless of the `raw` contents.
-    # @return [String, nil]
-    attr_reader :value
-    # The textual representation of the date as found on the document.
-    # @return [String, nil]
-    attr_reader :raw
-
-    # @param prediction [Hash]
-    # @param page_id [Integer, nil]
-    def initialize(prediction, page_id)
-      super
-      return unless @value
-
-      @date_object = Date.parse(@value)
-      @raw = prediction['raw']
-    end
-  end
-end

data/lib/mindee/parsing/prediction/common_fields/locale.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  # Represents locale information
-  class Locale
-    # The confidence score, value will be between 0.0 and 1.0
-    # @return [Float]
-    attr_reader :confidence
-    #  Language code in ISO 639-1 format.
-    # @return [String]
-    attr_reader :language
-    # Country code in ISO 3166-1 alpha-2 format.
-    # @return [String, nil]
-    attr_reader :country
-    # Currency code in ISO 4217 format.
-    # @return [String]
-    attr_reader :currency
-    # Language code, with country code when available.
-    # @return [String]
-    attr_reader :value
-
-    # @param prediction [Hash]
-    def initialize(prediction, _page_id = nil)
-      value_key = if prediction.include? 'value'
-                    'value'
-                  else
-                    'language'
-                  end
-      @confidence = prediction['confidence']
-      @value = prediction[value_key]
-      @language = prediction['language']
-      @country = prediction['country']
-      @currency = prediction['currency']
-    end
-
-    def to_s
-      out_str = String.new
-      out_str << "#{@value}; " if @value
-      out_str << "#{@language}; " if @language
-      out_str << "#{@country}; " if @country
-      out_str << "#{@currency}; " if @currency
-      out_str.strip
-    end
-  end
-end

data/lib/mindee/parsing/prediction/common_fields/payment_details.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Mindee
-  # Represents payment details for invoices and receipts
-  class PaymentDetails < Field
-    attr_reader :account_number,
-                :iban,
-                :routing_number,
-                :swift
-
-    # @param prediction [Hash]
-    # @param page_id [Integer, nil]
-    # @param reconstructed [Boolean]
-    def initialize(prediction, page_id, reconstructed: false)
-      super
-      @account_number = prediction['account_number']
-      @iban = prediction['iban']
-      @routing_number = prediction['routing_number']
-      @swift = prediction['swift']
-    end
-
-    def to_s
-      out_str = String.new
-      out_str << "#{@account_number}; " if @account_number
-      out_str << "#{@iban}; " if @iban
-      out_str << "#{@routing_number}; " if @routing_number
-      out_str << "#{@swift}; " if @swift
-      out_str.strip
-    end
-  end
-end