mindee 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f26259f4793d7a6c22538752dccf0c509298fa6223c53b1ecbe7655e6097faa
-  data.tar.gz: 96033b30171bee1e5117a64460fedecbdbbe86e950704875bb0d3eb03e66c05e
+  metadata.gz: f00779540f774eb2c4bc4a83883814113aabdbc3b293cf95ec1133299d0e2c24
+  data.tar.gz: 24265bc41edc341e215b931d40dee8510161a4d0e138548fbd6c730d24b34305
 SHA512:
-  metadata.gz: c8e51951deec5d25e5c19a0448cb055e0531e59836d2b21d0b51a019155adfe100582ba636fd2e14233f146cefdafcfc04a55435b02db508efff9d9a6774ce50
-  data.tar.gz: 816b54d06da35b3075d0f353bb330b5cc1ef8a42e6669161f9db48b2148b86f0e02f6a205c38bba952e67777d3a7b604b14c73249af3cb6cd888f52834e05277
+  metadata.gz: 8ec16d69e4d1ac27c9f55aad4c2b19cb85a5525fd380715480c4d1b2cc182bf18ef097d2cd18434f09394283a9c45aed20f55e372765a4b0642521f390be939d
+  data.tar.gz: 7749294d1125bf82156cc0dab68f6f370f14ad9afdb3480f33de9aec8ba3502c6049596b27942e2d5b76e8873aa3e6978a3ecd9cc585ecbe9aa197b6e5118b7c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Mindee Ruby API Library Changelog
 
+## v4.1.1 - 2025-03-25
+### Fixes
+* :wrench: loosen pinning on base64 dependency
+
+
+## v4.1.0 - 2025-03-25
+### Changes
+* :sparkles: bump FR EnergyBillV1 to V1.2 & US HealthcareCardV1 to V1.1
+* :sparkles: restore support for US Mail V2
+* :sparkles: add support for RAG in workflow executions
+### Fixes
+* :recycle: update CLI syntax for easier product creation
+
 ## v4.0.0 - 2025-02-27
 ### ¡Breaking Changes!
 * :boom: drop support for ruby versions < 3.0

