mindee 3.19.1 → 4.0.0

data/docs/{multi_receipts_detector_v1.md → global_products/multi_receipts_detector_v1.md}

@@ -1,16 +1,34 @@
 ---
-title: Multi Receipts Detector OCR Ruby
+title: Ruby Client Library - Multi Receipts Detector
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-multi-receipts-detector-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Multi Receipts Detector API](https://platform.mindee.com/mindee/multi_receipts_detector).
+The Ruby Client Library supports the [Multi Receipts Detector API](https://platform.mindee.com/mindee/multi_receipts_detector).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/multi_receipts_detector/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                  | `multi_receipts_detector`                          |
+> | Recommended Version            | `v1.1`                                             |
+> | Supports Polling/Webhooks      | ❌ No                                              |
+> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
+> | Geography                      | 🌐 Global                                          |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/multi_receipts_detector/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Multi Receipts Detector sample](https://github.com/mindee/client-lib-test-data/blob/main/products/multi_receipts_detector/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):**
@@ -76,21 +93,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.
 
 # Attributes
@@ -100,11 +119,11 @@ The following fields are extracted for Multi Receipts Detector V1:
 **receipts** (Array<[PositionField](#position-field)>): Positions of the receipts on the document.
 
 ```rb
-for receipts_elem in result.document.inference.prediction.receipts do
+result.document.inference.prediction.receipts do |receipts_elem|
   puts receipts_elem.polygon.to_s
-    puts receipts_elem.quadrangle.to_s
-    puts receipts_elem.rectangle.to_s
-    puts receipts_elem.boundingBox.to_s
+  puts receipts_elem.quadrangle.to_s
+  puts receipts_elem.rectangle.to_s
+  puts receipts_elem.boundingBox.to_s
 end
 ```
 

data/docs/{nutrition_facts_v1.md → global_products/nutrition_facts_v1.md}

@@ -1,16 +1,42 @@
 ---
-title: Nutrition Facts Label OCR Ruby
+title: Ruby Client Library - Nutrition Facts Label
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-nutrition-facts-label-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Nutrition Facts Label API](https://platform.mindee.com/mindee/nutrition_facts).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/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 [Nutrition Facts Label API](https://platform.mindee.com/mindee/nutrition_facts).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `nutrition_facts`                                  |
+> | Recommended Version            | `v1.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🌐 Global                                          |
+
+> 🔐 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/nutrition_facts/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Nutrition Facts Label sample](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/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::NutritionFactsLabel::NutritionFactsLabelV1
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -119,12 +144,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.
@@ -136,14 +161,13 @@ The amount field `AmountField` only has one constraint: its **value** is a `Floa
 ## Specific Fields
 Fields which are specific to this product; they are not used in any other product.
 
-### Added Sugars Field
-The amount of added sugars in the product.
+### Serving Size Field
+The size of a single serving of the product.
 
-A `NutritionFactsLabelV1AddedSugar` implements the following attributes:
+A `NutritionFactsLabelV1ServingSize` implements the following attributes:
 
-* `daily_value` (Float): DVs are the recommended amounts of added sugars to consume or not to exceed each day.
-* `per_100g` (Float): The amount of added sugars per 100g of the product.
-* `per_serving` (Float): The amount of added sugars per serving of the product.
+* `amount` (Float): The amount of a single serving.
+* `unit` (String): The unit for the amount of a single serving.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Calories Field
@@ -156,46 +180,14 @@ A `NutritionFactsLabelV1Calorie` implements the following attributes:
 * `per_serving` (Float): The amount of calories per serving of the product.
 Fields which are specific to this product; they are not used in any other product.
 
-### Cholesterol Field
-The amount of cholesterol in the product.
-
-A `NutritionFactsLabelV1Cholesterol` implements the following attributes:
-
-* `daily_value` (Float): DVs are the recommended amounts of cholesterol to consume or not to exceed each day.
-* `per_100g` (Float): The amount of cholesterol per 100g of the product.
-* `per_serving` (Float): The amount of cholesterol per serving of the product.
-Fields which are specific to this product; they are not used in any other product.
-
-### Dietary Fiber Field
-The amount of dietary fiber in the product.
-
-A `NutritionFactsLabelV1DietaryFiber` implements the following attributes:
-
-* `daily_value` (Float): DVs are the recommended amounts of dietary fiber to consume or not to exceed each day.
-* `per_100g` (Float): The amount of dietary fiber per 100g of the product.
-* `per_serving` (Float): The amount of dietary fiber per serving of the product.
-Fields which are specific to this product; they are not used in any other product.
-
-### nutrients Field
-The amount of nutrients in the product.
-
-A `NutritionFactsLabelV1Nutrient` implements the following attributes:
-
-* `daily_value` (Float): DVs are the recommended amounts of nutrients to consume or not to exceed each day.
-* `name` (String): The name of nutrients of the product.
-* `per_100g` (Float): The amount of nutrients per 100g of the product.
-* `per_serving` (Float): The amount of nutrients per serving of the product.
-* `unit` (String): The unit of measurement for the amount of nutrients.
-Fields which are specific to this product; they are not used in any other product.
-
-### Protein Field
-The amount of protein in the product.
+### Total Fat Field
+The total amount of fat in the product.
 
-A `NutritionFactsLabelV1Protein` implements the following attributes:
+A `NutritionFactsLabelV1TotalFat` implements the following attributes:
 
-* `daily_value` (Float): DVs are the recommended amounts of protein to consume or not to exceed each day.
-* `per_100g` (Float): The amount of protein per 100g of the product.
-* `per_serving` (Float): The amount of protein per serving of the product.
+* `daily_value` (Float): DVs are the recommended amounts of total fat to consume or not to exceed each day.
+* `per_100g` (Float): The amount of total fat per 100g of the product.
+* `per_serving` (Float): The amount of total fat per serving of the product.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Saturated Fat Field
@@ -208,24 +200,24 @@ A `NutritionFactsLabelV1SaturatedFat` implements the following attributes:
 * `per_serving` (Float): The amount of saturated fat per serving of the product.
 Fields which are specific to this product; they are not used in any other product.
 
-### Serving Size Field
-The size of a single serving of the product.
+### Trans Fat Field
+The amount of trans fat in the product.
 
-A `NutritionFactsLabelV1ServingSize` implements the following attributes:
+A `NutritionFactsLabelV1TransFat` implements the following attributes:
 
-* `amount` (Float): The amount of a single serving.
-* `unit` (String): The unit for the amount of a single serving.
+* `daily_value` (Float): DVs are the recommended amounts of trans fat to consume or not to exceed each day.
+* `per_100g` (Float): The amount of trans fat per 100g of the product.
+* `per_serving` (Float): The amount of trans fat per serving of the product.
 Fields which are specific to this product; they are not used in any other product.
 
-### sodium Field
-The amount of sodium in the product.
+### Cholesterol Field
+The amount of cholesterol in the product.
 
-A `NutritionFactsLabelV1Sodium` implements the following attributes:
+A `NutritionFactsLabelV1Cholesterol` implements the following attributes:
 
-* `daily_value` (Float): DVs are the recommended amounts of sodium to consume or not to exceed each day.
-* `per_100g` (Float): The amount of sodium per 100g of the product.
-* `per_serving` (Float): The amount of sodium per serving of the product.
-* `unit` (String): The unit of measurement for the amount of sodium.
+* `daily_value` (Float): DVs are the recommended amounts of cholesterol to consume or not to exceed each day.
+* `per_100g` (Float): The amount of cholesterol per 100g of the product.
+* `per_serving` (Float): The amount of cholesterol per serving of the product.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Total Carbohydrate Field
@@ -238,14 +230,14 @@ A `NutritionFactsLabelV1TotalCarbohydrate` implements the following attributes:
 * `per_serving` (Float): The amount of total carbohydrates per serving of the product.
 Fields which are specific to this product; they are not used in any other product.
 
-### Total Fat Field
-The total amount of fat in the product.
+### Dietary Fiber Field
+The amount of dietary fiber in the product.
 
-A `NutritionFactsLabelV1TotalFat` implements the following attributes:
+A `NutritionFactsLabelV1DietaryFiber` implements the following attributes:
 
-* `daily_value` (Float): DVs are the recommended amounts of total fat to consume or not to exceed each day.
-* `per_100g` (Float): The amount of total fat per 100g of the product.
-* `per_serving` (Float): The amount of total fat per serving of the product.
+* `daily_value` (Float): DVs are the recommended amounts of dietary fiber to consume or not to exceed each day.
+* `per_100g` (Float): The amount of dietary fiber per 100g of the product.
+* `per_serving` (Float): The amount of dietary fiber per serving of the product.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Total Sugars Field
@@ -258,14 +250,47 @@ A `NutritionFactsLabelV1TotalSugar` implements the following attributes:
 * `per_serving` (Float): The amount of total sugars per serving of the product.
 Fields which are specific to this product; they are not used in any other product.
 
-### Trans Fat Field
-The amount of trans fat in the product.
+### Added Sugars Field
+The amount of added sugars in the product.
 
-A `NutritionFactsLabelV1TransFat` implements the following attributes:
+A `NutritionFactsLabelV1AddedSugar` implements the following attributes:
 
-* `daily_value` (Float): DVs are the recommended amounts of trans fat to consume or not to exceed each day.
-* `per_100g` (Float): The amount of trans fat per 100g of the product.
-* `per_serving` (Float): The amount of trans fat per serving of the product.
+* `daily_value` (Float): DVs are the recommended amounts of added sugars to consume or not to exceed each day.
+* `per_100g` (Float): The amount of added sugars per 100g of the product.
+* `per_serving` (Float): The amount of added sugars per serving of the product.
+Fields which are specific to this product; they are not used in any other product.
+
+### Protein Field
+The amount of protein in the product.
+
+A `NutritionFactsLabelV1Protein` implements the following attributes:
+
+* `daily_value` (Float): DVs are the recommended amounts of protein to consume or not to exceed each day.
+* `per_100g` (Float): The amount of protein per 100g of the product.
+* `per_serving` (Float): The amount of protein per serving of the product.
+Fields which are specific to this product; they are not used in any other product.
+
+### sodium Field
+The amount of sodium in the product.
+
+A `NutritionFactsLabelV1Sodium` implements the following attributes:
+
+* `daily_value` (Float): DVs are the recommended amounts of sodium to consume or not to exceed each day.
+* `per_100g` (Float): The amount of sodium per 100g of the product.
+* `per_serving` (Float): The amount of sodium per serving of the product.
+* `unit` (String): The unit of measurement for the amount of sodium.
+Fields which are specific to this product; they are not used in any other product.
+
+### nutrients Field
+The amount of nutrients in the product.
+
+A `NutritionFactsLabelV1Nutrient` implements the following attributes:
+
+* `daily_value` (Float): DVs are the recommended amounts of nutrients to consume or not to exceed each day.
+* `name` (String): The name of nutrients of the product.
+* `per_100g` (Float): The amount of nutrients per 100g of the product.
+* `per_serving` (Float): The amount of nutrients per serving of the product.
+* `unit` (String): The unit of measurement for the amount of nutrients.
 
 # Attributes
 The following fields are extracted for Nutrition Facts Label V1:
@@ -302,7 +327,7 @@ puts result.document.inference.prediction.dietary_fiber.value
 **nutrients** (Array<[NutritionFactsLabelV1Nutrient](#nutrients-field)>): The amount of nutrients in the product.
 
 ```rb
-for nutrients_elem in result.document.inference.prediction.nutrients do
+result.document.inference.prediction.nutrients do |nutrients_elem|
   puts nutrients_elem.value
 end
 ```

data/docs/{passport_v1.md → global_products/passport_v1.md}

@@ -1,16 +1,34 @@
 ---
-title: Passport OCR Ruby
+title: Ruby Client Library - Passport
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-passport-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Passport API](https://platform.mindee.com/mindee/passport).
+The Ruby Client Library supports the [Passport API](https://platform.mindee.com/mindee/passport).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/passport/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                  | `passport`                                         |
+> | Recommended Version            | `v1.1`                                             |
+> | Supports Polling/Webhooks      | ❌ No                                              |
+> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
+> | Geography                      | 🌐 Global                                          |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/passport/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Passport sample](https://github.com/mindee/client-lib-test-data/blob/main/products/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
@@ -30,7 +48,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -86,18 +103,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.
 
@@ -146,7 +163,7 @@ puts result.document.inference.prediction.gender.value
 **given_names** (Array<[StringField](#string-field)>): The given name(s) of the passport 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
 ```