mindee 3.13.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d255d5113e3dc0f77b2f1d73bc13c9c5de423e7999d984480279488ee65835
-  data.tar.gz: 02cfd3cec62b74c7bcbb90068deb6c791fa4f9e36837614f6712b36f32557b5f
+  metadata.gz: '043953eb35ed9f251d12ca8b984edcf9acbeb491689574450dc3682b83e9db37'
+  data.tar.gz: 5916ad8aeada6713ee5a846d634693fd1ed5e585495238649f9a9c1d2e9fbd00
 SHA512:
-  metadata.gz: d95a14c6fdd4238b135907c5b98eee4026287dbe14c2e71aac3d214f3cd92fd83472ff3bf9d59256892ee806c2375c97a6bdd3889a717ba76a3557c722cf3e9d
-  data.tar.gz: ac8b4b8dd66883be7f6669d0da7e68740fdf1dc64c9db9dd6228ec927f300e0bbc43f1498ed231110932fc5531e7d840f7d5f1b40f60bde1415481b699f3d304
+  metadata.gz: 7edd036d9666e1ffe0318b8ec68cdfe5b37b6bdbb90e36ae0c19efa5cc038f109af30d9e6df6838e4237db2f9495a6251f10164db7e0c7dff528720ef4477a2a
+  data.tar.gz: 7dfbb27c5175bda760ba816be62b1447acf4517d6741506cb458bbe4b2b4c77338eff1d799d19f4b0bdca663323523eb479bc468e80f9ed1943226694ef04143

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Mindee Ruby API Library Changelog
 
+## v3.14.0 - 2024-10-11
+### Changes
+* :sparkles: add support for Financial Document v1.10
+* :sparkles: add support for Invoice v4.8
+### Fixes
+* :bug: fix multi-receipts extraction not working as intended
+
+
 ## v3.13.0 - 2024-09-18
 ### Changes
 * :sparkles: add support for BillOfLadingV1

data/docs/bill_of_lading_v1.md