data/bin/cli_products.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+PRODUCTS = {
+  "universal" => {
+    description: "Universal document type from API builder",
+    doc_class: Mindee::Product::Universal::Universal,
+    sync: true,
+    async: true,
+  },
+  "barcode-reader" => {
+    description: "Barcode Reader",
+    doc_class: Mindee::Product::BarcodeReader::BarcodeReaderV1,
+    sync: true,
+    async: false,
+  },
+  "bill-of-lading" => {
+    description: "Bill of Lading",
+    doc_class: Mindee::Product::BillOfLading::BillOfLadingV1,
+    sync: false,
+    async: true,
+  },
+  "business-card" => {
+    description: "Business Card",
+    doc_class: Mindee::Product::BusinessCard::BusinessCardV1,
+    sync: false,
+    async: true,
+  },
+  "cropper" => {
+    description: "Cropper",
+    doc_class: Mindee::Product::Cropper::CropperV1,
+    sync: true,
+    async: false,
+  },
+  "delivery-note" => {
+    description: "Delivery note",
+    doc_class: Mindee::Product::DeliveryNote::DeliveryNoteV1,
+    sync: false,
+    async: true,
+  },
+  "driver-license" => {
+    description: "Driver License",
+    doc_class: Mindee::Product::DriverLicense::DriverLicenseV1,
+    sync: false,
+    async: true,
+  },
+  "financial-document" => {
+    description: "Financial Document",
+    doc_class: Mindee::Product::FinancialDocument::FinancialDocumentV1,
+    sync: true,
+    async: true,
+  },
+  "fr-bank-account-details" => {
+    description: "Bank Account Details",
+    doc_class: Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2,
+    sync: true,
+    async: false,
+  },
+  "fr-bank-statement" => {
+    description: "Bank Statement",
+    doc_class: Mindee::Product::FR::BankStatement::BankStatementV2,
+    sync: false,
+    async: true,
+  },
+  "fr-carte-grise" => {
+    description: "Carte Grise",
+    doc_class: Mindee::Product::FR::CarteGrise::CarteGriseV1,
+    sync: true,
+    async: false,
+  },
+  "fr-energy-bill" => {
+    description: "Energy Bill",
+    doc_class: Mindee::Product::FR::EnergyBill::EnergyBillV1,
+    sync: false,
+    async: true,
+  },
+  "fr-health-card" => {
+    description: "Health Card",
+    doc_class: Mindee::Product::FR::HealthCard::HealthCardV1,
+    sync: false,
+    async: true,
+  },
+  "fr-carte-nationale-d-identite" => {
+    description: "Carte Nationale d'Identité",
+    doc_class: Mindee::Product::FR::IdCard::IdCardV2,
+    sync: true,
+    async: false,
+  },
+  "fr-payslip" => {
+    description: "Payslip",
+    doc_class: Mindee::Product::FR::Payslip::PayslipV3,
+    sync: false,
+    async: true,
+  },
+  "ind-passport-india" => {
+    description: "Passport - India",
+    doc_class: Mindee::Product::IND::IndianPassport::IndianPassportV1,
+    sync: false,
+    async: true,
+  },
+  "international-id" => {
+    description: "International ID",
+    doc_class: Mindee::Product::InternationalId::InternationalIdV2,
+    sync: false,
+    async: true,
+  },
+  "invoice" => {
+    description: "Invoice",
+    doc_class: Mindee::Product::Invoice::InvoiceV4,
+    sync: true,
+    async: true,
+  },
+  "invoice-splitter" => {
+    description: "Invoice Splitter",
+    doc_class: Mindee::Product::InvoiceSplitter::InvoiceSplitterV1,
+    sync: false,
+    async: true,
+  },
+  "multi-receipts-detector" => {
+    description: "Multi Receipts Detector",
+    doc_class: Mindee::Product::MultiReceiptsDetector::MultiReceiptsDetectorV1,
+    sync: true,
+    async: false,
+  },
+  "nutrition-facts-label" => {
+    description: "Nutrition Facts Label",
+    doc_class: Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1,
+    sync: false,
+    async: true,
+  },
+  "passport" => {
+    description: "Passport",
+    doc_class: Mindee::Product::Passport::PassportV1,
+    sync: true,
+    async: false,
+  },
+  "receipt" => {
+    description: "Receipt",
+    doc_class: Mindee::Product::Receipt::ReceiptV5,
+    sync: true,
+    async: true,
+  },
+  "resume" => {
+    description: "Resume",
+    doc_class: Mindee::Product::Resume::ResumeV1,
+    sync: false,
+    async: true,
+  },
+  "us-bank-check" => {
+    description: "Bank Check",
+    doc_class: Mindee::Product::US::BankCheck::BankCheckV1,
+    sync: true,
+    async: false,
+  },
+  "us-healthcare-card" => {
+    description: "Healthcare Card",
+    doc_class: Mindee::Product::US::HealthcareCard::HealthcareCardV1,
+    sync: false,
+    async: true,
+  },
+  "us-us-mail" => {
+    description: "US Mail",
+    doc_class: Mindee::Product::US::UsMail::UsMailV3,
+    sync: false,
+    async: true,
+  },
+  "us-w9" => {
+    description: "W9",
+    doc_class: Mindee::Product::US::W9::W9V1,
+    sync: true,
+    async: false,
+  },
+}

data/bin/mindee.rb

@@ -5,122 +5,7 @@ require 'bundler/setup'
 require 'optparse'
 require 'mindee'
 
-DOCUMENTS = {
-  "universal" => {
-    description: "Universal document type from API builder",
-    doc_class: Mindee::Product::Universal::Universal,
-    sync: true,
-    async: true,
-  },
-  "cropper" => {
-    description: 'Cropper',
-    doc_class: Mindee::Product::Cropper::CropperV1,
-    sync: true,
-    async: false,
-  },
-  "financial-document" => {
-    description: 'Financial Document',
-    doc_class: Mindee::Product::FinancialDocument::FinancialDocumentV1,
-    sync: true,
-    async: true,
-  },
-  "invoice" => {
-    description: 'Invoice',
-    doc_class: Mindee::Product::Invoice::InvoiceV4,
-    sync: true,
-    async: true,
-  },
-  "international-id" => {
-    description: 'International Id',
-    doc_class: Mindee::Product::InternationalId::InternationalIdV2,
-    sync: false,
-    async: true,
-  },
-  "receipt" => {
-    description: "Expense Receipt",
-    doc_class: Mindee::Product::Receipt::ReceiptV5,
-    sync: true,
-    async: true,
-  },
-  "driver-license" => {
-    description: "Driver License",
-    doc_class: Mindee::Product::DriverLicense::DriverLicenseV1,
-    sync: false,
-    async: true,
-  },
-  "resume" => {
-    description: "Resume",
-    doc_class: Mindee::Product::Resume::ResumeV1,
-    sync: false,
-    async: true,
-  },
-  "passport" => {
-    description: "Passport",
-    doc_class: Mindee::Product::Passport::PassportV1,
-    sync: true,
-    async: false,
-  },
-  "eu-license-plate" => {
-    description: "EU License Plate",
-    doc_class: Mindee::Product::EU::LicensePlate::LicensePlateV1,
-    sync: true,
-    async: false,
-  },
-  "fr-bank-account-details" => {
-    description: "FR Bank Account Details",
-    doc_class: Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2,
-    sync: true,
-    async: false,
-  },
-  "fr-bank-statement" => {
-    description: "FR Bank Statement",
-    doc_class: Mindee::Product::FR::BankStatement::BankStatementV2,
-    sync: false,
-    async: true,
-  },
-  "fr-id-card" => {
-    description: "FR ID Card",
-    doc_class: Mindee::Product::FR::IdCard::IdCardV2,
-    sync: true,
-    async: false,
-  },
-  "fr-health-card" => {
-    description: "FR Health Card",
-    doc_class: Mindee::Product::FR::HealthCard::HealthCardV1,
-    sync: false,
-    async: true,
-  },
-  "fr-payslip" => {
-    description: "FR Payslip",
-    doc_class: Mindee::Product::FR::Payslip::PayslipV3,
-    sync: false,
-    async: true,
-  },
-  "us-bank-check" => {
-    description: "US Bank Check",
-    doc_class: Mindee::Product::US::BankCheck::BankCheckV1,
-    sync: true,
-    async: false,
-  },
-  "us-heathcare-card" => {
-    description: "US Healthcare Card",
-    doc_class: Mindee::Product::US::HealthcareCard::HealthcareCardV1,
-    sync: false,
-    async: true
-  },
-  "us-w9" => {
-    description: "US W9 Form",
-    doc_class: Mindee::Product::US::W9::W9V1,
-    sync: true,
-    async: false
-  },
-  "invoice-splitter" => {
-    description: "US Bank Check",
-    doc_class: Mindee::Product::InvoiceSplitter::InvoiceSplitterV1,
-    sync: false,
-    async: true,
-  },
-}
+require_relative 'cli_products'
 
 options = {}
 
@@ -136,7 +21,7 @@ def custom_subcommand(cli_parser, options)
 end
 
 product_parser = {}
-DOCUMENTS.each do |doc_key, doc_value|
+PRODUCTS.each do |doc_key, doc_value|
   product_parser[doc_key] = OptionParser.new do |opts|
     opts.on('-w', '--all-words', 'Include words in response') do |v|
       options[:all_words] = v
@@ -170,14 +55,14 @@ end
 global_parser = OptionParser.new do |opts|
   opts.banner = "Usage: mindee.rb product [options] file"
   opts.separator "Available products:"
-  opts.separator "  #{DOCUMENTS.keys.join("\n  ")}"
+  opts.separator "  #{PRODUCTS.keys.join("\n  ")}"
 end
 
 command = ARGV.shift
-unless DOCUMENTS.include?(command)
+unless PRODUCTS.include?(command)
   abort(global_parser.help)
 end
-doc_class = DOCUMENTS[command][:doc_class]
+doc_class = PRODUCTS[command][:doc_class]
 product_parser[command].parse!
 
 if command == 'universal'
@@ -224,7 +109,7 @@ else
 end
 
 if options[:parse_async].nil?
-  if !DOCUMENTS[command][:sync]
+  if !PRODUCTS[command][:sync]
     options[:parse_async] = true
   else
     options[:parse_async] = false

data/docs/advanced_file_operations.md

@@ -6,10 +6,8 @@ parentDoc: 6294d97ee723f1008d2ab28e
 ---
 
 > ❗️ Disclaimer: the file operations listed below do not directly manipulate the files you will pass to the library,
