mindee 4.7.1 → 4.8.0

data/docs/global_products/nutrition_facts_v1.md

@@ -1,399 +0,0 @@
----
-title: Nutrition Facts Label
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-nutrition-facts-label-ocr
-parentDoc: 67b49df15b843f3fa9cd622b
----
-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
-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::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
-```
-
-**Output (RST):**
-```rst
-########
-Document
-########
-:Mindee ID: 38a12fe0-5d69-4ca4-9b30-12f1b659311c
-:Filename: default_sample.jpg
-
-Inference
-#########
-:Product: mindee/nutrition_facts v1.0
-:Rotation applied: No
-
-Prediction
-==========
-:Serving per Box: 2.00
-:Serving Size:
-  :Amount: 228.00
-  :Unit: g
-:Calories:
-  :Daily Value:
-  :Per 100g:
-  :Per Serving: 250.00
-:Total Fat:
-  :Daily Value:
-  :Per 100g:
-  :Per Serving: 12.00
-:Saturated Fat:
-  :Daily Value: 15.00
-  :Per 100g:
-  :Per Serving: 3.00
-:Trans Fat:
-  :Daily Value:
-  :Per 100g:
-  :Per Serving: 3.00
-:Cholesterol:
-  :Daily Value: 10.00
-  :Per 100g:
-  :Per Serving: 30.00
-:Total Carbohydrate:
-  :Daily Value: 10.00
-  :Per 100g:
-  :Per Serving: 31.00
-:Dietary Fiber:
-  :Daily Value: 0.00
-  :Per 100g:
-  :Per Serving: 0.00
-:Total Sugars:
-  :Daily Value:
-  :Per 100g:
-  :Per Serving: 5.00
-:Added Sugars:
-  :Daily Value:
-  :Per 100g:
-  :Per Serving:
-:Protein:
-  :Daily Value:
-  :Per 100g:
-  :Per Serving: 5.00
-:sodium:
-  :Daily Value: 20.00
-  :Per 100g:
-  :Per Serving: 470.00
-  :Unit: mg
-:nutrients:
-  +-------------+----------------------+----------+-------------+------+
-  | Daily Value | Name                 | Per 100g | Per Serving | Unit |
-  +=============+======================+==========+=============+======+
-  | 12.00       | Vitamin A            |          | 4.00        | mcg  |
-  +-------------+----------------------+----------+-------------+------+
-  | 12.00       | Vitamin C            |          | 2.00        | mg   |
-  +-------------+----------------------+----------+-------------+------+
-  | 12.00       | Calcium              |          | 45.60       | mg   |
-  +-------------+----------------------+----------+-------------+------+
-  | 12.00       | Iron                 |          | 0.90        | mg   |
-  +-------------+----------------------+----------+-------------+------+
-```
-
-# 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`).
-
-## Specific Fields
-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.
-
-### 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.
-
-### 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.
-
-### 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.
-
-### 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.
-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.
-
-### 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.
-
-### 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.
-
-### 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.
-
-### 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.
-
-### 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:
-
-## 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
-result.document.inference.prediction.nutrients do |nutrients_elem|
-  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/global_products/passport_v1.md

@@ -1,207 +0,0 @@
----
-title: Passport
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-passport-ocr
-parentDoc: 67b49df15b843f3fa9cd622b
----
-The Ruby Client Library supports the [Passport API](https://platform.mindee.com/mindee/passport).
-
-
-> 📝 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
-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::Passport::PassportV1
-)
-
-# 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: 18e41f6c-16cd-4f8e-8cd2-00ca02a35764
-:Filename: default_sample.jpg
-
-Inference
-#########
-:Product: mindee/passport v1.0
-:Rotation applied: Yes
-
-Prediction
-==========
-:Country Code: GBR
-:ID Number: 707797979
-:Given Name(s): HENERT
-:Surname: PUDARSAN
-:Date of Birth: 1995-05-20
-:Place of Birth: CAMTETH
-:Gender: M
-:Date of Issue: 2012-04-22
-:Expiry Date: 2017-04-22
-:MRZ Line 1: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<
-:MRZ Line 2: 7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
-
-Page Predictions
-================
-
-Page 0
-------
-:Country Code: GBR
-:ID Number: 707797979
-:Given Name(s): HENERT
-:Surname: PUDARSAN
-:Date of Birth: 1995-05-20
-:Place of Birth: CAMTETH
-:Gender: M
-:Date of Issue: 2012-04-22
-:Expiry Date: 2017-04-22
-:MRZ Line 1: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<
-:MRZ Line 2: 7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
-```
-
-# 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.
-
-### 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`).
-
-# Attributes
-The following fields are extracted for Passport V1:
-
-## Date of Birth
-**birth_date** ([DateField](#date-field)): The date of birth of the passport holder.
-
-```rb
-puts result.document.inference.prediction.birth_date.value
-```
-
-## Place of Birth
-**birth_place** ([StringField](#string-field)): The place of birth of the passport holder.
-
-```rb
-puts result.document.inference.prediction.birth_place.value
-```
-
-## Country Code
-**country** ([StringField](#string-field)): The country's 3 letter code (ISO 3166-1 alpha-3).
-
-```rb
-puts result.document.inference.prediction.country.value
-```
-
-## Expiry Date
-**expiry_date** ([DateField](#date-field)): The expiry date of the passport.
-
-```rb
-puts result.document.inference.prediction.expiry_date.value
-```
-
-## Gender
-**gender** ([StringField](#string-field)): The gender of the passport holder.
-
-```rb
-puts result.document.inference.prediction.gender.value
-```
-
-## Given Name(s)
-**given_names** (Array<[StringField](#string-field)>): The given name(s) of the passport holder.
-
-```rb
-result.document.inference.prediction.given_names do |given_names_elem|
-  puts given_names_elem.value
-end
-```
-
-## ID Number
-**id_number** ([StringField](#string-field)): The passport's identification number.
-
-```rb
-puts result.document.inference.prediction.id_number.value
-```
-
-## Date of Issue
-**issuance_date** ([DateField](#date-field)): The date the passport was issued.
-
-```rb
-puts result.document.inference.prediction.issuance_date.value
-```
-
-## MRZ Line 1
-**mrz1** ([StringField](#string-field)): Machine Readable Zone, first line
-
-```rb
-puts result.document.inference.prediction.mrz1.value
-```
-
-## MRZ Line 2
-**mrz2** ([StringField](#string-field)): Machine Readable Zone, second line
-
-```rb
-puts result.document.inference.prediction.mrz2.value
-```
-
-## Surname
-**surname** ([StringField](#string-field)): The surname of the passport holder.
-
-```rb
-puts result.document.inference.prediction.surname.value
-```
-
-# Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)