mindee 3.19.1 → 4.0.0

data/docs/{us_mail_v3.md → localized_products/us_mail_v3.md}

@@ -1,16 +1,42 @@
 ---
-title: US US Mail OCR Ruby
+title: Ruby Client Library - US US Mail
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-us-us-mail-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [US Mail API](https://platform.mindee.com/mindee/us_mail).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+The Ruby Client Library supports the [US Mail API](https://platform.mindee.com/mindee/us_mail).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `us_mail`                                          |
+> | Recommended Version            | `v3.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🇺🇸 United States                                   |
+
+> 🔐 Polling Limitations
+>
+> | Setting                         | Parameter name          | Default Value |
+> | ------------------------------- | ----------------------- | ------------- |
+> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
+> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
+> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![US Mail sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -20,7 +46,7 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
   Mindee::Product::US::UsMail::UsMailV3
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -73,12 +98,12 @@ These fields are generic and used in several products.
 Each prediction object contains a set of fields that inherit from the generic `Field` class.
 A typical `Field` object will have the following attributes:
 
-* **value** (`String`, `Float`, `Integer`, `Boolean`): corresponds to the field value. Can be `nil` if no value was extracted.
+* **value** (`String`, `Float`, `Integer`, `bool`): corresponds to the field value. Can be `nil` if no value was extracted.
 * **confidence** (Float, nil): the confidence score of the field prediction.
 * **bounding_box** (`Mindee::Geometry::Quadrilateral`, `nil`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
 * **polygon** (`Mindee::Geometry::Polygon`, `nil`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
 * **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 
 Aside from the previous attributes, all basic fields have access to a `to_s` method that can be used to print their value as a string.
@@ -89,6 +114,18 @@ The text field `StringField` only has one constraint: it's **value** is a `Strin
 ## Specific Fields
 Fields which are specific to this product; they are not used in any other product.
 
+### Sender Address Field
+The address of the sender.
+
+A `UsMailV3SenderAddress` implements the following attributes:
+
+* `city` (String): The city of the sender's address.
+* `complete` (String): The complete address of the sender.
+* `postal_code` (String): The postal code of the sender's address.
+* `state` (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+* `street` (String): The street of the sender's address.
+Fields which are specific to this product; they are not used in any other product.
+
 ### Recipient Addresses Field
 The addresses of the recipients.
 
@@ -96,24 +133,12 @@ A `UsMailV3RecipientAddress` implements the following attributes:
 
 * `city` (String): The city of the recipient's address.
 * `complete` (String): The complete address of the recipient.
-* `is_address_change` (Boolean): Indicates if the recipient's address is a change of address.
+* `is_address_change` (bool): Indicates if the recipient's address is a change of address.
 * `postal_code` (String): The postal code of the recipient's address.
 * `private_mailbox_number` (String): The private mailbox number of the recipient's address.
 * `state` (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
 * `street` (String): The street of the recipient's address.
 * `unit` (String): The unit number of the recipient's address.
-Fields which are specific to this product; they are not used in any other product.
-
-### Sender Address Field
-The address of the sender.
-
-A `UsMailV3SenderAddress` implements the following attributes:
-
-* `city` (String): The city of the sender's address.
-* `complete` (String): The complete address of the sender.
-* `postal_code` (String): The postal code of the sender's address.
-* `state` (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
-* `street` (String): The street of the sender's address.
 
 # Attributes
 The following fields are extracted for US Mail V3:
@@ -129,7 +154,7 @@ puts result.document.inference.prediction.is_return_to_sender.value
 **recipient_addresses** (Array<[UsMailV3RecipientAddress](#recipient-addresses-field)>): The addresses of the recipients.
 
 ```rb
-for recipient_addresses_elem in result.document.inference.prediction.recipient_addresses do
+result.document.inference.prediction.recipient_addresses do |recipient_addresses_elem|
   puts recipient_addresses_elem.value
 end
 ```
@@ -138,7 +163,7 @@ end
 **recipient_names** (Array<[StringField](#string-field)>): The names of the recipients.
 
 ```rb
-for recipient_names_elem in result.document.inference.prediction.recipient_names do
+result.document.inference.prediction.recipient_names do |recipient_names_elem|
   puts recipient_names_elem.value
 end
 ```

data/docs/{us_w9_v1.md → localized_products/us_w9_v1.md}

@@ -1,16 +1,34 @@
 ---
-title: US W9 OCR Ruby
+title: Ruby Client Library - US W9
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-us-w9-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [W9 API](https://platform.mindee.com/mindee/us_w9).
+The Ruby Client Library supports the [W9 API](https://platform.mindee.com/mindee/us_w9).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_w9/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `us_w9`                                            |
+> | Recommended Version            | `v1.0`                                             |
+> | Supports Polling/Webhooks      | ❌ No                                              |
+> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
+> | Geography                      | 🇺🇸 United States                                   |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_w9/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![W9 sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_w9/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -27,7 +45,6 @@ result = mindee_client.parse(
 
 # Print a full summary of the parsed data in RST format
 puts result.document
-
 ```
 
 **Output (RST):**
@@ -73,21 +90,23 @@ These fields are generic and used in several products.
 Each prediction object contains a set of fields that inherit from the generic `Field` class.
 A typical `Field` object will have the following attributes:
 
-* **value** (`String`, `Float`, `Integer`, `Boolean`): corresponds to the field value. Can be `nil` if no value was extracted.
+* **value** (`String`, `Float`, `Integer`, `bool`): corresponds to the field value. Can be `nil` if no value was extracted.
 * **confidence** (Float, nil): the confidence score of the field prediction.
 * **bounding_box** (`Mindee::Geometry::Quadrilateral`, `nil`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
 * **polygon** (`Mindee::Geometry::Polygon`, `nil`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
 * **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 
 Aside from the previous attributes, all basic fields have access to a `to_s` method that can be used to print their value as a string.
 
 
 ### Position Field
-The position field `PositionField` does not implement all the basic `Field` attributes, only **bounding_box**, **polygon** and **page_id**. On top of these, it has access to:
+The position field `PositionField` does not implement all the basic `Field` attributes, only **bounding_box**,
+**polygon** and **page_id**. On top of these, it has access to:
 
-* **rectangle** (`Mindee::Geometry::Quadrilateral`): a Polygon with four points that may be oriented (even beyond canvas).
+* **rectangle** (`Mindee::Geometry::Quadrilateral`): a Polygon with four points that may be oriented (even beyond
+canvas).
 * **quadrangle** (`Mindee::Geometry::Quadrilateral`): a free polygon made up of four points.
 
 ### String Field
@@ -103,108 +122,108 @@ The following fields are extracted for W9 V1:
 [📄](#page-level-fields "This field is only present on individual pages.")**address** ([StringField](#string-field)): The street address (number, street, and apt. or suite no.) of the applicant.
 
 ```rb
-for address_elem in result.document.address do
-  puts address_elem.value
-end
+  result.document.address.each do |address_elem|
+    puts address_elem.value
+  end
 ```
 
 ## Business Name
 [📄](#page-level-fields "This field is only present on individual pages.")**business_name** ([StringField](#string-field)): The business name or disregarded entity name, if different from Name.
 
 ```rb
-for business_name_elem in result.document.business_name do
-  puts business_name_elem.value
-end
+  result.document.business_name.each do |business_name_elem|
+    puts business_name_elem.value
+  end
 ```
 
 ## City State Zip
 [📄](#page-level-fields "This field is only present on individual pages.")**city_state_zip** ([StringField](#string-field)): The city, state, and ZIP code of the applicant.
 
 ```rb
-for city_state_zip_elem in result.document.city_state_zip do
-  puts city_state_zip_elem.value
-end
+  result.document.city_state_zip.each do |city_state_zip_elem|
+    puts city_state_zip_elem.value
+  end
 ```
 
 ## EIN
 [📄](#page-level-fields "This field is only present on individual pages.")**ein** ([StringField](#string-field)): The employer identification number.
 
 ```rb
-for ein_elem in result.document.ein do
-  puts ein_elem.value
-end
+  result.document.ein.each do |ein_elem|
+    puts ein_elem.value
+  end
 ```
 
 ## Name
 [📄](#page-level-fields "This field is only present on individual pages.")**name** ([StringField](#string-field)): Name as shown on the applicant's income tax return.
 
 ```rb
-for name_elem in result.document.name do
-  puts name_elem.value
-end
+  result.document.name.each do |name_elem|
+    puts name_elem.value
+  end
 ```
 
 ## Signature Date Position
 [📄](#page-level-fields "This field is only present on individual pages.")**signature_date_position** ([PositionField](#position-field)): Position of the signature date on the document.
 
 ```rb
-for signature_date_position_elem in result.document.signature_date_position do
-  puts signature_date_position_elem.polygon
-end
+  result.document.signature_date_position.each do |signature_date_position_elem|
+    puts signature_date_position_elem.polygon
+  end
 ```
 
 ## Signature Position
 [📄](#page-level-fields "This field is only present on individual pages.")**signature_position** ([PositionField](#position-field)): Position of the signature on the document.
 
 ```rb
-for signature_position_elem in result.document.signature_position do
-  puts signature_position_elem.polygon
-end
+  result.document.signature_position.each do |signature_position_elem|
+    puts signature_position_elem.polygon
+  end
 ```
 
 ## SSN
 [📄](#page-level-fields "This field is only present on individual pages.")**ssn** ([StringField](#string-field)): The applicant's social security number.
 
 ```rb
-for ssn_elem in result.document.ssn do
-  puts ssn_elem.value
-end
+  result.document.ssn.each do |ssn_elem|
+    puts ssn_elem.value
+  end
 ```
 
 ## Tax Classification
 [📄](#page-level-fields "This field is only present on individual pages.")**tax_classification** ([StringField](#string-field)): The federal tax classification, which can vary depending on the revision date.
 
 ```rb
-for tax_classification_elem in result.document.tax_classification do
-  puts tax_classification_elem.value
-end
+  result.document.tax_classification.each do |tax_classification_elem|
+    puts tax_classification_elem.value
+  end
 ```
 
 ## Tax Classification LLC
 [📄](#page-level-fields "This field is only present on individual pages.")**tax_classification_llc** ([StringField](#string-field)): Depending on revision year, among S, C, P or D for Limited Liability Company Classification.
 
 ```rb
-for tax_classification_llc_elem in result.document.tax_classification_llc do
-  puts tax_classification_llc_elem.value
-end
+  result.document.tax_classification_llc.each do |tax_classification_llc_elem|
+    puts tax_classification_llc_elem.value
+  end
 ```
 
 ## Tax Classification Other Details
 [📄](#page-level-fields "This field is only present on individual pages.")**tax_classification_other_details** ([StringField](#string-field)): Tax Classification Other Details.
 
 ```rb
-for tax_classification_other_details_elem in result.document.tax_classification_other_details do
-  puts tax_classification_other_details_elem.value
-end
+  result.document.tax_classification_other_details.each do |tax_classification_other_details_elem|
+    puts tax_classification_other_details_elem.value
+  end
 ```
 
 ## W9 Revision Date
 [📄](#page-level-fields "This field is only present on individual pages.")**w9_revision_date** ([StringField](#string-field)): The Revision month and year of the W9 form.
 
 ```rb
-for w9_revision_date_elem in result.document.w9_revision_date do
-  puts w9_revision_date_elem.value
-end
+  result.document.w9_revision_date.each do |w9_revision_date_elem|
+    puts w9_revision_date_elem.value
+  end
 ```
 
 # Questions?

data/docs/localized_products.md

@@ -0,0 +1,6 @@
+---
+title: Localized Products
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-localized-products
+parentDoc: 6294d97ee723f1008d2ab28e
+---

data/examples/auto_invoice_splitter_extraction.rb

@@ -6,7 +6,7 @@ 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
+  if input_source.pdf? && input_source.count_pages > 1
     parse_multi_page(mindee_client, input_source)
   else
     parse_single_page(mindee_client, input_source)
@@ -22,11 +22,11 @@ def parse_single_page(mindee_client, input_source)
 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(
+  pdf_extractor = Mindee::PDF::PDFExtractor::PDFExtractor.new(input_source)
+  invoice_splitter_response = mindee_client.parse(
     input_source,
     Mindee::Product::InvoiceSplitter::InvoiceSplitterV1,
-    close_file: false
+    options: { close_file: false }
   )
   page_groups = invoice_splitter_response.document.inference.prediction.invoice_page_groups
   extracted_pdfs = pdf_extractor.extract_invoices(page_groups, strict: false)
@@ -38,7 +38,7 @@ def parse_multi_page(mindee_client, input_source)
     invoice_result = mindee_client.parse(
       extracted_pdf.as_input_source,
       Mindee::Product::Invoice::InvoiceV4,
-      close_file: false
+      options: { close_file: false }
     )
     puts invoice_result.document
   end

data/examples/auto_multi_receipts_detector_extraction.rb

@@ -1,19 +1,18 @@
 # 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(
+  result_multi_receipts = mindee_client.parse(
     input_source,
     Mindee::Product::MultiReceiptsDetector::MultiReceiptsDetectorV1,
-    close_file: false
+    options: { close_file: false }
   )
 
-  images = Mindee::Extraction::MultiReceiptsExtractor.extract_receipts(input_source, result_split.document.inference)
+  images = Mindee::Extraction.extract_receipts(input_source, result_multi_receipts.document.inference)
   images.each do |sub_image|
     # Optional: Save the files locally
     # sub_image.write_to_file("/path/to/my/extracted/file/folder")
@@ -21,7 +20,7 @@ def multi_receipts_detection(file_path, mindee_client)
     result_receipt = mindee_client.parse(
       sub_image.as_source,
       Mindee::Product::Receipt::ReceiptV5,
-      close_file: false
+      options: { close_file: false }
     )
     puts result_receipt.document
   end