@@ -6,7 +6,7 @@ parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Bill of Lading API](https://platform.mindee.com/mindee/bill_of_lading).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/bill_of_lading/default_sample.jpg) can be used for testing purposes.
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/bill_of_lading/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![Bill of Lading sample](https://github.com/mindee/client-lib-test-data/blob/main/products/bill_of_lading/default_sample.jpg?raw=true)
 
 # Quick-Start
@@ -32,6 +32,55 @@ puts result.document
 # puts result.document.inference.prediction
 
 ```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: 3b5250a1-b52c-4e0b-bc3e-2f0146b04e29
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/bill_of_lading v1.1
+:Rotation applied: No
+
+Prediction
+==========
+:Bill of Lading Number: XYZ123456
+:Shipper:
+  :Address: 123 OCEAN DRIVE, SHANGHAI, CHINA
+  :Email:
+  :Name: GLOBAL FREIGHT SOLUTIONS INC.
+  :Phone: 86-21-12345678
+:Consignee:
+  :Address: 789 TRADE STREET, SINGAPORE 567890, SINGAPORE
+  :Email:
+  :Name: PACIFIC TRADING CO.
+  :Phone: 65-65432100
+:Notify Party:
+  :Address: 789 TRADE STREET, SINGAPORE 567890, SINGAPORE
+  :Email:
+  :Name: PACIFIC TRADING CO.
+  :Phone: 65-65432100
+:Carrier:
+  :Name: GLOBAL SHIPPING CO.,LTD.
+  :Professional Number:
+  :SCAC:
+:Items:
+  +--------------------------------------+--------------+-------------+------------------+----------+-------------+
+  | Description                          | Gross Weight | Measurement | Measurement Unit | Quantity | Weight Unit |
+  +======================================+==============+=============+==================+==========+=============+
+  | ELECTRONIC COMPONENTS\nP/N: 12345... | 500.00       | 1.50        | cbm              | 1.00     | kgs         |
+  +--------------------------------------+--------------+-------------+------------------+----------+-------------+
+:Port of Loading: SHANGHAI, CHINA
+:Port of Discharge: LOS ANGELES, USA
+:Place of Delivery: LOS ANGELES, USA
+:Date of issue: 2022-09-30
+:Departure Date:
+```
+
 # Field Types
 ## Standard Fields
 These fields are generic and used in several products.

data/docs/energy_bill_fra_v1.md

@@ -6,7 +6,7 @@ parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Energy Bill API](https://platform.mindee.com/mindee/energy_bill_fra).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg) can be used for testing purposes.
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![Energy Bill sample](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg?raw=true)
 
 # Quick-Start
@@ -32,6 +32,66 @@ puts result.document
 # puts result.document.inference.prediction
 
 ```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: 17f0ccef-e3fe-4a28-838d-d704489d6ce7
+:Filename: default_sample.pdf
+
+Inference
+#########
+:Product: mindee/energy_bill_fra v1.0
+:Rotation applied: No
+
+Prediction
+==========
+:Invoice Number: 10123590373
+:Contract ID: 1234567890
+:Delivery Point: 98765432109876
+:Invoice Date: 2021-01-29
+:Due Date: 2021-02-15
+:Total Before Taxes: 1241.03
+:Total Taxes: 238.82
+:Total Amount: 1479.85
+:Energy Supplier:
+  :Address: TSA 12345, 12345 DEMOCITY CEDEX, 75001 PARIS
+  :Name: EDF
+:Energy Consumer:
+  :Address: 12 AVENUE DES RÊVES, RDC A 123 COUR FAUSSE A, 75000 PARIS
+  :Name: John Doe
+:Subscription:
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+  | Description                          | End Date   | Start Date | Tax Rate | Total     | Unit Price |
+  +======================================+============+============+==========+===========+============+
+  | Abonnement électricité               | 2021-02-28 | 2021-01-01 | 5.50     | 59.00     | 29.50      |
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+:Energy Usage:
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+  | Description                          | End Date   | Start Date | Tax Rate | Total     | Unit Price |
+  +======================================+============+============+==========+===========+============+
+  | Consommation (HT)                    | 2021-01-27 | 2020-11-28 | 20.00    | 898.43    | 10.47      |
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+:Taxes and Contributions:
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+  | Description                          | End Date   | Start Date | Tax Rate | Total     | Unit Price |
+  +======================================+============+============+==========+===========+============+
+  | Contribution au Service Public de... | 2021-01-27 | 2020-11-28 | 20.00    | 193.07    | 2.25       |
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+  | Départementale sur la Conso Final... | 2020-12-31 | 2020-11-28 | 20.00    | 13.98     | 0.3315     |
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+  | Communale sur la Conso Finale Ele... | 2021-01-27 | 2021-01-01 | 20.00    | 28.56     | 0.6545     |
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+  | Contribution Tarifaire d'Achemine... | 2020-12-31 | 2020-11-28 | 20.00    | 27.96     | 0.663      |
+  +--------------------------------------+------------+------------+----------+-----------+------------+
+:Meter Details:
+  :Meter Number: 620
+  :Meter Type: electricity
+  :Unit of Measure: kWh
+```
+
 # Field Types
 ## Standard Fields
 These fields are generic and used in several products.

data/docs/expense_receipts_v5.md

@@ -50,7 +50,7 @@ Prediction
 ==========
 :Expense Locale: en-GB; en; GB; GBP;
 :Purchase Category: food
-:Purchase Subcategory: restaurant
+:Purchase Subcategory:
 :Document Type: EXPENSE RECEIPT
 :Purchase Date: 2016-02-26
 :Purchase Time: 15:20
@@ -64,7 +64,7 @@ Prediction
   +===============+========+==========+===============+
   | 8.50          | VAT    | 20.00    | 1.70          |
   +---------------+--------+----------+---------------+
-:Supplier Name: clachan
+:Supplier Name: Clachan
 :Supplier Company Registrations: Type: VAT NUMBER, Value: 232153895
                                  Type: VAT NUMBER, Value: 232153895
 :Supplier Address: 34 Kingley Street W1B 50H
@@ -84,7 +84,7 @@ Page 0
 ------
 :Expense Locale: en-GB; en; GB; GBP;
 :Purchase Category: food
-:Purchase Subcategory: restaurant
+:Purchase Subcategory:
 :Document Type: EXPENSE RECEIPT
 :Purchase Date: 2016-02-26
 :Purchase Time: 15:20
@@ -98,7 +98,7 @@ Page 0
   +===============+========+==========+===============+
   | 8.50          | VAT    | 20.00    | 1.70          |
   +---------------+--------+----------+---------------+
-:Supplier Name: clachan
+:Supplier Name: Clachan
 :Supplier Company Registrations: Type: VAT NUMBER, Value: 232153895
                                  Type: VAT NUMBER, Value: 232153895
 :Supplier Address: 34 Kingley Street W1B 50H

data/docs/financial_document_v1.md

@@ -370,6 +370,20 @@ end
 puts result.document.inference.prediction.locale.value
 ```
 
+## Payment Date
+**payment_date** ([DateField](#date-field)): The date on which the payment is due / fullfilled.
+
+```rb
+puts result.document.inference.prediction.payment_date.value
+```
+
+## Purchase Order Number
+**po_number** ([StringField](#string-field)): The purchase order number.
+
+```rb
+puts result.document.inference.prediction.po_number.value
+```
+
 ## Receipt Number
 **receipt_number** ([StringField](#string-field)): The receipt number or identifier only if document is a receipt.
 

data/docs/invoices_v4.md

@@ -93,7 +93,7 @@ Prediction
 :Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
 :Supplier Phone Number: 4165551212
 :Supplier Website:
-:Supplier Email: i_doi@example.com
+:Supplier Email: ldoi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
@@ -137,7 +137,7 @@ Page 0
 :Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
 :Supplier Phone Number: 4165551212
 :Supplier Website:
-:Supplier Email: i_doi@example.com
+:Supplier Email: ldoi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
@@ -332,6 +332,20 @@ end
 puts result.document.inference.prediction.locale.value
 ```
 
+## Payment Date
+**payment_date** ([DateField](#date-field)): The date on which the payment is due/ was full-filled.
+
+```rb
+puts result.document.inference.prediction.payment_date.value
+```
+
+## Purchase Order Number
+**po_number** ([StringField](#string-field)): The purchase order number.
+
+```rb
+puts result.document.inference.prediction.po_number.value
+```
+
 ## Reference Numbers
 **reference_numbers** (Array<[StringField](#string-field)>): List of Reference numbers, including PO number.
 

data/docs/nutrition_facts_v1.md

@@ -6,7 +6,7 @@ parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Nutrition Facts Label API](https://platform.mindee.com/mindee/nutrition_facts).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/default_sample.jpg) can be used for testing purposes.
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![Nutrition Facts Label sample](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/default_sample.jpg?raw=true)
 
 # Quick-Start
@@ -32,6 +32,85 @@ puts result.document
 # puts result.document.inference.prediction
 
 ```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: 38a12fe0-5d69-4ca4-9b30-12f1b659311c
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/nutrition_facts v1.0
+:Rotation applied: No
+
+Prediction
+==========
+:Serving per Box: 2.00
+:Serving Size:
+  :Amount: 228.00
+  :Unit: g
+:Calories:
+  :Daily Value:
+  :Per 100g:
+  :Per Serving: 250.00
+:Total Fat:
+  :Daily Value:
+  :Per 100g:
+  :Per Serving: 12.00
+:Saturated Fat:
+  :Daily Value: 15.00
+  :Per 100g:
+  :Per Serving: 3.00
+:Trans Fat:
+  :Daily Value:
+  :Per 100g:
+  :Per Serving: 3.00
+:Cholesterol:
+  :Daily Value: 10.00
+  :Per 100g:
+  :Per Serving: 30.00
+:Total Carbohydrate:
+  :Daily Value: 10.00
+  :Per 100g:
+  :Per Serving: 31.00
+:Dietary Fiber:
+  :Daily Value: 0.00
+  :Per 100g:
+  :Per Serving: 0.00
+:Total Sugars:
+  :Daily Value:
+  :Per 100g:
+  :Per Serving: 5.00
+:Added Sugars:
+  :Daily Value:
+  :Per 100g:
+  :Per Serving:
+:Protein:
+  :Daily Value:
+  :Per 100g:
+  :Per Serving: 5.00
+:sodium:
+  :Daily Value: 20.00
+  :Per 100g:
+  :Per Serving: 470.00
+  :Unit: mg
+:nutrients:
+  +-------------+----------------------+----------+-------------+------+
+  | Daily Value | Name                 | Per 100g | Per Serving | Unit |
+  +=============+======================+==========+=============+======+
+  | 12.00       | Vitamin A            |          | 4.00        | mcg  |
+  +-------------+----------------------+----------+-------------+------+
+  | 12.00       | Vitamin C            |          | 2.00        | mg   |
+  +-------------+----------------------+----------+-------------+------+
+  | 12.00       | Calcium              |          | 45.60       | mg   |
+  +-------------+----------------------+----------+-------------+------+
+  | 12.00       | Iron                 |          | 0.90        | mg   |
+  +-------------+----------------------+----------+-------------+------+
+```
+
 # Field Types
 ## Standard Fields
 These fields are generic and used in several products.

data/docs/payslip_fra_v2.md

@@ -6,7 +6,7 @@ parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Payslip API](https://platform.mindee.com/mindee/payslip_fra).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/default_sample.jpg) can be used for testing purposes.
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![Payslip sample](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/default_sample.jpg?raw=true)
 
 # Quick-Start
@@ -32,6 +32,82 @@ puts result.document
 # puts result.document.inference.prediction
 
 ```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: 972edba5-25aa-49d0-8431-e2557ddd788e
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/payslip_fra v2.0
+:Rotation applied: No
+
+Prediction
+==========
+:Employee:
+  :Address: 52 RUE DES FLEURS 33500 LIBOURNE FRANCE
+  :Date of Birth:
+  :First Name: Jean Luc
+  :Last Name: Picard
+  :Phone Number:
+  :Registration Number:
+  :Social Security Number: 123456789012345
+:Employer:
+  :Address: 1 RUE DU TONNOT 25210 DOUBS
+  :Company ID: 12345678901234
+  :Company Site:
+  :NAF Code: 1234A
+  :Name: DEMO COMPANY
+  :Phone Number:
+  :URSSAF Number:
+:Bank Account Details:
+  :Bank Name:
+  :IBAN:
+  :SWIFT:
+:Employment:
+  :Category: Cadre
+  :Coefficient: 600.00
+  :Collective Agreement: Construction -- Promotion
+  :Job Title: Directeur Régional du Développement
+  :Position Level:
+  :Start Date: 2022-05-01
+:Salary Details:
+  +--------------+-----------+--------------------------------------+-----------+
+  | Amount       | Base      | Description                          | Rate      |
+  +==============+===========+======================================+===========+
+  | 6666.67      |           | Salaire de base                      |           |
+  +--------------+-----------+--------------------------------------+-----------+
+  | 9.30         |           | Part patronale Mutuelle NR           |           |
+  +--------------+-----------+--------------------------------------+-----------+
+  | 508.30       |           | Avantages en nature voiture          |           |
+  +--------------+-----------+--------------------------------------+-----------+
+:Pay Detail:
+  :Gross Salary: 7184.27
+  :Gross Salary YTD: 18074.81
+  :Income Tax Rate: 17.60
+  :Income Tax Withheld: 1030.99
+  :Net Paid: 3868.32
+  :Net Paid Before Tax: 4899.31
+  :Net Taxable: 5857.90
+  :Net Taxable YTD: 14752.73
+  :Total Cost Employer: 10486.94
+  :Total Taxes and Deductions: 1650.36
+:PTO:
+  :Accrued This Period: 6.17
+  :Balance End of Period: 6.17
+  :Used This Period:
+:Pay Period:
+  :End Date: 2023-03-31
+  :Month: 03
+  :Payment Date: 2023-03-29
+  :Start Date: 2023-03-01
+  :Year: 2023
+```
+
 # Field Types
 ## Standard Fields
 These fields are generic and used in several products.

data/docs/us_mail_v2.md

@@ -38,7 +38,7 @@ puts result.document
 :Sender Name: zed
 :Sender Address:
   :City: Dallas
-  :Complete Address: 54321 Elm Street, Dallas, Texas ...
+  :Complete Address: 54321 Elm Street, Dallas, Texas 54321
   :Postal Code: 54321
   :State: TX
   :Street: 54321 Elm Street

data/examples/auto_invoice_splitter_extraction.rb

@@ -2,42 +2,47 @@
 
 require 'mindee'
 
-# Init a new client
-mindee_client = Mindee::Client.new(api_key: 'my-api-key')
-
-# Load a file from disk
-input_source = mindee_client.source_from_path('/path/to/the/file.ext')
-
-if input_source.pdf?
-  pdf_extractor = Mindee::Extraction::PdfExtractor.new(input_source)
-  if pdf_extractor.page_count > 1
-    invoice_splitter_response = mindee_client.enqueue_and_parse(
-      input_source,
-      Mindee::Product::InvoiceSplitter::InvoiceSplitterV1
-    )
-    page_groups = invoice_splitter_response.document.inference.prediction.invoice_page_groups
-    extracted_pdfs = pdf_extractor.extract_invoices(page_groups, strict: false)
-    extracted_pdfs.each do |extracted_pdf|
-      # Optional: Save the files locally
-      # extracted_pdf.write_to_file("output/path")
-
-      invoice_result = mindee_client.parse(
-        InvoiceV4,
-        extracted_pdf.as_source
-      )
-      puts invoice_result
-    end
+def invoice_splitter_auto_extraction(file_path)
+  mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+  input_source = mindee_client.source_from_path(file_path)
+
+  if input_source.pdf? && input_source.count_pdf_pages > 1
+    parse_multi_page(mindee_client, input_source)
   else
-    invoice_result = mindee_client.parse(
-      input_source,
-      Mindee::Product::Invoice::InvoiceV4
-    )
-    puts invoice_result.document
+    parse_single_page(mindee_client, input_source)
   end
-else
+end
+
+def parse_single_page(mindee_client, input_source)
   invoice_result = mindee_client.parse(
     input_source,
     Mindee::Product::Invoice::InvoiceV4
   )
   puts invoice_result.document
 end
+
+def parse_multi_page(mindee_client, input_source)
+  pdf_extractor = Mindee::Extraction::PdfExtractor::PdfExtractor.new(input_source)
+  invoice_splitter_response = mindee_client.enqueue_and_parse(
+    input_source,
+    Mindee::Product::InvoiceSplitter::InvoiceSplitterV1,
+    close_file: false
+  )
+  page_groups = invoice_splitter_response.document.inference.prediction.invoice_page_groups
+  extracted_pdfs = pdf_extractor.extract_invoices(page_groups, strict: false)
+
+  extracted_pdfs.each do |extracted_pdf|
+    # Optional: Save the files locally
+    # extracted_pdf.write_to_file("output/path")
+
+    invoice_result = mindee_client.parse(
+      extracted_pdf.as_input_source,
+      Mindee::Product::Invoice::InvoiceV4,
+      close_file: false
+    )
+    puts invoice_result.document
+  end
+end
+
+my_file_path = '/path/to/the/file.ext'
+invoice_splitter_auto_extraction(my_file_path)

data/examples/auto_multi_receipts_detector_extraction.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'mindee'
+require 'mindee/extraction'
+
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+def multi_receipts_detection(file_path, mindee_client)
+  input_source = mindee_client.source_from_path(file_path)
+
+  result_split = mindee_client.parse(
+    input_source,
+    Mindee::Product::MultiReceiptsDetector::MultiReceiptsDetectorV1,
+    close_file: false
+  )
+
+  images = Mindee::Extraction::MultiReceiptsExtractor.extract_receipts(input_source, result_split.document.inference)
+  images.each do |sub_image|
+    # Optional: Save the files locally
+    # sub_image.write_to_file("/path/to/my/extracted/file/folder")
+
+    result_receipt = mindee_client.parse(
+      sub_image.as_source,
+      Mindee::Product::Receipt::ReceiptV5,
+      close_file: false
+    )
+    puts result_receipt.document
+  end
+end
+
+my_file_path = '/path/to/the/file.ext'
+multi_receipts_detection(my_file_path, mindee_client)

data/lib/mindee/extraction/common/extracted_image.rb

@@ -4,7 +4,7 @@ require_relative '../../input/sources'
 
 module Mindee
   # Image Extraction Module.
-  module ImageExtraction
+  module Extraction
     # Generic class for image extraction.
     class ExtractedImage
       # Id of the page the image was extracted from.

data/lib/mindee/extraction/common/image_extractor.rb

@@ -9,180 +9,183 @@ require_relative 'extracted_image'
 
 module Mindee
   # Image Extraction Module.
-  module ImageExtraction
-    def self.attach_image_as_new_file(input_buffer)
-      # Attaches an image as a new page in a PdfDocument object.
-      #
-      # @param [StringIO] input_buffer Input buffer. Only supports JPEG.
-      # @return [Origami::PDF] A PdfDocument handle.
-
-      magick_image = MiniMagick::Image.read(input_buffer)
-      # NOTE: some jpeg images get rendered as three different versions of themselves per output if the format isn't
-      # converted.
-      magick_image.format('jpg')
-      original_density = magick_image.resolution
-      scale_factor = original_density[0].to_f / 4.166666 # No clue why bit the resolution needs to be reduced for
-      # the pdf otherwise the resulting image shrinks.
-      magick_image.format('pdf', 0, { density: scale_factor.to_s })
-      Origami::PDF.read(StringIO.new(magick_image.to_blob))
-    end
+  module Extraction
+    # Image Extraction wrapper class.
+    class ImageExtractor
+      def self.attach_image_as_new_file(input_buffer)
+        # Attaches an image as a new page in a PdfDocument object.
+        #
+        # @param [StringIO] input_buffer Input buffer. Only supports JPEG.
+        # @return [Origami::PDF] A PdfDocument handle.
+
+        magick_image = MiniMagick::Image.read(input_buffer)
+        # NOTE: some jpeg images get rendered as three different versions of themselves per output if the format isn't
+        # converted.
+        magick_image.format('jpg')
+        original_density = magick_image.resolution
+        scale_factor = original_density[0].to_f / 4.166666 # No clue why bit the resolution needs to be reduced for
+        # the pdf otherwise the resulting image shrinks.
+        magick_image.format('pdf', 0, { density: scale_factor.to_s })
+        Origami::PDF.read(StringIO.new(magick_image.to_blob))
+      end
 
-    # Extracts multiple images from a given local input source.
-    #
-    # @param [Mindee::Input::Source::LocalInputSource] input_source
-    # @param [Integer] page_id ID of the Page to extract from.
-    # @param [Array<Array<Mindee::Geometry::Point>>, Array<Mindee::Geometry::Quadrangle>] polygons List of coordinates
-    # to extract.
-    # @return [Array<Mindee::ImageExtraction::ExtractedImage>] Extracted Images.
-    def extract_multiple_images_from_source(input_source, page_id, polygons)
-      new_stream = load_doc(input_source, page_id)
-      new_stream.seek(0)
-
-      extract_images_from_polygons(input_source, new_stream, page_id, polygons)
-    end
+      # Extracts multiple images from a given local input source.
+      #
+      # @param [Mindee::Input::Source::LocalInputSource] input_source
+      # @param [Integer] page_id ID of the Page to extract from.
+      # @param [Array<Array<Mindee::Geometry::Point>>, Array<Mindee::Geometry::Quadrangle>] polygons List of coordinates
+      # to extract.
+      # @return [Array<Mindee::Extraction::ExtractedImage>] Extracted Images.
+      def self.extract_multiple_images_from_source(input_source, page_id, polygons)
+        new_stream = load_doc(input_source, page_id)
+        new_stream.seek(0)
+
+        extract_images_from_polygons(input_source, new_stream, page_id, polygons)
+      end
 
-    # Retrieves a PDF document's page.
-    #
-    # @param [Origami::PDF] pdf_doc Origami PDF handle.
-    # @param [Integer] page_id Page ID.
-    def get_page(pdf_doc, page_id)
-      stream = StringIO.new
-      pdf_doc.save(stream)
+      # Retrieves a PDF document's page.
+      #
+      # @param [Origami::PDF] pdf_doc Origami PDF handle.
+      # @param [Integer] page_id Page ID.
+      def self.get_page(pdf_doc, page_id)
+        stream = StringIO.new
+        pdf_doc.save(stream)
 
-      options = {
-        page_indexes: [page_id - 1],
-      }
+        options = {
+          page_indexes: [page_id - 1],
+        }
 
-      Mindee::PDF::PdfProcessor.parse(stream, options)
-    end
+        Mindee::PDF::PdfProcessor.parse(stream, options)
+      end
 
-    # Extracts images from their positions on a file (as polygons).
-    #
-    # @param [Mindee::Input::Source::LocalInputSource] input_source Local input source.
-    # @param [StringIO] pdf_stream Buffer of the PDF.
-    # @param [Integer] page_id Page ID.
-    # @param [Array<Mindee::Geometry::Point, Mindee::Geometry::Polygon, Mindee::Geometry::Quadrangle>] polygons
-    # @return [Array<Mindee::ImageExtraction::ExtractedImage>] Extracted Images.
-    def extract_images_from_polygons(input_source, pdf_stream, page_id, polygons)
-      extracted_elements = []
-
-      polygons.each_with_index do |polygon, element_id|
-        polygon = normalize_polygon(polygon)
-        page_content = read_page_content(pdf_stream)
-
-        min_max_x = Geometry.get_min_max_x([
-                                             polygon.top_left,
-                                             polygon.bottom_right,
-                                             polygon.top_right,
-                                             polygon.bottom_left,
-                                           ])
-        min_max_y = Geometry.get_min_max_y([
-                                             polygon.top_left,
-                                             polygon.bottom_right,
-                                             polygon.top_right,
-                                             polygon.bottom_left,
-                                           ])
-        file_extension = determine_file_extension(input_source)
-        cropped_image = crop_image(page_content, min_max_x, min_max_y)
-        if file_extension == 'pdf'
-          cropped_image.format('jpg')
-        else
-          cropped_image.format(file_extension)
+      # Extracts images from their positions on a file (as polygons).
+      #
+      # @param [Mindee::Input::Source::LocalInputSource] input_source Local input source.
+      # @param [StringIO] pdf_stream Buffer of the PDF.
+      # @param [Integer] page_id Page ID.
+      # @param [Array<Mindee::Geometry::Point, Mindee::Geometry::Polygon, Mindee::Geometry::Quadrangle>] polygons
+      # @return [Array<Mindee::Extraction::ExtractedImage>] Extracted Images.
+      def self.extract_images_from_polygons(input_source, pdf_stream, page_id, polygons)
+        extracted_elements = []
+
+        polygons.each_with_index do |polygon, element_id|
+          polygon = normalize_polygon(polygon)
+          page_content = read_page_content(pdf_stream)
+
+          min_max_x = Geometry.get_min_max_x([
+                                               polygon.top_left,
+                                               polygon.bottom_right,
+                                               polygon.top_right,
+                                               polygon.bottom_left,
+                                             ])
+          min_max_y = Geometry.get_min_max_y([
+                                               polygon.top_left,
+                                               polygon.bottom_right,
+                                               polygon.top_right,
+                                               polygon.bottom_left,
+                                             ])
+          file_extension = determine_file_extension(input_source)
+          cropped_image = crop_image(page_content, min_max_x, min_max_y)
+          if file_extension == 'pdf'
+            cropped_image.format('jpg')
+          else
+            cropped_image.format(file_extension)
+          end
+
+          buffer = StringIO.new
+          write_image_to_buffer(cropped_image, buffer)
+          file_name = "#{input_source.filename}_page#{page_id}-#{element_id}.#{file_extension}"
+
+          extracted_elements << create_extracted_image(buffer, file_name, page_id, element_id)
         end
 
-        buffer = StringIO.new
-        write_image_to_buffer(cropped_image, buffer)
-        file_name = "#{input_source.filename}_page#{page_id}-#{element_id}.#{file_extension}"
-
-        extracted_elements << create_extracted_image(buffer, file_name, page_id, element_id)
+        extracted_elements
       end
 
-      extracted_elements
-    end
-
-    # Retrieves the bounding box of a polygon.
-    #
-    # @param [Array<Point>, Mindee::Geometry::Polygon] polygon
-    def normalize_polygon(polygon)
-      if polygon.is_a?(Mindee::Geometry::Polygon)
-        Mindee::Geometry.get_bounding_box(polygon)
-      else
-        polygon
+      # Retrieves the bounding box of a polygon.
+      #
+      # @param [Array<Point>, Mindee::Geometry::Polygon] polygon
+      def self.normalize_polygon(polygon)
+        if polygon.is_a?(Mindee::Geometry::Polygon)
+          Mindee::Geometry.get_bounding_box(polygon)
+        else
+          polygon
+        end
       end
-    end
 
-    # Loads a buffer into a MiniMagick Image.
-    #
-    # @param [StringIO] pdf_stream Buffer containg the PDF
-    # @return [MiniMagick::Image] a valid MiniMagick image handle.
-    def read_page_content(pdf_stream)
-      pdf_stream.rewind
-      MiniMagick::Image.read(pdf_stream)
-    end
+      # Loads a buffer into a MiniMagick Image.
+      #
+      # @param [StringIO] pdf_stream Buffer containg the PDF
+      # @return [MiniMagick::Image] a valid MiniMagick image handle.
+      def self.read_page_content(pdf_stream)
+        pdf_stream.rewind
+        MiniMagick::Image.read(pdf_stream)
+      end
 
-    # Crops a MiniMagick Image from a the given bounding box.
-    #
-    # @param [MiniMagick::Image] image Input Image.
-    # @param [Mindee::Geometry::MinMax] min_max_x minimum & maximum values for the x coordinates.
-    # @param [Mindee::Geometry::MinMax] min_max_y minimum & maximum values for the y coordinates.
-    def crop_image(image, min_max_x, min_max_y)
-      width = image[:width].to_i
-      height = image[:height].to_i
-
-      image.format('jpg')
-      new_width = (min_max_x.max - min_max_x.min) * width
-      new_height = (min_max_y.max - min_max_y.min) * height
-      image.crop("#{new_width}x#{new_height}+#{min_max_x.min * width}+#{min_max_y.min * height}")
-
-      image
-    end
+      # Crops a MiniMagick Image from a the given bounding box.
+      #
+      # @param [MiniMagick::Image] image Input Image.
+      # @param [Mindee::Geometry::MinMax] min_max_x minimum & maximum values for the x coordinates.
+      # @param [Mindee::Geometry::MinMax] min_max_y minimum & maximum values for the y coordinates.
+      def self.crop_image(image, min_max_x, min_max_y)
+        width = image[:width].to_i
+        height = image[:height].to_i
+
+        image.format('jpg')
+        new_width = (min_max_x.max - min_max_x.min) * width
+        new_height = (min_max_y.max - min_max_y.min) * height
+        image.crop("#{new_width}x#{new_height}+#{min_max_x.min * width}+#{min_max_y.min * height}")
+
+        image
+      end
 
-    # Writes a MiniMagick::Image to a buffer.
-    #
-    # @param [MiniMagick::Image] image a valid MiniMagick image.
-    # @param [StringIO] buffer
-    def write_image_to_buffer(image, buffer)
-      image.write(buffer)
-    end
+      # Writes a MiniMagick::Image to a buffer.
+      #
+      # @param [MiniMagick::Image] image a valid MiniMagick image.
+      # @param [StringIO] buffer
+      def self.write_image_to_buffer(image, buffer)
+        image.write(buffer)
+      end
 
-    # Retrieves the file extension from the main file to apply it to the extracted images. Note: coerces pdf as jpg.
-    #
-    # @param [Mindee::Input::Source::LocalInputSource] input_source Local input source.
-    # @return [String] A valid file extension.
-    def determine_file_extension(input_source)
-      if input_source.pdf? || input_source.filename.downcase.end_with?('pdf')
-        'jpg'
-      else
-        File.extname(input_source.filename).strip.downcase[1..]
+      # Retrieves the file extension from the main file to apply it to the extracted images. Note: coerces pdf as jpg.
+      #
+      # @param [Mindee::Input::Source::LocalInputSource] input_source Local input source.
+      # @return [String] A valid file extension.
+      def self.determine_file_extension(input_source)
+        if input_source.pdf? || input_source.filename.downcase.end_with?('pdf')
+          'jpg'
+        else
+          File.extname(input_source.filename).strip.downcase[1..]
+        end
       end
-    end
 
-    # Generates an ExtractedImage.
-    #
-    # @param [StringIO] buffer Buffer containing the image.
-    # @param [String] file_name Name for the file.
-    # @param [Object] page_id ID of the page the file was generated from.
-    # @param [Object] element_id ID of the element of a given page.
-    def create_extracted_image(buffer, file_name, page_id, element_id)
-      buffer.rewind
-      ExtractedImage.new(
-        Mindee::Input::Source::BytesInputSource.new(buffer.read, file_name),
-        page_id,
-        element_id
-      )
-    end
+      # Generates an ExtractedImage.
+      #
+      # @param [StringIO] buffer Buffer containing the image.
+      # @param [String] file_name Name for the file.
+      # @param [Object] page_id ID of the page the file was generated from.
+      # @param [Object] element_id ID of the element of a given page.
+      def self.create_extracted_image(buffer, file_name, page_id, element_id)
+        buffer.rewind
+        ExtractedImage.new(
+          Mindee::Input::Source::BytesInputSource.new(buffer.read, file_name),
+          page_id,
+          element_id
+        )
+      end
 
-    # Loads a single_page from an image file or a pdf document.
-    #
-    # @param input_file [LocalInputSource] Local input.
-    # @param [Integer] page_id Page ID.
-    # @return [MiniMagick::Image] A valid PdfDocument handle.
-    def load_doc(input_file, page_id)
-      input_file.io_stream.rewind
-      if input_file.pdf?
-        get_page(Origami::PDF.read(input_file.io_stream), page_id)
-      else
-        input_file.io_stream
+      # Loads a single_page from an image file or a pdf document.
+      #
+      # @param input_file [LocalInputSource] Local input.
+      # @param [Integer] page_id Page ID.
+      # @return [MiniMagick::Image] A valid PdfDocument handle.
+      def self.load_doc(input_file, page_id)
+        input_file.io_stream.rewind
+        if input_file.pdf?
+          get_page(Origami::PDF.read(input_file.io_stream), page_id)
+        else
+          input_file.io_stream
+        end
       end
     end
   end

data/lib/mindee/extraction/multi_receipts_extractor/multi_receipts_extractor.rb

@@ -1,26 +1,32 @@
 # frozen_string_literal: true
 
+require_relative '../common/image_extractor'
+
 module Mindee
   # Image Extraction Module.
-  module ImageExtraction
-    def extract_receipts(input_source, inference)
-      # Extracts individual receipts from multi-receipts documents.
-      #
-      # @param input_source [LocalInputSource] Local Input Source to extract sub-receipts from.
-      # @param inference [Inference] Results of the inference.
-      # @return [Array<ExtractedImage>] Individual extracted receipts as an array of ExtractedMultiReceiptsImage.
+  module Extraction
+    # Multi-receipts extraction class wrapper.
+    class MultiReceiptsExtractor
+      def self.extract_receipts(input_source, inference)
+        # Extracts individual receipts from multi-receipts documents.
+        #
+        # @param input_source [LocalInputSource] Local Input Source to extract sub-receipts from.
+        # @param inference [Inference] Results of the inference.
+        # @return [Array<ExtractedImage>] Individual extracted receipts as an array of ExtractedMultiReceiptsImage.
 
-      images = []
-      raise 'No possible receipts candidates found for MultiReceipts extraction.' unless inference.prediction.receipts
+        images = []
+        raise 'No possible receipts candidates found for MultiReceipts extraction.' unless inference.prediction.receipts
 
-      (0...input_source.count_pdf_pages).each do |page_id|
-        receipt_positions = inference.pages[page_id].prediction.receipts.map(&:bounding_box)
-        images.concat(
-          extract_multiple_images_from_source(input_source, page_id + 1, receipt_positions)
-        )
-      end
+        (0...input_source.count_pdf_pages).each do |page_id|
+          receipt_positions = inference.pages[page_id].prediction.receipts.map(&:bounding_box)
+          images.concat(
+            Mindee::Extraction::ImageExtractor.extract_multiple_images_from_source(input_source, page_id + 1,
+                                                                                   receipt_positions)
+          )
+        end
 
-      images
+        images
+      end
     end
   end
 end

data/lib/mindee/extraction/pdf_extractor/pdf_extractor.rb

@@ -13,7 +13,7 @@ module Mindee
           if local_input.pdf?
             @source_pdf = local_input.io_stream
           else
-            pdf_image = ImageExtraction.attach_image_as_new_file(local_input.io_stream)
+            pdf_image = Extraction::ImageExtractor.attach_image_as_new_file(local_input.io_stream)
             io_buffer = StringIO.new
             pdf_image.save(io_buffer)
 

data/lib/mindee/parsing/standard/date_field.rb

@@ -18,11 +18,15 @@ module Mindee
         # The textual representation of the date as found on the document.
         # @return [String, nil]
         attr_reader :raw
+        # Whether the field was computed or retrieved directly from the document.
+        # @return [Boolean, nil]
+        attr_reader :is_computed
 
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
           super
+          @is_computed = prediction['is_computed']
           return unless @value
 
           @date_object = Date.parse(@value)

data/lib/mindee/product/financial_document/financial_document_v1_document.rb

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_line_item'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.9 document data.
+      # Financial Document API version 1.10 document data.
       class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -48,6 +48,12 @@ module Mindee
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
+        # The date on which the payment is due / fullfilled.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :payment_date
+        # The purchase order number.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :po_number
         # The receipt number or identifier only if document is a receipt.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :receipt_number
@@ -123,6 +129,8 @@ module Mindee
             @line_items.push(FinancialDocumentV1LineItem.new(item, page_id))
           end
           @locale = LocaleField.new(prediction['locale'], page_id)
+          @payment_date = DateField.new(prediction['payment_date'], page_id)
+          @po_number = StringField.new(prediction['po_number'], page_id)
           @receipt_number = StringField.new(prediction['receipt_number'], page_id)
           @reference_numbers = []
           prediction['reference_numbers'].each do |item|
@@ -161,11 +169,13 @@ module Mindee
           out_str = String.new
           out_str << "\n:Locale: #{@locale}".rstrip
           out_str << "\n:Invoice Number: #{@invoice_number}".rstrip
+          out_str << "\n:Purchase Order Number: #{@po_number}".rstrip
           out_str << "\n:Receipt Number: #{@receipt_number}".rstrip
           out_str << "\n:Document Number: #{@document_number}".rstrip
           out_str << "\n:Reference Numbers: #{reference_numbers}".rstrip
           out_str << "\n:Purchase Date: #{@date}".rstrip
           out_str << "\n:Due Date: #{@due_date}".rstrip
+          out_str << "\n:Payment Date: #{@payment_date}".rstrip
           out_str << "\n:Total Net: #{@total_net}".rstrip
           out_str << "\n:Total Amount: #{@total_amount}".rstrip
           out_str << "\n:Taxes:#{@taxes}".rstrip

data/lib/mindee/product/financial_document/financial_document_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_document'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.9 page data.
+      # Financial Document API version 1.10 page data.
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

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

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_line_item'
 module Mindee
   module Product
     module Invoice
-      # Invoice API version 4.7 document data.
+      # Invoice API version 4.8 document data.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -42,6 +42,12 @@ module Mindee
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
+        # The date on which the payment is due/ was full-filled.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :payment_date
+        # The purchase order number.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :po_number
         # List of Reference numbers, including PO number.
         # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :reference_numbers
@@ -103,6 +109,8 @@ module Mindee
             @line_items.push(InvoiceV4LineItem.new(item, page_id))
           end
           @locale = LocaleField.new(prediction['locale'], page_id)
+          @payment_date = DateField.new(prediction['payment_date'], page_id)
+          @po_number = StringField.new(prediction['po_number'], page_id)
           @reference_numbers = []
           prediction['reference_numbers'].each do |item|
             @reference_numbers.push(StringField.new(item, page_id))
@@ -137,9 +145,11 @@ module Mindee
           out_str = String.new
           out_str << "\n:Locale: #{@locale}".rstrip
           out_str << "\n:Invoice Number: #{@invoice_number}".rstrip
+          out_str << "\n:Purchase Order Number: #{@po_number}".rstrip
           out_str << "\n:Reference Numbers: #{reference_numbers}".rstrip
           out_str << "\n:Purchase Date: #{@date}".rstrip
           out_str << "\n:Due Date: #{@due_date}".rstrip
+          out_str << "\n:Payment Date: #{@payment_date}".rstrip
           out_str << "\n:Total Net: #{@total_net}".rstrip
           out_str << "\n:Total Amount: #{@total_amount}".rstrip
           out_str << "\n:Total Tax: #{@total_tax}".rstrip

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

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_document'
 module Mindee
   module Product
     module Invoice
-      # Invoice API version 4.7 page data.
+      # Invoice API version 4.8 page data.
       class InvoiceV4Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.13.0'
+  VERSION = '3.14.0'
 
   # Finds and return the current platform.
   # @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.14.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -198,6 +198,7 @@ files:
 - docs/us_mail_v2.md
 - docs/us_w9_v1.md
 - examples/auto_invoice_splitter_extraction.rb
+- examples/auto_multi_receipts_detector_extraction.rb
 - lib/mindee.rb
 - lib/mindee/client.rb
 - lib/mindee/extraction.rb