mindee 4.0.0 → 4.1.1

data/docs/loading_a_document.md

@@ -7,10 +7,11 @@ parentDoc: 6294d97ee723f1008d2ab28e
 
 ## Calling the Mindee API using webhooks
 
-> 🚧 This feature is only available for compatible products, see the see `Supports Polling/Webhooks` on the product's
-> documentation.
+> 🚧 This feature is only available for compatible products.
+> 
+> See the `Supports Polling/Webhooks` section on the product's documentation.
 
-After [setting up a webhook for your account](https://developers.mindee.com/docs/webhooks), you can send a document,
+After [setting up a webhook for your account](https://developers.mindee.com/docs/webhooks), you can send a document,  
 and then retrieve the results from an API call in the following fashion:
 
 ```rb
@@ -24,7 +25,7 @@ enqueue_response = mindee_client.enqueue(
 )
 ```
 
-Once your prediction is ready, the server will send it to your webhook. You can then use the payload as a regular
+Once your prediction is ready, the server will send it to your webhook. You can then use the payload as a regular  
 prediction:
 
 ```rb
@@ -54,63 +55,25 @@ result = mindee_client.load_prediction(
 puts result.document
 ```
 
-## Enqueueing and polling manually
-
-> ❗️ We _strongly_ recommend you rely on a webhook setup, or a simple `parse()` call for most operations. Only use
-> manual polling if you are certain that it is the best solution for you.
-
-> 🚧 This feature is only available for compatible products, see the see `Supports Polling/Webhooks` on the product's
-> documentation.
-
-Instead of relying on the `parse()` method, you can enqueue documents and poll
-the server manually:
-
-```rb
-# Load a file from disk
-input_source = mindee_client.source_from_path('/path/to/the/file.ext')
-
-# Send the file to the server
-enqueue_response = mindee_client.enqueue(
-  input_source,
-  Mindee::Product::Invoice::InvoiceV4 # InvoiceV4 supports asynchronous polling
-)
-
-job_id = enqueue_response.job.id
-
-queue_res = parse_queued(job_id, Mindee::Product::Invoice::InvoiceV4, endpoint: endpoint)
-polling_attempts = 0
-
-while [Mindee::Parsing::Common::JobStatus::PROCESSING, Mindee::Parsing::Common::JobStatus::WAITING].include?(
-        queue_res.job.status) && polling_attempts < 80 # Recommended amounts of total retries for asynchronous polling.
-  sleep(1.5) # Recommended waiting time for re-attempts
-  queue_res = parse_queued(job_id, Mindee::Product::Invoice::InvoiceV4)
-  polling_attempts += 1
-end
-
-# If all went well, print a short summary of the result.
-if queue_res.job.status == Mindee::Parsing::Common::JobStatus::COMPLETED
-  puts queue_res.document
-end
-```
-
 ## Parsing operations
 
-Operations pertaining to the Client's `parse()` method. The parsing process supports both synchronous and asynchronous
-modes, and you can fine-tune its behavior using several options.
+Operations pertaining to the Client's `parse()` method.
+The parsing process supports both synchronous and asynchronous modes, and you can fine-tune its behavior using several options.
 
 ### Polling options
 
 When performing an asynchronous parse (i.e. when the document is enqueued), the client will poll the API for the result.
 The following options control the polling behavior:
 
-- `initial_delay_sec`: The initial delay (in seconds) before the first polling attempt.
-- `delay_sec`: The delay (in seconds) between subsequent polls.
-- `max_retries`: The maximum number of polling attempts before timing out.
+* `initial_delay_sec`: The initial delay (in seconds) before the first polling attempt.
+* `delay_sec`: The delay (in seconds) between subsequent polls.
+* `max_retries`: The maximum number of polling attempts before timing out.
 
-These parameters ensure that the client does not overload the API with too-frequent requests and also avoid premature
+These parameters ensure that the client does not overload the API with too-frequent requests and also avoid premature  
 timeouts.
 
 Example:
+
 ```rb
 result = mindee_client.parse(
   input_source,
@@ -122,16 +85,19 @@ result = mindee_client.parse(
   }
 )
 ```
-> ⚠️ Warning: Setting `delay_sec` too low might lead to insufficient wait time between polls, causing the server to
-> block your API calls for a short time.
+
+> ⚠️ Warning: Setting `delay_sec` too low might lead to insufficient wait time between polls.
+> 
+> This will cause the server to block your API calls for a short time (HTTP 429 errors).
 
 ### Page operations
 
-When parsing PDFs, you can preprocess the document using page operations. Using the `page_options` parameter, you can
-specify which pages to keep or remove even before the file is sent to the server. This is especially useful if your
-document contains extraneous pages that you do not want to process.
+When parsing PDFs, you can preprocess the document using page operations.
+Using the `page_options` parameter, you can specify which pages to keep or remove even before the file is sent to the server.
+This is especially useful if your document contains extraneous pages that you do not want to process.
 
 The available options are:
+
 * `page_indexes`: An array of zero-based page indexes.
 * `operation`: The operation to perform—either:
   * `:KEEP_ONLY` (keep only the specified pages)
@@ -139,6 +105,7 @@ The available options are:
 * `on_min_pages`: Apply the operation only if the document has at least the specified number of pages.
 
 Example:
+
 ```rb
 page_options = {
   page_indexes:[1, 3],    # Only target pages 1 and 3.
@@ -154,14 +121,17 @@ result = mindee_client.parse(
   }
 )
 ```
-> ⚠️ Warning: Page operations alter the document's content. Ensure that this behavior is acceptable for your use case,
-> as there is no undo once the pages are modified.
+
+> ⚠️ Warning: Page operations alter the document's content.
+> 
+> Ensure that this behavior is acceptable for your use case, as there is no undo once the pages are modified.
 
 ## Workflow operations
 
 Workflow operations are similar to parsing operations, but they apply to calls made through the workflow feature.
 
 Example:
+
 ```rb
 workflow_options = {
     document_alias: "my_document",
@@ -179,28 +149,68 @@ result = mindee_client.execute_workflow(
 )
 ```
 
+## Enqueueing and polling manually
+
+> ❗️ We _strongly_ recommend you use a webhook setup, or a simple`parse()` call for most operations.
+> 
+> Only use manual polling if you are **certain** that it is the best solution for you.
+
+> 🚧 This feature is only available for compatible products.
+> 
+> See the `Supports Polling/Webhooks` section on the product's documentation.
+
+Instead of relying on the `parse()` method, you can enqueue documents and poll  
+the server manually:
+
+```rb
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Send the file to the server
+enqueue_response = mindee_client.enqueue(
+  input_source,
+  Mindee::Product::Invoice::InvoiceV4 # InvoiceV4 supports asynchronous polling
+)
+
+job_id = enqueue_response.job.id
+
+queue_res = parse_queued(job_id, Mindee::Product::Invoice::InvoiceV4, endpoint: endpoint)
+polling_attempts = 0
+
+while [Mindee::Parsing::Common::JobStatus::PROCESSING, Mindee::Parsing::Common::JobStatus::WAITING].include?(
+        queue_res.job.status) && polling_attempts < 80 # Recommended amounts of total retries for asynchronous polling.
+  sleep(1.5) # Recommended waiting time for re-attempts
+  queue_res = parse_queued(job_id, Mindee::Product::Invoice::InvoiceV4)
+  polling_attempts += 1
+end
+
+# If all went well, print a short summary of the result.
+if queue_res.job.status == Mindee::Parsing::Common::JobStatus::COMPLETED
+  puts queue_res.document
+end
+```
+
 ## Loading a Document File
 
-Before sending a document to Mindee’s API, you first need to load the file into one of our input source wrappers.
-These wrappers not only validate the file type (using a trusted MIME type check) but also give you access the following
-helper methods:
+Before sending a document to Mindee’s API, you first need to load the file into one of our input source wrappers.  
+These wrappers not only validate the file type (using a trusted MIME type check) but also give you access the following helper methods:
+
 * [image compression](https://developers.mindee.com/docs/ruby-advanced-file-operations#image-compression)
 * [pdf compression](https://developers.mindee.com/docs/ruby-advanced-file-operations#pdf-compression)
 * [PDF fixing](https://developers.mindee.com/docs/ruby-advanced-file-operations#pdf-fixing)
 
 > 📘 Regardless of how a document is loaded, the subsequent parsing or workflow operations remain the same.
 
-
 Mindee’s Ruby client supports several methods for loading a document.
 
-
 These can either be done locally:
+
 * Loading from a [local path](#loading-from-a-local-path)
 * Loading from a [File object](#loading-from-a-file-object)
 * Loading from a [Base64-encoded string](#loading-from-a-base64-encoded-string)
 * Loading from a [raw sequence of bytes](#loading-from-raw-bytes)
 
-These four methods inherit from the `LocalInputSource` class, which provides a few common utility features described
+These four methods inherit from the `LocalInputSource` class, which provides a few common utility features described  
 [here](#under-the-hood---local-input-source-details).
 
 Or loading from a [URL](#loading-by-url).
@@ -210,6 +220,7 @@ Or loading from a [URL](#loading-by-url).
 The most straightforward way of loading a document: load a file directly from disk by providing its path.
 
 Example:
+
 ```rb
 # Initialize the client.
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
@@ -232,10 +243,9 @@ File.open('invoice.jpg', 'rb') do |file_obj|
 end
 ```
 
-
 ### Loading from a Base64-Encoded String
 
-For cases where you have file data encoded in Base64, load the document by providing the encoded string along with the
+For cases where you have file data encoded in Base64, load the document by providing the encoded string along with the  
 original filename. This converts the Base64 string into a local input source for further processing.
 
 Example:
@@ -246,10 +256,9 @@ b64_string = "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGB..." # Example dummy b64_
 input_source = mindee_client.source_from_b64string(b64_string, "receipt.jpg")
 ```
 
-
 ### Loading from Raw Bytes
 
-If you have the file’s raw binary data (as bytes), create an input source by passing the bytes and the original
+If you have the file’s raw binary data (as bytes), create an input source by passing the bytes and the original  
 filename.
 
 Example:
@@ -263,32 +272,36 @@ input_source = mindee_client.source_from_bytes(raw_bytes, "invoice.pdf")
 ### Loading by URL
 
 For remote documents, you can load a file through its URL. The server will accept direct urls if:
-* They begin with "https://".
+
+* They begin with "https\://".
 * They point to a valid file.
 * They do not redirect the request (e.g. Google Drive documents or proxies).
 
-Under the hood, the
-[Mindee::Input::Source::URLInputSource](https://mindee.github.io/mindee-api-ruby/Mindee/Input/Source/URLInputSource.html)
+Under the hood, the  
+[Mindee::Input::Source::URLInputSource](https://mindee.github.io/mindee-api-ruby/Mindee/Input/Source/URLInputSource.html)  
 class validates the URL, but won't perform an HTTP GET request unless specifically requested (using Ruby’s Net::HTTP).
 
 Example:
+
 ```rb
 input_source = mindee_client.source_from_url("https://www.example.com/invoice.pdf")
 result = mindee_client.parse(input_source, Mindee::Product::Invoice::InvoiceV4)
 ```
 
-To download the files before sending them, you can use the `as_local_input_source` method. It allows to follow
-redirects, and supports optional authentication (via basic auth or JWT tokens). You can optionally download and save the file locally or convert it into a local input source for further processing—thus benefiting from the same processing methods as local files.
+To download the files before sending them, you can use the `as_local_input_source` method.
+It allows to follow redirects, and supports optional authentication (via basic auth or JWT tokens).
+You can optionally download and save the file locally or convert it into a local input source for further processing—thus benefiting from the same processing methods as local files.
 
 Additional URL features include:
 
-* Validation: The URLInputSource throws an error if the URL does not start with “https://”.
+* Validation: The URLInputSource throws an error if the URL does not start with “https\://”.
 * Authentication: You can supply basic authentication (username/password) or a bearer token.
 * Local Conversion: Methods such as `write_to_file` let you download and inspect the file locally. Alternatively,
 * `as_local_input_source` converts the downloaded content into a LocalInputSource so you can apply operations like
 * compression.
 
 Example:
+
 ```rb
 # Load the URL input normally:
 remote_input_source = mindee_client.source_from_url("https://www.example.com/invoice.pdf")
@@ -302,7 +315,7 @@ local_downloaded_file_path = remote_input_source.write_to_file("path/to/my/downl
 
 ### Under the Hood - Local Input Source Details
 
-When loading using from either a path, file, raw byte sequence or base64 string, the created object inherits from
+When loading using from either a path, file, raw byte sequence or base64 string, the created object inherits from  
 [Mindee::Input::Source::LocalInputSource](https://mindee.github.io/mindee-api-ruby/Mindee/Input/Source/LocalInputSource.html). Key features include:
 
 * Automatic MIME Type Validation using Marcel to check for server file format compliance. 
@@ -313,4 +326,5 @@ When loading using from either a path, file, raw byte sequence or base64 string,
   * [count_pages](https://mindee.github.io/mindee-api-ruby/Mindee/Input/Source/LocalInputSource.html#count_pages-instance_method) – For PDF files, returns the total page count; by default, non-PDF files are assumed to be single-page documents.
 
 ## Questions?
+
 [Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/localized_products/bank_account_details_v2.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - FR Bank Account Details
+title: FR Bank Account Details
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-bank-account-details-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8

data/docs/localized_products/bank_check_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - US Bank Check
+title: US Bank Check
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-us-bank-check-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8

data/docs/localized_products/bank_statement_fr_v2.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - FR Bank Statement
+title: FR Bank Statement
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-bank-statement-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8

data/docs/localized_products/carte_grise_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - FR Carte Grise
+title: FR Carte Grise
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-carte-grise-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8

data/docs/localized_products/energy_bill_fra_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - FR Energy Bill
+title: FR Energy Bill
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-energy-bill-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8
@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Energy Bill API](https://platform.mindee.c
 > | Specification                  | Details                                            |
 > | ------------------------------ | -------------------------------------------------- |
 > | Endpoint Name                  | `energy_bill_fra`                                  |
-> | Recommended Version            | `v1.0`                                             |
+> | Recommended Version            | `v1.2`                                             |
 > | Supports Polling/Webhooks      | ✔️ Yes                                             |
 > | Support Synchronous HTTP Calls | ❌ No                                              |
 > | Geography                      | 🇫🇷 France                                          |
@@ -186,11 +186,19 @@ Details of energy consumption.
 
 A `EnergyBillV1EnergyUsage` implements the following attributes:
 
+* `consumption` (Float): The price per unit of energy consumed.
 * `description` (String): Description or details of the energy usage.
 * `end_date` (String): The end date of the energy usage.
 * `start_date` (String): The start date of the energy usage.
 * `tax_rate` (Float): The rate of tax applied to the total cost.
 * `total` (Float): The total cost of energy consumed.
+* `unit` (String): The unit of measurement for energy consumption.
+
+#### Possible values include:
+ - kWh
+ - m3
+ - L
+        
 * `unit_price` (Float): The price per unit of energy consumed.
 Fields which are specific to this product; they are not used in any other product.
 
@@ -221,7 +229,7 @@ A `EnergyBillV1MeterDetail` implements the following attributes:
  - water
  - None
         
-* `unit` (String): The unit of measurement for energy consumption, which can be kW, m³, or L.
+* `unit` (String): The unit of power for energy consumption.
 
 # Attributes
 The following fields are extracted for Energy Bill V1:

data/docs/localized_products/french_healthcard_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - FR Health Card
+title: FR Health Card
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-health-card-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8

data/docs/localized_products/idcard_fr_v2.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - FR Carte Nationale d'Identité
+title: FR Carte Nationale d'Identité
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-carte-nationale-didentite-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8
@@ -192,9 +192,9 @@ puts result.document.inference.prediction.document_number.value
 [📄](#page-level-fields "This field is only present on individual pages.")**document_side** ([ClassificationField](#classification-field)): The sides of the document which are visible.
 
 #### Possible values include:
- - RECTO
- - VERSO
- - RECTO & VERSO
+ - 'RECTO'
+ - 'VERSO'
+ - 'RECTO & VERSO'
 
 ```rb
   result.document.document_side.each do |document_side_elem|
@@ -206,8 +206,8 @@ puts result.document.inference.prediction.document_number.value
 [📄](#page-level-fields "This field is only present on individual pages.")**document_type** ([ClassificationField](#classification-field)): The document type or format.
 
 #### Possible values include:
- - NEW
- - OLD
+ - 'NEW'
+ - 'OLD'
 
 ```rb
   result.document.document_type.each do |document_type_elem|

data/docs/localized_products/ind_passport_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - IND Passport - India
+title: IND Passport - India
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-ind-passport---india-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8
@@ -194,8 +194,8 @@ puts result.document.inference.prediction.file_number.value
 **gender** ([ClassificationField](#classification-field)): The gender of the passport holder.
 
 #### Possible values include:
- - M
- - F
+ - 'M'
+ - 'F'
 
 ```rb
 puts result.document.inference.prediction.gender.value
@@ -289,8 +289,8 @@ puts result.document.inference.prediction.old_passport_place_of_issue.value
 **page_number** ([ClassificationField](#classification-field)): The page number of the passport document.
 
 #### Possible values include:
- - 1
- - 2
+ - '1'
+ - '2'
 
 ```rb
 puts result.document.inference.prediction.page_number.value

data/docs/localized_products/payslip_fra_v3.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - FR Payslip
+title: FR Payslip
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-payslip-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8

data/docs/localized_products/us_healthcare_cards_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - US Healthcare Card
+title: US Healthcare Card
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-us-healthcare-card-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8
@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Healthcare Card API](https://platform.mind
 > | Specification                  | Details                                            |
 > | ------------------------------ | -------------------------------------------------- |
 > | Endpoint Name                  | `us_healthcare_cards`                              |
-> | Recommended Version            | `v1.0`                                             |
+> | Recommended Version            | `v1.1`                                             |
 > | Supports Polling/Webhooks      | ✔️ Yes                                             |
 > | Support Synchronous HTTP Calls | ❌ No                                              |
 > | Geography                      | 🇺🇸 United States                                   |

data/docs/localized_products/us_mail_v3.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - US US Mail
+title: US US Mail
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-us-us-mail-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8

data/docs/localized_products/us_w9_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - US W9
+title: US W9
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-us-w9-ocr
 parentDoc: 67b49e29a2cd6f08d69a40d8

data/docs/localized_products.md

@@ -3,4 +3,4 @@ title: Localized Products
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-localized-products
 parentDoc: 6294d97ee723f1008d2ab28e
----
+---

data/lib/mindee/client.rb

@@ -80,6 +80,7 @@ module Mindee
   #   This performs a full OCR operation on the server and may increase response time.
   # @!attribute public_url [String, nil] A unique, encrypted URL for accessing the document validation interface without
   #   requiring authentication.
+  # @!attribute rag [bool, nil] Whether to enable Retrieval-Augmented Generation.
   # @!attribute page_options [PageOptions, Hash, nil] Page cutting/merge options:
   #   * `:page_indexes` Zero-based list of page indexes.
   #   * `:operation` Operation to apply on the document, given the specified page indexes:
@@ -87,7 +88,7 @@ module Mindee
   #       * `:REMOVE` - remove the specified pages, and keep all others.
   #   * `:on_min_pages` Apply the operation only if the document has at least this many pages.
   class WorkflowOptions
-    attr_accessor :document_alias, :priority, :full_text, :public_url, :page_options
+    attr_accessor :document_alias, :priority, :full_text, :public_url, :page_options, :rag
 
     def initialize(params: {})
       params = params.transform_keys(&:to_sym)
@@ -95,6 +96,7 @@ module Mindee
       @priority = params.fetch(:priority, nil)
       @full_text = params.fetch(:full_text, false)
       @public_url = params.fetch(:public_url, nil)
+      @rag = params.fetch(:rag, nil)
       raw_page_options = params.fetch(:page_options, nil)
       raw_page_options = PageOptions.new(params: raw_page_options) unless raw_page_options.is_a?(PageOptions)
       @page_options = raw_page_options
@@ -297,8 +299,6 @@ module Mindee
       queue_res
     end
 
-    # Same idea applies to execute_workflow:
-    #
     # Sends a document to a workflow.
     #
     # Accepts options either as a Hash or as a WorkflowOptions struct.
@@ -309,6 +309,7 @@ module Mindee
     #   * `document_alias` [String, nil] Alias to give to the document.
     #   * `priority` [Symbol, nil] Priority to give to the document.
     #   * `full_text` [bool] Whether to include the full OCR text response in compatible APIs.
+    #   * `rag` [bool, nil] Whether to enable Retrieval-Augmented Generation.
     #
     #   * `public_url` [String, nil] A unique, encrypted URL for accessing the document validation interface without
     # requiring authentication.
@@ -317,7 +318,7 @@ module Mindee
     #       * `:operation` Operation to apply on the document, given the `page_indexes specified:
     #          * `:KEEP_ONLY` - keep only the specified pages, and remove all others.
     #          * `:REMOVE` - remove the specified pages, and keep all others.
-    #      * `:on_min_pages` Apply the operation only if document has at least this many pa
+    #      * `:on_min_pages` Apply the operation only if document has at least this many pages.
     # @return [Mindee::Parsing::Common::WorkflowResponse]
     def execute_workflow(input_source, workflow_id, options: {})
       opts = options.is_a?(WorkflowOptions) ? options : WorkflowOptions.new(params: options)
@@ -331,10 +332,7 @@ module Mindee
 
       prediction, raw_http = workflow_endpoint.execute_workflow(
         input_source,
-        opts.full_text,
-        opts.document_alias,
-        opts.priority,
-        opts.public_url
+        opts
       )
 
       Mindee::Parsing::Common::WorkflowResponse.new(Product::Universal::Universal, prediction, raw_http)

data/lib/mindee/http/workflow_endpoint.rb

@@ -24,15 +24,17 @@ module Mindee
 
       # Sends a document to the workflow.
       # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
-      # @param document_alias [String, nil] Alias to give to the document.
-      # @param priority [Symbol, nil] Priority to give to the document.
-      # @param full_text [bool] Whether to include the full OCR text response in compatible APIs.
-      # @param public_url [String, nil] A unique, encrypted URL for accessing the document validation interface without
-      # requiring authentication.
+      # @param opts [WorkflowOptions] Options to configure workflow execution behavior.
       # @return [Array]
-      def execute_workflow(input_source, full_text, document_alias, priority, public_url)
+      def execute_workflow(input_source, opts)
         check_api_key
-        response = workflow_execution_req_post(input_source, document_alias, priority, full_text, public_url)
+        response = workflow_execution_req_post(input_source, opts)
+        if response.nil?
+          raise Mindee::Errors::MindeeHTTPError.new(
+            { code: 0, details: 'Server response was nil.', message: 'Unknown error.' }, @url, 0
+          )
+        end
+
         hashed_response = JSON.parse(response.body, object_class: Hash)
         return [hashed_response, response.body] if ResponseValidation.valid_async_response?(response)
 
@@ -42,31 +44,29 @@ module Mindee
       end
 
       # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
-      # @param document_alias [String, nil] Alias to give to the document.
-      # @param priority [Symbol, nil] Priority to give to the document.
-      # @param full_text [bool] Whether to include the full OCR text response in compatible APIs.
-      # @param public_url [String, nil] A unique, encrypted URL for accessing the document validation interface without
-      # requiring authentication.
+      # @param opts [WorkflowOptions] Options to configure workflow execution behavior.
       # @return [Net::HTTPResponse, nil]
-      def workflow_execution_req_post(input_source, document_alias, priority, full_text, public_url)
+      def workflow_execution_req_post(input_source, opts)
         uri = URI(@url)
         params = {} # : Hash[Symbol | String, untyped]
-        params[:full_text_ocr] = 'true' if full_text
-        uri.query = URI.encode_www_form(params)
+        params[:full_text_ocr] = 'true' if opts.full_text
+        params[:rag] = 'true' if opts.rag
+        uri.query = URI.encode_www_form(params) if params.any?
 
         headers = {
           'Authorization' => "Token #{@api_key}",
           'User-Agent' => USER_AGENT,
         }
         req = Net::HTTP::Post.new(uri, headers)
-        form_data = if input_source.is_a?(Mindee::Input::Source::URLInputSource)
-                      [['document', input_source.url]]
-                    else
-                      [input_source.read_contents]
-                    end
-        form_data.push ['alias', document_alias] if document_alias
-        form_data.push ['public_url', public_url] if public_url
-        form_data.push ['priority', priority.to_s] if priority
+        form_data = [] # : Array[untyped]
+        if input_source.is_a?(Mindee::Input::Source::URLInputSource)
+          form_data.push ['document', input_source.url]
+        else
+          form_data.push input_source.read_contents
+        end
+        form_data.push ['alias', opts.document_alias] if opts.document_alias
+        form_data.push ['public_url', opts.public_url] if opts.public_url
+        form_data.push ['priority', opts.priority.to_s] if opts.priority
 
         req.set_form(form_data, 'multipart/form-data')
 

data/lib/mindee/pdf/pdf_extractor.rb

@@ -46,7 +46,7 @@ module Mindee
           extension = File.extname(@filename)
           basename = File.basename(@filename, extension)
           page_indexes.each do |page_index_list|
-            if page_index_list.empty? || page_index_list.nil?
+            if page_index_list.nil? || page_index_list.empty?
               raise Errors::MindeePDFError, "Empty indexes aren't allowed for extraction #{page_index_list}"
             end
 
@@ -70,12 +70,12 @@ module Mindee
         # rubocop:disable Metrics/PerceivedComplexity
 
         # Extracts invoices as complete PDFs from the document.
-        # @param page_indexes [Array<Array<Integer>, InvoiceSplitterV1PageGroup>]
+        # @param page_indexes [Array<Array<Integer>, InvoiceSplitterV1InvoicePageGroup>]
         # @param strict [bool]
         # @return [Array<Mindee::PDF::PDFExtractor::ExtractedPDF>]
         def extract_invoices(page_indexes, strict: false)
           raise Errors::MindeePDFError, 'No indexes provided.' if page_indexes.empty?
-          unless page_indexes[0].is_a?(Mindee::Product::InvoiceSplitter::InvoiceSplitterV1PageGroup)
+          if page_indexes[0].is_a?(Array) && page_indexes[0].all? { |i| i.is_a?(Integer) }
             return extract_sub_documents(page_indexes)
           end
           return extract_sub_documents(page_indexes.map(&:page_indexes)) unless strict