mindee 3.15.0 → 3.17.0

data/docs/driver_license_v1.md

@@ -0,0 +1,156 @@
+---
+title: Driver License OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-driver-license-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Driver License API](https://platform.mindee.com/mindee/driver_license).
+
+The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/driver_license/default_sample.jpg) can be used for testing purposes.
+![Driver License sample](https://github.com/mindee/client-lib-test-data/blob/main/products/driver_license/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::DriverLicense::DriverLicenseV1
+)
+
+# 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.
+
+### 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 Driver License V1:
+
+## Category
+**category** ([StringField](#string-field)): The category or class of the driver license.
+
+```rb
+puts result.document.inference.prediction.category.value
+```
+
+## Country Code
+**country_code** ([StringField](#string-field)): The alpha-3 ISO 3166 code of the country where the driver license was issued.
+
+```rb
+puts result.document.inference.prediction.country_code.value
+```
+
+## Date of Birth
+**date_of_birth** ([DateField](#date-field)): The date of birth of the driver license holder.
+
+```rb
+puts result.document.inference.prediction.date_of_birth.value
+```
+
+## DD Number
+**dd_number** ([StringField](#string-field)): The DD number of the driver license.
+
+```rb
+puts result.document.inference.prediction.dd_number.value
+```
+
+## Expiry Date
+**expiry_date** ([DateField](#date-field)): The expiry date of the driver license.
+
+```rb
+puts result.document.inference.prediction.expiry_date.value
+```
+
+## First Name
+**first_name** ([StringField](#string-field)): The first name of the driver license holder.
+
+```rb
+puts result.document.inference.prediction.first_name.value
+```
+
+## ID
+**id** ([StringField](#string-field)): The unique identifier of the driver license.
+
+```rb
+puts result.document.inference.prediction.id.value
+```
+
+## Issued Date
+**issued_date** ([DateField](#date-field)): The date when the driver license was issued.
+
+```rb
+puts result.document.inference.prediction.issued_date.value
+```
+
+## Issuing Authority
+**issuing_authority** ([StringField](#string-field)): The authority that issued the driver license.
+
+```rb
+puts result.document.inference.prediction.issuing_authority.value
+```
+
+## Last Name
+**last_name** ([StringField](#string-field)): The last name of the driver license holder.
+
+```rb
+puts result.document.inference.prediction.last_name.value
+```
+
+## MRZ
+**mrz** ([StringField](#string-field)): The Machine Readable Zone (MRZ) of the driver license.
+
+```rb
+puts result.document.inference.prediction.mrz.value
+```
+
+## Place of Birth
+**place_of_birth** ([StringField](#string-field)): The place of birth of the driver license holder.
+
+```rb
+puts result.document.inference.prediction.place_of_birth.value
+```
+
+## State
+**state** ([StringField](#string-field)): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+
+```rb
+puts result.document.inference.prediction.state.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/energy_bill_fra_v1.md

@@ -6,8 +6,8 @@ parentDoc: 6294d97ee723f1008d2ab28e
 ---
 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.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
-![Energy Bill sample](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg?raw=true)
+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.
+![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

data/docs/expense_receipts_v5.md

@@ -33,6 +33,31 @@ puts result.document
 
 ```
 
+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::Receipt::ReceiptV5
+)
+
+# 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
 ########
@@ -50,7 +75,7 @@ Prediction
 ==========
 :Expense Locale: en-GB; en; GB; GBP;
 :Purchase Category: food
-:Purchase Subcategory:
+:Purchase Subcategory: restaurant
 :Document Type: EXPENSE RECEIPT
 :Purchase Date: 2016-02-26
 :Purchase Time: 15:20
@@ -84,7 +109,7 @@ Page 0
 ------
 :Expense Locale: en-GB; en; GB; GBP;
 :Purchase Category: food
-:Purchase Subcategory:
+:Purchase Subcategory: restaurant
 :Document Type: EXPENSE RECEIPT
 :Purchase Date: 2016-02-26
 :Purchase Time: 15:20

data/docs/financial_document_v1.md

@@ -63,23 +63,25 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 3859a462-e05f-4f4c-a736-febca66b9aa9
+:Mindee ID: b26161ce-35d0-4984-b1ff-886645e160e6
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/financial_document v1.9
+:Product: mindee/financial_document v1.11
 :Rotation applied: Yes
 
 Prediction
 ==========
-:Locale: en; en; USD;
+:Locale: en-US; en; US; USD;
 :Invoice Number: INT-001
+:Purchase Order Number: 2412/2019
 :Receipt Number:
 :Document Number: INT-001
 :Reference Numbers: 2412/2019
 :Purchase Date: 2019-11-02
 :Due Date: 2019-02-26
+:Payment Date: 2019-02-26
 :Total Net: 195.00
 :Total Amount: 204.75
 :Taxes:
@@ -123,13 +125,15 @@ Page Predictions
 
 Page 0
 ------
-:Locale: en; en; USD;
+:Locale: en-US; en; US; USD;
 :Invoice Number: INT-001
+:Purchase Order Number: 2412/2019
 :Receipt Number:
 :Document Number: INT-001
 :Reference Numbers: 2412/2019
 :Purchase Date: 2019-11-02
 :Due Date: 2019-02-26
+:Payment Date: 2019-02-26
 :Total Net: 195.00
 :Total Amount: 204.75
 :Taxes:

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

@@ -1,13 +1,13 @@
 ---
-title: FR Carte Vitale OCR Ruby
+title: FR Health Card OCR Ruby
 category: 622b805aaec68102ea7fcbc2
-slug: ruby-fr-carte-vitale-ocr
+slug: ruby-fr-health-card-ocr
 parentDoc: 6294d97ee723f1008d2ab28e
 ---
-The Ruby OCR SDK supports the [Carte Vitale API](https://platform.mindee.com/mindee/carte_vitale).
+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/carte_vitale/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
-![Carte Vitale sample](https://github.com/mindee/client-lib-test-data/blob/main/products/carte_vitale/default_sample.jpg?raw=true)
+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.
+![Health Card sample](https://github.com/mindee/client-lib-test-data/blob/main/products/french_healthcard/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
@@ -20,9 +20,9 @@ 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.parse(
+result = mindee_client.enqueue_and_parse(
   input_source,
-  Mindee::Product::FR::CarteVitale::CarteVitaleV1
+  Mindee::Product::FR::HealthCard::HealthCardV1
 )
 
 # Print a full summary of the parsed data in RST format
@@ -38,29 +38,19 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 8c25cc63-212b-4537-9c9b-3fbd3bd0ee20
+:Mindee ID: 9ee2733d-933a-4dcd-a73a-a31395e3b288
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/carte_vitale v1.0
+:Product: mindee/french_healthcard v1.0
 :Rotation applied: Yes
 
 Prediction
 ==========
 :Given Name(s): NATHALIE
 :Surname: DURAND
-:Social Security Number: 269054958815780
-:Issuance Date: 2007-01-01
-
-Page Predictions
-================
-
-Page 0
-------
-:Given Name(s): NATHALIE
-:Surname: DURAND
-:Social Security Number: 269054958815780
+:Social Security Number: 2 69 05 49 588 157 80
 :Issuance Date: 2007-01-01
 ```
 
@@ -91,10 +81,10 @@ Aside from the basic `Field` attributes, the date field `DateField` also impleme
 The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
 
 # Attributes
-The following fields are extracted for Carte Vitale V1:
+The following fields are extracted for Health Card V1:
 
 ## Given Name(s)
-**given_names** (Array<[StringField](#string-field)>): The given name(s) of the card holder.
+**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
@@ -103,14 +93,14 @@ end
 ```
 
 ## Issuance Date
-**issuance_date** ([DateField](#date-field)): The date the card was issued.
+**issuance_date** ([DateField](#date-field)): The date when the carte vitale document was issued.
 
 ```rb
 puts result.document.inference.prediction.issuance_date.value
 ```
 
 ## Social Security Number
-**social_security** ([StringField](#string-field)): The Social Security Number (Numéro de Sécurité Sociale) of the card holder
+**social_security** ([StringField](#string-field)): The social security number of the card holder.
 
 ```rb
 puts result.document.inference.prediction.social_security.value

data/docs/ind_passport_v1.md

@@ -0,0 +1,281 @@
+---
+title: IND Passport - India OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-ind-passport---india-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+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.
+![Passport - India sample](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/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::IND::IndianPassport::IndianPassportV1
+)
+
+# 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: cf88fd43-eaa1-497a-ba29-a9569a4edaa7
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/ind_passport v1.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:Page Number: 1
+:Country: IND
+:ID Number: J8369854
+:Given Names: JOCELYN MICHELLE
+:Surname: DOE
+:Birth Date: 1959-09-23
+:Birth Place: GUNDUGOLANU
+:Issuance Place: HYDERABAD
+:Gender: F
+:Issuance Date: 2011-10-11
+:Expiry Date: 2021-10-10
+:MRZ Line 1: P<DOE<<JOCELYNMICHELLE<<<<<<<<<<<<<<<<<<<<<
+:MRZ Line 2: J8369854<4IND5909234F2110101<<<<<<<<<<<<<<<8
+:Legal Guardian:
+:Name of Spouse:
+:Name of Mother:
+:Old Passport Date of Issue:
+:Old Passport Number:
+:Address Line 1:
+:Address Line 2:
+:Address Line 3:
+:Old Passport Place of Issue:
+:File Number:
+```
+
+# 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.
+
+
+### Classification Field
+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: 
+
+* **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 - India V1:
+
+## Address Line 1
+**address1** ([StringField](#string-field)): The first line of the address of the passport holder.
+
+```rb
+puts result.document.inference.prediction.address1.value
+```
+
+## Address Line 2
+**address2** ([StringField](#string-field)): The second line of the address of the passport holder.
+
+```rb
+puts result.document.inference.prediction.address2.value
+```
+
+## Address Line 3
+**address3** ([StringField](#string-field)): The third line of the address of the passport holder.
+
+```rb
+puts result.document.inference.prediction.address3.value
+```
+
+## Birth Date
+**birth_date** ([DateField](#date-field)): The birth date of the passport holder, ISO format: YYYY-MM-DD.
+
+```rb
+puts result.document.inference.prediction.birth_date.value
+```
+
+## Birth Place
+**birth_place** ([StringField](#string-field)): The birth place of the passport holder.
+
+```rb
+puts result.document.inference.prediction.birth_place.value
+```
+
+## Country
+**country** ([StringField](#string-field)): ISO 3166-1 alpha-3 country code (3 letters format).
+
+```rb
+puts result.document.inference.prediction.country.value
+```
+
+## Expiry Date
+**expiry_date** ([DateField](#date-field)): The date when the passport will expire, ISO format: YYYY-MM-DD.
+
+```rb
+puts result.document.inference.prediction.expiry_date.value
+```
+
+## File Number
+**file_number** ([StringField](#string-field)): The file number of the passport document.
+
+```rb
+puts result.document.inference.prediction.file_number.value
+```
+
+## Gender
+**gender** ([ClassificationField](#classification-field)): The gender of the passport holder.
+
+#### Possible values include:
+ - M
+ - F
+
+```rb
+puts result.document.inference.prediction.gender.value
+```
+
+## Given Names
+**given_names** ([StringField](#string-field)): The given names of the passport holder.
+
+```rb
+puts result.document.inference.prediction.given_names.value
+```
+
+## ID Number
+**id_number** ([StringField](#string-field)): The identification number of the passport document.
+
+```rb
+puts result.document.inference.prediction.id_number.value
+```
+
+## Issuance Date
+**issuance_date** ([DateField](#date-field)): The date when the passport was issued, ISO format: YYYY-MM-DD.
+
+```rb
+puts result.document.inference.prediction.issuance_date.value
+```
+
+## Issuance Place
+**issuance_place** ([StringField](#string-field)): The place where the passport was issued.
+
+```rb
+puts result.document.inference.prediction.issuance_place.value
+```
+
+## Legal Guardian
+**legal_guardian** ([StringField](#string-field)): The name of the legal guardian of the passport holder (if applicable).
+
+```rb
+puts result.document.inference.prediction.legal_guardian.value
+```
+
+## MRZ Line 1
+**mrz1** ([StringField](#string-field)): The first line of the machine-readable zone (MRZ) of the passport document.
+
+```rb
+puts result.document.inference.prediction.mrz1.value
+```
+
+## MRZ Line 2
+**mrz2** ([StringField](#string-field)): The second line of the machine-readable zone (MRZ) of the passport document.
+
+```rb
+puts result.document.inference.prediction.mrz2.value
+```
+
+## Name of Mother
+**name_of_mother** ([StringField](#string-field)): The name of the mother of the passport holder.
+
+```rb
+puts result.document.inference.prediction.name_of_mother.value
+```
+
+## Name of Spouse
+**name_of_spouse** ([StringField](#string-field)): The name of the spouse of the passport holder (if applicable).
+
+```rb
+puts result.document.inference.prediction.name_of_spouse.value
+```
+
+## Old Passport Date of Issue
+**old_passport_date_of_issue** ([DateField](#date-field)): The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
+
+```rb
+puts result.document.inference.prediction.old_passport_date_of_issue.value
+```
+
+## Old Passport Number
+**old_passport_number** ([StringField](#string-field)): The number of the old passport (if applicable).
+
+```rb
+puts result.document.inference.prediction.old_passport_number.value
+```
+
+## Old Passport Place of Issue
+**old_passport_place_of_issue** ([StringField](#string-field)): The place of issue of the old passport (if applicable).
+
+```rb
+puts result.document.inference.prediction.old_passport_place_of_issue.value
+```
+
+## Page Number
+**page_number** ([ClassificationField](#classification-field)): The page number of the passport document.
+
+#### Possible values include:
+ - 1
+ - 2
+
+```rb
+puts result.document.inference.prediction.page_number.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)

data/docs/invoices_v4.md

@@ -63,21 +63,23 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 372d9d08-59d8-4e1c-9622-06648c1c238b
+:Mindee ID: a67b70ea-4b1e-4eac-ae75-dda47a7064ae
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.7
+:Product: mindee/invoices v4.9
 :Rotation applied: Yes
 
 Prediction
 ==========
-:Locale: en; en; CAD;
+:Locale: en-CA; en; CA; CAD;
 :Invoice Number: 14
+:Purchase Order Number: AD29094
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date:
+:Due Date: 2011-12-01
+:Payment Date: 2011-12-01
 :Total Net: 2145.00
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -93,7 +95,7 @@ Prediction
 :Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
 :Supplier Phone Number: 4165551212
 :Supplier Website:
-:Supplier Email: ldoi@example.com
+:Supplier Email: j_coi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
@@ -117,11 +119,13 @@ Page Predictions
 
 Page 0
 ------
-:Locale: en; en; CAD;
+:Locale: en-CA; en; CA; CAD;
 :Invoice Number: 14
+:Purchase Order Number: AD29094
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date:
+:Due Date: 2011-12-01
+:Payment Date: 2011-12-01
 :Total Net: 2145.00
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -137,7 +141,7 @@ Page 0
 :Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
 :Supplier Phone Number: 4165551212
 :Supplier Website:
-:Supplier Email: ldoi@example.com
+:Supplier Email: j_coi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada