mindee 3.12.0 → 3.13.0

data/docs/invoices_v4.md

@@ -1,5 +1,8 @@
 ---
 title: Invoice OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-invoice-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Invoice API](https://platform.mindee.com/mindee/invoices).
 
@@ -27,6 +30,32 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
+```
+
+You can also call this product asynchronously:
+
+```rb
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::Invoice::InvoiceV4
+)
+
+# 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):**
@@ -34,12 +63,12 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 128a314f-1adb-42eb-a9e3-402055a8b8ce
+:Mindee ID: 372d9d08-59d8-4e1c-9622-06648c1c238b
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.6
+:Product: mindee/invoices v4.7
 :Rotation applied: Yes
 
 Prediction
@@ -73,15 +102,15 @@ Prediction
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
 :Line Items:
-  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit Price |
-  +======================================+==============+==========+============+==============+==============+============+
-  | Platinum web hosting package Down... |              | 1.00     |            |              | 65.00        | 65.00      |
-  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | 2 page website design Includes ba... |              | 3.00     |            |              | 2100.00      | 2100.00    |
-  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | Mobile designs Includes responsiv... |              | 1.00     |            |              | 250.00       | 250.00     |
-  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
+  | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
+  +======================================+==============+==========+============+==============+==============+=================+============+
+  | Platinum web hosting package Down... |              | 1.00     |            |              | 65.00        |                 | 65.00      |
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
+  | 2 page website design Includes ba... |              | 3.00     |            |              | 2100.00      |                 | 2100.00    |
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
+  | Mobile designs Includes responsiv... |              | 1.00     |            |              | 250.00       | 1               | 250.00     |
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
 
 Page Predictions
 ================
@@ -117,15 +146,15 @@ Page 0
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
 :Line Items:
-  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit Price |
-  +======================================+==============+==========+============+==============+==============+============+
-  | Platinum web hosting package Down... |              | 1.00     |            |              | 65.00        | 65.00      |
-  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | 2 page website design Includes ba... |              | 3.00     |            |              | 2100.00      | 2100.00    |
-  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | Mobile designs Includes responsiv... |              | 1.00     |            |              | 250.00       | 250.00     |
-  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
+  | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
+  +======================================+==============+==========+============+==============+==============+=================+============+
+  | Platinum web hosting package Down... |              | 1.00     |            |              | 65.00        |                 | 65.00      |
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
+  | 2 page website design Includes ba... |              | 3.00     |            |              | 2100.00      |                 | 2100.00    |
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
+  | Mobile designs Includes responsiv... |              | 1.00     |            |              | 250.00       | 1               | 250.00     |
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
 ```
 
 # Field Types
@@ -140,7 +169,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **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).
 
 
@@ -265,6 +294,10 @@ puts result.document.inference.prediction.date.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): One of: 'INVOICE', 'CREDIT NOTE'.
 
+#### Possible values include:
+ - INVOICE
+ - CREDIT NOTE
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```

data/docs/license_plates_v1.md

@@ -1,5 +1,8 @@
 ---
 title: EU License Plate OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-eu-license-plate-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [License Plate API](https://platform.mindee.com/mindee/license_plates).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -66,7 +70,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **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).
 
 

data/docs/multi_receipts_detector_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Multi Receipts Detector OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-multi-receipts-detector-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Multi Receipts Detector API](https://platform.mindee.com/mindee/multi_receipts_detector).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -76,7 +80,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **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).
 
 

data/docs/nutrition_facts_v1.md

@@ -0,0 +1,295 @@
+---
+title: Nutrition Facts Label OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-nutrition-facts-label-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Nutrition Facts Label API](https://platform.mindee.com/mindee/nutrition_facts).
+
+The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/default_sample.jpg) can be used for testing purposes.
+![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
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1
+)
+
+# 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
+
+```
+# 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`, `Boolean`): 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).
+
+
+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`).
+
+## 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.
+
+A `NutritionFactsLabelV1AddedSugar` 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.
+Fields which are specific to this product; they are not used in any other product.
+
+### Calories Field
+The amount of calories in the product.
+
+A `NutritionFactsLabelV1Calorie` implements the following attributes:
+
+* `daily_value` (Float): DVs are the recommended amounts of calories to consume or not to exceed each day.
+* `per_100g` (Float): The amount of calories per 100g of the product.
+* `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.
+
+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.
+
+### Saturated Fat Field
+The amount of saturated fat in the product.
+
+A `NutritionFactsLabelV1SaturatedFat` implements the following attributes:
+
+* `daily_value` (Float): DVs are the recommended amounts of saturated fat to consume or not to exceed each day.
+* `per_100g` (Float): The amount of saturated fat per 100g of the product.
+* `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.
+
+A `NutritionFactsLabelV1ServingSize` implements the following attributes:
+
+* `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.
+
+### 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.
+
+### Total Carbohydrate Field
+The total amount of carbohydrates in the product.
+
+A `NutritionFactsLabelV1TotalCarbohydrate` implements the following attributes:
+
+* `daily_value` (Float): DVs are the recommended amounts of total carbohydrates to consume or not to exceed each day.
+* `per_100g` (Float): The amount of total carbohydrates per 100g of the product.
+* `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.
+
+A `NutritionFactsLabelV1TotalFat` 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.
+Fields which are specific to this product; they are not used in any other product.
+
+### Total Sugars Field
+The total amount of sugars in the product.
+
+A `NutritionFactsLabelV1TotalSugar` implements the following attributes:
+
+* `daily_value` (Float): DVs are the recommended amounts of total sugars to consume or not to exceed each day.
+* `per_100g` (Float): The amount of total sugars per 100g of the product.
+* `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.
+
+A `NutritionFactsLabelV1TransFat` 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.
+
+# Attributes
+The following fields are extracted for Nutrition Facts Label V1:
+
+## Added Sugars
+**added_sugars** ([NutritionFactsLabelV1AddedSugar](#added-sugars-field)): The amount of added sugars in the product.
+
+```rb
+puts result.document.inference.prediction.added_sugars.value
+```
+
+## Calories
+**calories** ([NutritionFactsLabelV1Calorie](#calories-field)): The amount of calories in the product.
+
+```rb
+puts result.document.inference.prediction.calories.value
+```
+
+## Cholesterol
+**cholesterol** ([NutritionFactsLabelV1Cholesterol](#cholesterol-field)): The amount of cholesterol in the product.
+
+```rb
+puts result.document.inference.prediction.cholesterol.value
+```
+
+## Dietary Fiber
+**dietary_fiber** ([NutritionFactsLabelV1DietaryFiber](#dietary-fiber-field)): The amount of dietary fiber in the product.
+
+```rb
+puts result.document.inference.prediction.dietary_fiber.value
+```
+
+## nutrients
+**nutrients** (Array<[NutritionFactsLabelV1Nutrient](#nutrients-field)>): The amount of nutrients in the product.
+
+```rb
+for nutrients_elem in result.document.inference.prediction.nutrients do
+  puts nutrients_elem.value
+end
+```
+
+## Protein
+**protein** ([NutritionFactsLabelV1Protein](#protein-field)): The amount of protein in the product.
+
+```rb
+puts result.document.inference.prediction.protein.value
+```
+
+## Saturated Fat
+**saturated_fat** ([NutritionFactsLabelV1SaturatedFat](#saturated-fat-field)): The amount of saturated fat in the product.
+
+```rb
+puts result.document.inference.prediction.saturated_fat.value
+```
+
+## Serving per Box
+**serving_per_box** ([AmountField](#amount-field)): The number of servings in each box of the product.
+
+```rb
+puts result.document.inference.prediction.serving_per_box.value
+```
+
+## Serving Size
+**serving_size** ([NutritionFactsLabelV1ServingSize](#serving-size-field)): The size of a single serving of the product.
+
+```rb
+puts result.document.inference.prediction.serving_size.value
+```
+
+## sodium
+**sodium** ([NutritionFactsLabelV1Sodium](#sodium-field)): The amount of sodium in the product.
+
+```rb
+puts result.document.inference.prediction.sodium.value
+```
+
+## Total Carbohydrate
+**total_carbohydrate** ([NutritionFactsLabelV1TotalCarbohydrate](#total-carbohydrate-field)): The total amount of carbohydrates in the product.
+
+```rb
+puts result.document.inference.prediction.total_carbohydrate.value
+```
+
+## Total Fat
+**total_fat** ([NutritionFactsLabelV1TotalFat](#total-fat-field)): The total amount of fat in the product.
+
+```rb
+puts result.document.inference.prediction.total_fat.value
+```
+
+## Total Sugars
+**total_sugars** ([NutritionFactsLabelV1TotalSugar](#total-sugars-field)): The total amount of sugars in the product.
+
+```rb
+puts result.document.inference.prediction.total_sugars.value
+```
+
+## Trans Fat
+**trans_fat** ([NutritionFactsLabelV1TransFat](#trans-fat-field)): The amount of trans fat in the product.
+
+```rb
+puts result.document.inference.prediction.trans_fat.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/passport_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Passport OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-passport-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Passport API](https://platform.mindee.com/mindee/passport).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -86,7 +90,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **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).