mindee 3.19.1 → 4.0.0

data/docs/localized_products/bank_statement_fr_v2.md

@@ -0,0 +1,269 @@
+---
+title: Ruby Client Library - FR Bank Statement
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-bank-statement-ocr
+parentDoc: 67b49e29a2cd6f08d69a40d8
+---
+The Ruby Client Library supports the [Bank Statement API](https://platform.mindee.com/mindee/bank_statement_fr).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `bank_statement_fr`                                |
+> | Recommended Version            | `v2.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🇫🇷 France                                          |
+
+> 🔐 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/bank_statement_fr/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
+![Bank Statement sample](https://github.com/mindee/client-lib-test-data/blob/main/products/bank_statement_fr/default_sample.jpg?raw=true)
+
+# Quick-Start
+```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
+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')
+
+# Parse the file
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::FR::BankStatement::BankStatementV2
+)
+
+# Print a full summary of the parsed data in RST format
+puts result.document
+
+# Print the document-level parsed data
+# puts result.document.inference.prediction
+```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: 3c1811c0-9876-45ae-91ad-c2e9cd75dd83
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/bank_statement_fr v2.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:Account Number: XXXXXXXXXXXXXX
+:Bank Name: Banque lafinancepourtous
+:Bank Address: 1 rue de la Banque, 100210 Cassette
+:Client Names: Karine Plume
+:Client Address: 1 rue des Cigales, 100210 Cassette
+:Statement Date: 2002-02-28
+:Statement Start Date: 2002-02-01
+:Statement End Date: 2002-02-28
+:Opening Balance: 22.15
+:Closing Balance: -278.96
+:Transactions:
+  +------------+------------+--------------------------------------+
+  | Amount     | Date       | Description                          |
+  +============+============+======================================+
+  | 1240.00    | 2002-02-01 | Virement salaire                     |
+  +------------+------------+--------------------------------------+
+  | -520.00    | 2002-02-02 | Virement loyer                       |
+  +------------+------------+--------------------------------------+
+  | -312.00    | 2002-02-03 | Débit Carte nºxxxx                   |
+  +------------+------------+--------------------------------------+
+  | 12.47      | 2002-02-04 | Virement CPAM                        |
+  +------------+------------+--------------------------------------+
+  | 65.00      | 2002-02-05 | Virement APL                         |
+  +------------+------------+--------------------------------------+
+  | -110.00    | 2002-02-07 | Débit Carte nxxxxxxxxxxxxxxxx        |
+  +------------+------------+--------------------------------------+
+  | -3.30      | 2002-02-08 | Cotisation mensuelle carte bancaire  |
+  +------------+------------+--------------------------------------+
+  | -120.00    | 2002-02-09 | Chèque n° xxxxxx98                   |
+  +------------+------------+--------------------------------------+
+  | -60.00     | 2002-02-09 | Retrait espèces DAB                  |
+  +------------+------------+--------------------------------------+
+  | -55.00     | 2002-02-15 | Chèque n° xxxxxx99                   |
+  +------------+------------+--------------------------------------+
+  | -80.00     | 2002-02-16 | Prélèvement supercrédit              |
+  +------------+------------+--------------------------------------+
+  | -120.00    | 2002-02-17 | Chèque n° xxxxx 100                  |
+  +------------+------------+--------------------------------------+
+  | -163.25    | 2002-02-20 | Débit Carte nºxxxxxxxxxxxxx          |
+  +------------+------------+--------------------------------------+
+  | -25.50     | 2002-02-21 | Débit Carte n°xxxxxxxxxxxxxxxxxx     |
+  +------------+------------+--------------------------------------+
+  | -30.00     | 2002-02-24 | Prélèvement Opérateur téléphonique   |
+  +------------+------------+--------------------------------------+
+  | -6.53      | 2002-02-25 | Agios                                |
+  +------------+------------+--------------------------------------+
+  | -13.00     | 2002-02-28 | Frais irrégularités et incidents ... |
+  +------------+------------+--------------------------------------+
+:Total Debits: 1618.58
+:Total Credits: 1339.62
+```
+
+# Field Types
+## Standard Fields
+These fields are generic and used in several products.
+
+### Basic Field
+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`, `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** (`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.
+
+
+### Amount Field
+The amount field `AmountField` only has one constraint: its **value** is a `Float` (or `nil`).
+
+### Date Field
+Aside from the basic `Field` attributes, the date field `DateField` also implements the following:
+
+* **date_object** (`Date`): an accessible representation of the value as a JavaScript object.
+
+### String Field
+The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
+
+## Specific Fields
+Fields which are specific to this product; they are not used in any other product.
+
+### Transactions Field
+The list of values that represent the financial transactions recorded in a bank statement.
+
+A `BankStatementV2Transaction` implements the following attributes:
+
+* `amount` (Float): The monetary amount of the transaction.
+* `date` (String): The date on which the transaction occurred.
+* `description` (String): The additional information about the transaction.
+
+# Attributes
+The following fields are extracted for Bank Statement V2:
+
+## Account Number
+**account_number** ([StringField](#string-field)): The unique identifier for a customer's account in the bank's system.
+
+```rb
+puts result.document.inference.prediction.account_number.value
+```
+
+## Bank Address
+**bank_address** ([StringField](#string-field)): The physical location of the bank where the statement was issued.
+
+```rb
+puts result.document.inference.prediction.bank_address.value
+```
+
+## Bank Name
+**bank_name** ([StringField](#string-field)): The name of the bank that issued the statement.
+
+```rb
+puts result.document.inference.prediction.bank_name.value
+```
+
+## Client Address
+**client_address** ([StringField](#string-field)): The address of the client associated with the bank statement.
+
+```rb
+puts result.document.inference.prediction.client_address.value
+```
+
+## Client Names
+**client_names** (Array<[StringField](#string-field)>): The name of the clients who own the bank statement.
+
+```rb
+result.document.inference.prediction.client_names do |client_names_elem|
+  puts client_names_elem.value
+end
+```
+
+## Closing Balance
+**closing_balance** ([AmountField](#amount-field)): The final amount of money in the account at the end of the statement period.
+
+```rb
+puts result.document.inference.prediction.closing_balance.value
+```
+
+## Opening Balance
+**opening_balance** ([AmountField](#amount-field)): The initial amount of money in an account at the start of the period.
+
+```rb
+puts result.document.inference.prediction.opening_balance.value
+```
+
+## Statement Date
+**statement_date** ([DateField](#date-field)): The date on which the bank statement was generated.
+
+```rb
+puts result.document.inference.prediction.statement_date.value
+```
+
+## Statement End Date
+**statement_end_date** ([DateField](#date-field)): The date when the statement period ends.
+
+```rb
+puts result.document.inference.prediction.statement_end_date.value
+```
+
+## Statement Start Date
+**statement_start_date** ([DateField](#date-field)): The date when the bank statement period begins.
+
+```rb
+puts result.document.inference.prediction.statement_start_date.value
+```
+
+## Total Credits
+**total_credits** ([AmountField](#amount-field)): The total amount of money deposited into the account.
+
+```rb
+puts result.document.inference.prediction.total_credits.value
+```
+
+## Total Debits
+**total_debits** ([AmountField](#amount-field)): The total amount of money debited from the account.
+
+```rb
+puts result.document.inference.prediction.total_debits.value
+```
+
+## Transactions
+**transactions** (Array<[BankStatementV2Transaction](#transactions-field)>): The list of values that represent the financial transactions recorded in a bank statement.
+
+```rb
+result.document.inference.prediction.transactions do |transactions_elem|
+  puts transactions_elem.value
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

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

@@ -1,16 +1,34 @@
 ---
-title: FR Carte Grise OCR Ruby
+title: Ruby Client Library - FR Carte Grise
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-carte-grise-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [Carte Grise API](https://platform.mindee.com/mindee/carte_grise).
+The Ruby Client Library supports the [Carte Grise API](https://platform.mindee.com/mindee/carte_grise).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/carte_grise/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                  | `carte_grise`                                      |
+> | Recommended Version            | `v1.1`                                             |
+> | Supports Polling/Webhooks      | ❌ No                                              |
+> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
+> | Geography                      | 🇫🇷 France                                          |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/carte_grise/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Carte Grise sample](https://github.com/mindee/client-lib-test-data/blob/main/products/carte_grise/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -30,7 +48,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -146,18 +163,18 @@ 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.
 
 ### Date Field
-Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+Aside from the basic `Field` attributes, the date field `DateField` also implements the following:
 
 * **date_object** (`Date`): an accessible representation of the value as a JavaScript object.
 

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

@@ -1,16 +1,42 @@
 ---
-title: FR Energy Bill OCR Ruby
+title: Ruby Client Library - FR Energy Bill
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-energy-bill-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [Energy Bill API](https://platform.mindee.com/mindee/energy_bill_fra).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.pdf), we are going to illustrate how to extract the data that we want using the OCR SDK.
+The Ruby Client Library supports the [Energy Bill API](https://platform.mindee.com/mindee/energy_bill_fra).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `energy_bill_fra`                                  |
+> | Recommended Version            | `v1.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🇫🇷 France                                          |
+
+> 🔐 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/energy_bill_fra/default_sample.pdf),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Energy Bill sample](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.pdf?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::FR::EnergyBill::EnergyBillV1
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -100,12 +125,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.
@@ -115,7 +140,7 @@ Aside from the previous attributes, all basic fields have access to a `to_s` met
 The amount field `AmountField` only has one constraint: its **value** is a `Float` (or `nil`).
 
 ### Date Field
-Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+Aside from the basic `Field` attributes, the date field `DateField` also implements the following:
 
 * **date_object** (`Date`): an accessible representation of the value as a JavaScript object.
 
@@ -125,6 +150,15 @@ 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.
 
+### Energy Supplier Field
+The company that supplies the energy.
+
+A `EnergyBillV1EnergySupplier` implements the following attributes:
+
+* `address` (String): The address of the energy supplier.
+* `name` (String): The name of the energy supplier.
+Fields which are specific to this product; they are not used in any other product.
+
 ### Energy Consumer Field
 The entity that consumes the energy.
 
@@ -134,13 +168,17 @@ A `EnergyBillV1EnergyConsumer` implements the following attributes:
 * `name` (String): The name of the energy consumer.
 Fields which are specific to this product; they are not used in any other product.
 
-### Energy Supplier Field
-The company that supplies the energy.
+### Subscription Field
+The subscription details fee for the energy service.
 
-A `EnergyBillV1EnergySupplier` implements the following attributes:
+A `EnergyBillV1Subscription` implements the following attributes:
 
-* `address` (String): The address of the energy supplier.
-* `name` (String): The name of the energy supplier.
+* `description` (String): Description or details of the subscription.
+* `end_date` (String): The end date of the subscription.
+* `start_date` (String): The start date of the subscription.
+* `tax_rate` (Float): The rate of tax applied to the total cost.
+* `total` (Float): The total cost of subscription.
+* `unit_price` (Float): The price per unit of subscription.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Energy Usage Field
@@ -156,6 +194,19 @@ A `EnergyBillV1EnergyUsage` implements the following attributes:
 * `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.
 
+### Taxes and Contributions Field
+Details of Taxes and Contributions.
+
+A `EnergyBillV1TaxesAndContribution` implements the following attributes:
+
+* `description` (String): Description or details of the Taxes and Contributions.
+* `end_date` (String): The end date of the Taxes and Contributions.
+* `start_date` (String): The start date of the Taxes and Contributions.
+* `tax_rate` (Float): The rate of tax applied to the total cost.
+* `total` (Float): The total cost of Taxes and Contributions.
+* `unit_price` (Float): The price per unit of Taxes and Contributions.
+Fields which are specific to this product; they are not used in any other product.
+
 ### Meter Details Field
 Information about the energy meter.
 
@@ -169,34 +220,8 @@ A `EnergyBillV1MeterDetail` implements the following attributes:
  - gas
  - water
  - None
-
+        
 * `unit` (String): The unit of measurement for energy consumption, which can be kW, m³, or L.
-Fields which are specific to this product; they are not used in any other product.
-
-### Subscription Field
-The subscription details fee for the energy service.
-
-A `EnergyBillV1Subscription` implements the following attributes:
-
-* `description` (String): Description or details of the subscription.
-* `end_date` (String): The end date of the subscription.
-* `start_date` (String): The start date of the subscription.
-* `tax_rate` (Float): The rate of tax applied to the total cost.
-* `total` (Float): The total cost of subscription.
-* `unit_price` (Float): The price per unit of subscription.
-Fields which are specific to this product; they are not used in any other product.
-
-### Taxes and Contributions Field
-Details of Taxes and Contributions.
-
-A `EnergyBillV1TaxesAndContribution` implements the following attributes:
-
-* `description` (String): Description or details of the Taxes and Contributions.
-* `end_date` (String): The end date of the Taxes and Contributions.
-* `start_date` (String): The start date of the Taxes and Contributions.
-* `tax_rate` (Float): The rate of tax applied to the total cost.
-* `total` (Float): The total cost of Taxes and Contributions.
-* `unit_price` (Float): The price per unit of Taxes and Contributions.
 
 # Attributes
 The following fields are extracted for Energy Bill V1:
@@ -240,7 +265,7 @@ puts result.document.inference.prediction.energy_supplier.value
 **energy_usage** (Array<[EnergyBillV1EnergyUsage](#energy-usage-field)>): Details of energy consumption.
 
 ```rb
-for energy_usage_elem in result.document.inference.prediction.energy_usage do
+result.document.inference.prediction.energy_usage do |energy_usage_elem|
   puts energy_usage_elem.value
 end
 ```
@@ -270,7 +295,7 @@ puts result.document.inference.prediction.meter_details.value
 **subscription** (Array<[EnergyBillV1Subscription](#subscription-field)>): The subscription details fee for the energy service.
 
 ```rb
-for subscription_elem in result.document.inference.prediction.subscription do
+result.document.inference.prediction.subscription do |subscription_elem|
   puts subscription_elem.value
 end
 ```
@@ -279,7 +304,7 @@ end
 **taxes_and_contributions** (Array<[EnergyBillV1TaxesAndContribution](#taxes-and-contributions-field)>): Details of Taxes and Contributions.
 
 ```rb
-for taxes_and_contributions_elem in result.document.inference.prediction.taxes_and_contributions do
+result.document.inference.prediction.taxes_and_contributions do |taxes_and_contributions_elem|
   puts taxes_and_contributions_elem.value
 end
 ```

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

@@ -1,16 +1,42 @@
 ---
-title: FR Health Card OCR Ruby
+title: Ruby Client Library - FR Health Card
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-health-card-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [Health Card API](https://platform.mindee.com/mindee/french_healthcard).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/french_healthcard/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 [Health Card API](https://platform.mindee.com/mindee/french_healthcard).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `french_healthcard`                                |
+> | Recommended Version            | `v1.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🇫🇷 France                                          |
+
+> 🔐 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/french_healthcard/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Health Card sample](https://github.com/mindee/client-lib-test-data/blob/main/products/french_healthcard/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::FR::HealthCard::HealthCardV1
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -62,18 +87,18 @@ 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.
 
 ### Date Field
-Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+Aside from the basic `Field` attributes, the date field `DateField` also implements the following:
 
 * **date_object** (`Date`): an accessible representation of the value as a JavaScript object.
 
@@ -87,7 +112,7 @@ The following fields are extracted for Health Card V1:
 **given_names** (Array<[StringField](#string-field)>): The given names of the card holder.
 
 ```rb
-for given_names_elem in result.document.inference.prediction.given_names do
+result.document.inference.prediction.given_names do |given_names_elem|
   puts given_names_elem.value
 end
 ```