mindee 3.20.0 → 4.0.0

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
 ```

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

@@ -1,16 +1,34 @@
 ---
-title: FR Carte Nationale d'Identité OCR Ruby
+title: Ruby Client Library - FR Carte Nationale d'Identité
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-fr-carte-nationale-didentite-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [Carte Nationale d'Identité API](https://platform.mindee.com/mindee/idcard_fr).
+The Ruby Client Library supports the [Carte Nationale d'Identité API](https://platform.mindee.com/mindee/idcard_fr).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/idcard_fr/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                  | `idcard_fr`                                        |
+> | Recommended Version            | `v2.0`                                             |
+> | 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/idcard_fr/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Carte Nationale d'Identité sample](https://github.com/mindee/client-lib-test-data/blob/main/products/idcard_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
@@ -30,7 +48,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -98,24 +115,25 @@ 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.
 
 
 ### Classification Field
-The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements **value**, **confidence** and **page_id**.
+The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements
+**value**, **confidence** and **page_id**.
 
 > Note: a classification field's `value is always 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.
 
@@ -179,9 +197,9 @@ puts result.document.inference.prediction.document_number.value
  - RECTO & VERSO
 
 ```rb
-for document_side_elem in result.document.document_side do
-  puts document_side_elem.value
-end
+  result.document.document_side.each do |document_side_elem|
+    puts document_side_elem.value
+  end
 ```
 
 ## Document Type
@@ -192,9 +210,9 @@ end
  - OLD
 
 ```rb
-for document_type_elem in result.document.document_type do
-  puts document_type_elem.value
-end
+  result.document.document_type.each do |document_type_elem|
+    puts document_type_elem.value
+  end
 ```
 
 ## Expiry Date
@@ -215,7 +233,7 @@ puts result.document.inference.prediction.gender.value
 **given_names** (Array<[StringField](#string-field)>): The given name(s) 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
 ```

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

@@ -1,16 +1,42 @@
 ---
-title: IND Passport - India OCR Ruby
+title: Ruby Client Library - IND Passport - India
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-ind-passport---india-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [Passport - India API](https://platform.mindee.com/mindee/ind_passport).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/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 [Passport - India API](https://platform.mindee.com/mindee/ind_passport).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `ind_passport`                                     |
+> | Recommended Version            | `v1.2`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🇮🇳 India                                           |
+
+> 🔐 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/ind_passport/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Passport - India sample](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/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::IND::IndianPassport::IndianPassportV1
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -81,24 +106,25 @@ 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.
 
 
 ### Classification Field
-The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements **value**, **confidence** and **page_id**.
+The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements
+**value**, **confidence** and **page_id**.
 
 > Note: a classification field's `value is always 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/{license_plates_v1.md → localized_products/license_plates_v1.md}

@@ -1,16 +1,34 @@
 ---
-title: EU License Plate OCR Ruby
+title: Ruby Client Library - EU License Plate
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-eu-license-plate-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49e29a2cd6f08d69a40d8
 ---
-The Ruby OCR SDK supports the [License Plate API](https://platform.mindee.com/mindee/license_plates).
+The Ruby Client Library supports the [License Plate API](https://platform.mindee.com/mindee/license_plates).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/license_plates/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                  | `license_plates`                                   |
+> | Recommended Version            | `v1.1`                                             |
+> | Supports Polling/Webhooks      | ❌ No                                              |
+> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
+> | Geography                      | 🇪🇺 Europe                                          |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/license_plates/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![License Plate sample](https://github.com/mindee/client-lib-test-data/blob/main/products/license_plates/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):**
@@ -66,12 +83,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.
@@ -86,7 +103,7 @@ The following fields are extracted for License Plate V1:
 **license_plates** (Array<[StringField](#string-field)>): List of all license plates found in the image.
 
 ```rb
-for license_plates_elem in result.document.inference.prediction.license_plates do
+result.document.inference.prediction.license_plates do |license_plates_elem|
   puts license_plates_elem.value
 end
 ```