-> they will instead create a copy before applying any operations, which means that the file you send may not be an
-> exact copy of the file the server will receive.
-> To avoid any unexpected or unwanted result, you can save a copy of the created file locally to inspect it visually
-> before sending it.
+> They will instead create a copy before applying any operations, which means that the file you send may not be an exact copy of the file the server will receive.
+> To avoid any unexpected or unwanted result, you can save a copy of the created file locally to inspect it visually before sending it.
 
 ## Image compression
 
@@ -32,17 +30,16 @@ input_source.compress!(quality: 85, max_width: 1024, max_height: 768)
 
 For reference, here's what the following levels of compression on this image will look like:
 
-Original:
+**Original:**
 ![Invoice sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoices/default_sample.jpg?raw=true)
 
-
-85% compressed:
+**85% compressed:**
 ![85% sample](https://github.com/mindee/client-lib-test-data/blob/main/file_operations/compression/compressed_ruby_85.jpg?raw=true)
 
-50% compressed:
+**50% compressed:**
 ![50% sample](https://github.com/mindee/client-lib-test-data/blob/main/file_operations/compression/compressed_ruby_50.jpg?raw=true)
 
-10% compressed:
+**10% compressed:**
 ![10% sample](https://github.com/mindee/client-lib-test-data/blob/main/file_operations/compression/compressed_ruby_10.jpg?raw=true)
 
 
@@ -76,6 +73,7 @@ File.write(output_file_path, pdf_input.io_stream.read)
 
 > 🚧 Be warned that the source text (the text embedded in the PDF itself) might not render properly,
 > and so source PDFs will be ignored by default.
+> 
 > You can bypass this using:
 
 ```rb

data/docs/code_samples/invoice_splitter_v1_async.txt

@@ -11,6 +11,7 @@ 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')
 
+# Parse the file
 result = mindee_client.parse(
   input_source,
   Mindee::Product::InvoiceSplitter::InvoiceSplitterV1
@@ -20,4 +21,4 @@ result = mindee_client.parse(
 puts result.document
 
 # Print the document-level parsed data
-# puts result.document.inference.prediction
+# puts result.document.inference.prediction

data/docs/code_samples/{license_plates_v1.txt → us_mail_v2_async.txt}

@@ -14,7 +14,7 @@ input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 # Parse the file
 result = mindee_client.parse(
   input_source,
-  Mindee::Product::EU::LicensePlate::LicensePlateV1
+  Mindee::Product::US::UsMail::UsMailV2
 )
 
 # Print a full summary of the parsed data in RST format

data/docs/code_samples/workflow_execution.txt

@@ -0,0 +1,28 @@
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
+require_relative 'mindee'
+
+workflow_id = 'workflow-id'
+
+# Init a new client
+mindee_client = Mindee::Client.new
+
+# Load a file from disk
+input_source = mindee_client.source_from_path('path/to/my/file.ext')
+
+# Send the file to the workflow
+result = mindee_client.execute_workflow(
+  input_source,
+  workflow_id,
+# options: { # Optionally, you can provide the following parameters:
+#   document_alias: 'my-document-alias', # Potential alias for the document
+#   priority: Mindee::Parsing::Common::ExecutionPriority::LOW, # Priority of the execution
+#   rag: true # Whether to enable Retrieval-Augmented Generation
+# }
+)
+
+# Print the execution's ID to make sure it worked
+puts result.execution.id

data/docs/getting_started.md

@@ -4,7 +4,7 @@ category: 622b805aaec68102ea7fcbc2
 slug: ruby-getting-started
 parentDoc: 6294d97ee723f1008d2ab28e
 ---
-This guide will help you get the most out of the Mindee Ruby client library to easily extract data from your documents.
+> 📘 This guide will help you get the most out of the Mindee Ruby client library to easily extract data from your documents.
 
 ## Installation
 

data/docs/global_products/barcode_reader_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Barcode Reader
+title: Barcode Reader
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-barcode-reader-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products/bill_of_lading_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Bill of Lading
+title: Bill of Lading
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-bill-of-lading-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products/business_card_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Business Card
+title: Business Card
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-business-card-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products/cropper_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Cropper
+title: Cropper
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-cropper-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products/delivery_notes_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Delivery note
+title: Delivery note
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-delivery-note-ocr
 parentDoc: 67b49df15b843f3fa9cd622b
@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Delivery note API](https://platform.mindee
 > | Specification                  | Details                                            |
 > | ------------------------------ | -------------------------------------------------- |
 > | Endpoint Name                  | `delivery_notes`                                   |
-> | Recommended Version            | `v1.1`                                             |
+> | Recommended Version            | `v1.2`                                             |
 > | Supports Polling/Webhooks      | ✔️ Yes                                             |
 > | Support Synchronous HTTP Calls | ❌ No                                              |
 > | Geography                      | 🌐 Global                                          |

data/docs/global_products/driver_license_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Driver License
+title: Driver License
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-driver-license-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products/expense_receipts_v5.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Receipt
+title: Receipt
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-receipt-ocr
 parentDoc: 67b49df15b843f3fa9cd622b
@@ -239,7 +239,7 @@ objects, it has access to a custom `to_s` method that can render a `TaxField` ob
 Fields which are specific to this product; they are not used in any other product.
 
 ### Line Items Field
-List of line item details.
+List of all line items on the receipt.
 
 A `ReceiptV5LineItem` implements the following attributes:
 
@@ -252,17 +252,17 @@ A `ReceiptV5LineItem` implements the following attributes:
 The following fields are extracted for Receipt V5:
 
 ## Purchase Category
-**category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
+**category** ([ClassificationField](#classification-field)): The purchase category of the receipt.
 
 #### Possible values include:
- - toll
- - food
- - parking
- - transport
- - accommodation
- - gasoline
- - telecom
- - miscellaneous
+ - 'toll'
+ - 'food'
+ - 'parking'
+ - 'transport'
+ - 'accommodation'
+ - 'gasoline'
+ - 'telecom'
+ - 'miscellaneous'
 
 ```rb
 puts result.document.inference.prediction.category.value
@@ -276,18 +276,18 @@ puts result.document.inference.prediction.date.value
 ```
 
 ## Document Type
-**document_type** ([ClassificationField](#classification-field)): One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
+**document_type** ([ClassificationField](#classification-field)): The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
 
 #### Possible values include:
- - expense_receipt
- - credit_card_receipt
+ - 'EXPENSE RECEIPT'
+ - 'CREDIT CARD RECEIPT'
 
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```
 
 ## Line Items
-**line_items** (Array<[ReceiptV5LineItem](#line-items-field)>): List of line item details.
+**line_items** (Array<[ReceiptV5LineItem](#line-items-field)>): List of all line items on the receipt.
 
 ```rb
 result.document.inference.prediction.line_items do |line_items_elem|
@@ -296,7 +296,7 @@ end
 ```
 
 ## Expense Locale
-**locale** ([LocaleField](#locale-field)): The locale detected on the document.
+**locale** ([LocaleField](#locale-field)): The locale of the document.
 
 ```rb
 puts result.document.inference.prediction.locale.value
@@ -310,14 +310,15 @@ puts result.document.inference.prediction.receipt_number.value
 ```
 
 ## Purchase Subcategory
-**subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
+**subcategory** ([ClassificationField](#classification-field)): The purchase subcategory of the receipt for transport and food.
 
 #### Possible values include:
- - plane
- - taxi
- - train
- - restaurant
- - shopping
+ - 'plane'
+ - 'taxi'
+ - 'train'
+ - 'restaurant'
+ - 'shopping'
+ - nil
 
 ```rb
 puts result.document.inference.prediction.subcategory.value
@@ -331,7 +332,7 @@ puts result.document.inference.prediction.supplier_address.value
 ```
 
 ## Supplier Company Registrations
-**supplier_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registrations associated to the supplier.
+**supplier_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registration numbers associated to the supplier.
 
 ```rb
 result.document.inference.prediction.supplier_company_registrations do |supplier_company_registrations_elem|
@@ -354,7 +355,7 @@ puts result.document.inference.prediction.supplier_phone_number.value
 ```
 
 ## Taxes
-**taxes** (Array<[TaxField](#taxes-field)>): List of tax lines information.
+**taxes** (Array<[TaxField](#taxes-field)>): The list of taxes present on the receipt.
 
 ```rb
 result.document.inference.prediction.taxes do |taxes_elem|
@@ -391,7 +392,7 @@ puts result.document.inference.prediction.total_net.value
 ```
 
 ## Total Tax
-**total_tax** ([AmountField](#amount-field)): The total amount of taxes.
+**total_tax** ([AmountField](#amount-field)): The sum of all taxes.
 
 ```rb
 puts result.document.inference.prediction.total_tax.value