mindee 2.2.0 → 3.0.0

data/docs/ruby-passport-ocr.md

@@ -1,4 +1,4 @@
-The Ruby  OCR SDK supports the [passport API](https://developers.mindee.com/docs/passport-ocr) for extracting data from passports.
+The Ruby OCR SDK supports the [passport API](https://developers.mindee.com/docs/passport-ocr) for extracting data from passports.
 
 Using the sample below, we are going to illustrate how to extract the data that we want using the  OCR SDK.
 
@@ -6,31 +6,38 @@ Using the sample below, we are going to illustrate how to extract the data that
 
 ## Quick Start
 ```ruby
-require 'mindee'
-
-# Init a new client, specifying an API key
+# Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Send the file
-result = mindee_client.doc_from_path('/path/to/the/file.ext').parse(Mindee::Prediction::PassportV1)
+# 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 summary of the document prediction in RST format
-puts result.inference.prediction
+# Print a full summary of the parsed data in RST format
+puts result.document
 ```
 
 Output:
 ```
-:Full name: HENERT PUDARSAN
-:Given names: HENERT
-:Surname: PUDARSAN
-:Country: GBR
-:ID Number: 707797979
-:Issuance date: 2012-04-22
-:Birth date: 1995-05-20
-:Expiry date: 2017-04-22
-:MRZ 1: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<
-:MRZ 2: 7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
-:MRZ: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
+----- Passport V1 -----
+Filename:
+Full name: HENERT PUDARSAN
+Given names: HENERT
+Surname: PUDARSAN
+Country: GBR
+ID Number: 707797979
+Issuance date: 2012-04-22
+Birth date: 1995-05-20
+Expiry date: 2057-04-22
+MRZ 1: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<
+MRZ 2: 7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
+MRZ: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
+----------------------
 ```
 
 ## Fields
@@ -49,29 +56,31 @@ Depending on the field type specified, additional attributes can be extracted fr
 
 Using the above sample, the following are the basic fields that can be extracted:
 
-- [Orientation](#orientation)
-- [Birth Place](#birth-place)
-- [Country](#country)
-- [Dates (Expiry, Issuance, Birth)](#dates)
-- [Gender](#gender)
-- [Given Names](#given-names)
-- [ID Number](#id)
-- [Machine Readable Zone](#machine-readable-zone)
-- [Surname](#surname)
+- [Quick Start](#quick-start)
+- [Fields](#fields)
+- [Attributes](#attributes)
+  - [Birth Place](#birth-place)
+  - [Country](#country)
+  - [Dates](#dates)
+  - [Gender](#gender)
+  - [Names](#names)
+  - [ID](#id)
+  - [Machine-Readable Zone](#machine-readable-zone)
+- [Questions?](#questions)
 
 ### Birth Place
 
 **`birth_place`** (Field): Passport owner birthplace.
 
 ```ruby
-puts result.inference.prediction.birth_place.value
+puts result.document.inference.prediction.birth_place.value
 ```
 
 ### Country
 **`country`** (Field): Passport country in [ISO 3166-1 alpha-3 code format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) (3-letter code).
 
 ```ruby
-puts result.inference.prediction.country.value
+puts result.document.inference.prediction.country.value
 ```
 
 ### Dates
@@ -85,19 +94,19 @@ The following date fields are available:
 **`expiry_date`**: Passport expiry date.
 
 ```ruby
-puts result.inference.prediction.expiry_date.value
+puts result.document.inference.prediction.expiry_date.value
 ```
 
 **`issuance_date`**: Passport date of issuance.
 
 ```ruby
-puts result.inference.prediction.issuance_date.value
+puts result.document.inference.prediction.issuance_date.value
 ```
 
 **`birth_date`**: Passport's owner date of birth.
 
 ```ruby
-puts result.inference.prediction.birth_date.value
+puts result.document.inference.prediction.birth_date.value
 ```
 
 ### Gender
@@ -105,7 +114,7 @@ puts result.inference.prediction.birth_date.value
 **`gender`** (Field): Passport owner's gender (M / F).
 
 ```ruby
-puts result.inference.prediction.gender.value
+puts result.document.inference.prediction.gender.value
 ```
 
 ### Names
@@ -113,7 +122,7 @@ puts result.inference.prediction.gender.value
 **`given_names`** (Array< Field >): List of passport owner's given names.
 
 ```ruby
-result.inference.prediction.given_names.each do |name|
+result.document.inference.prediction.given_names.each do |name|
   puts name
 end
 ```
@@ -121,7 +130,7 @@ end
 **`surname`** (Field): Passport's owner surname.
 
 ```ruby
-puts result.inference.prediction.surname.value
+puts result.document.inference.prediction.surname.value
 ```
 
 ### ID
@@ -129,7 +138,7 @@ puts result.inference.prediction.surname.value
 **`id_number`** (Field): Passport identification number.
 
 ```ruby
-puts result.inference.prediction.id_number.value
+puts result.document.inference.prediction.id_number.value
 ```
 
 ### Machine-Readable Zone
@@ -137,19 +146,19 @@ puts result.inference.prediction.id_number.value
 **`mrz1`** (Field): Passport first line of machine-readable zone.
 
 ```ruby
-puts result.inference.prediction.mrz1.value
+puts result.document.inference.prediction.mrz1.value
 ```
 
 **`mrz2`** (Field): Passport second line of machine-readable zone.
 
 ```ruby
-puts result.inference.prediction.mrz2.value
+puts result.document.inference.prediction.mrz2.value
 ```
 
 **`mrz`** (Field): Reconstructed passport full machine-readable zone from mrz1 and mrz2.
 
 ```ruby
-puts result.inference.prediction.mrz.value
+puts result.document.inference.prediction.mrz.value
 ```
 
 ## Questions?

data/docs/ruby-receipt-ocr.md

@@ -8,22 +8,27 @@ Using this sample below, we are going to illustrate how to extract the data that
 ```ruby
 require 'mindee'
 
-# Init a new client, specifying an API key
+# Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
-result = mindee_client.doc_from_path('/path/to/the/file.ext')
-                      .parse(Mindee::Prediction::ReceiptV5)
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
-# Print a full summary of the parsed data in RST format
-# puts result
+# Parse the file
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::Receipt::ReceiptV5
+)
 
-# Print the document-level parsed data
-puts result.inference.prediction
+# Print a full summary of the parsed data in RST format
+puts result.document
 ```
 
 Output:
 ```
+Receipt V5 Prediction
+=====================
+:Filename:
 :Expense Locale: en-GB; en; GB; GBP;
 :Expense Category: food
 :Expense Sub Category: restaurant
@@ -34,17 +39,21 @@ Output:
 :Total Excluding Taxes: 8.50
 :Total Tax: 1.70
 :Tip and Gratuity:
-:Taxes: 1.70 20.00% VAT
+:Taxes:
+  +---------------+--------+----------+---------------+
+  | Base          | Code   | Rate (%) | Amount        |
+  +===============+========+==========+===============+
+  | 8.50          | VAT    | 20.00    | 1.70          |
+  +---------------+--------+----------+---------------+
 :Supplier Name: CLACHAN
 :Supplier Company Registrations: 232153895
-                                 232153895
 :Supplier Address: 34 kingley street w1b 5qh
 :Supplier Phone Number: 02074940834
 :Line Items:
   +--------------------------------------+----------+--------------+------------+
   | Description                          | Quantity | Total Amount | Unit Price |
   +======================================+==========+==============+============+
-  | Meantime Pale                        | 2.00     | 10.20        |            |
+  | meantime pale                        | 2.00     | 10.20        |            |
   +--------------------------------------+----------+--------------+------------+
 ```
 
@@ -64,13 +73,17 @@ Depending on the field type specified, additional attributes can be extracted in
 
 Using the above sample, the following are the basic fields that can be extracted:
 
-- [Category](#category)
-- [Date](#date)
-- [Locale](#locale)
-- [Supplier Information](#supplier-information)
-- [Taxes](#taxes)
-- [Time](#time)
-- [Totals](#totals)
+- [Quick Start](#quick-start)
+- [Fields](#fields)
+- [Attributes](#attributes)
+  - [Category](#category)
+  - [Date](#date)
+  - [Locale](#locale)
+  - [Supplier Information](#supplier-information)
+  - [Taxes](#taxes)
+  - [Time](#time)
+  - [Totals](#totals)
+- [Questions?](#questions)
 
 
 ### Category
@@ -78,7 +91,7 @@ Using the above sample, the following are the basic fields that can be extracted
   The following categories are supported: toll, food, parking, transport, accommodation, gasoline, miscellaneous.
 
 ```ruby
-puts result.inference.prediction.category.value
+puts result.document.inference.prediction.category.value
 ```
 
 
@@ -93,7 +106,7 @@ The following date fields are available:
 * **`date`**: Date the receipt was issued
 
 ```ruby
-puts result.inference.prediction.date.value
+puts result.document.inference.prediction.date.value
 ```
 
 
@@ -102,32 +115,32 @@ puts result.inference.prediction.date.value
 
 * `locale.value` (String): Locale with country and language codes.
 ```ruby
-puts result.inference.prediction.locale
+puts result.document.inference.prediction.locale
 ```
 
 * `locale.language` (String): Language code in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format as seen on the document.
 * 
 ```ruby
-puts result.inference.prediction.locale.language
+puts result.document.inference.prediction.locale.language
 ```
 
 * `locale.currency` (String): Currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format as seen on the document.
 
 ```ruby
-puts result.inference.prediction.locale.currency
+puts result.document.inference.prediction.locale.currency
 ```
 
 * `locale.country` (String): Country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) alpha-2 format as seen on the document.
 
 ```ruby
-puts result.inference.prediction.locale.country
+puts result.document.inference.prediction.locale.country
 ```
 
 ### Supplier Information
 * **`supplier_name`** (Field): Supplier name as written in the receipt.
 
 ```ruby
-puts result.inference.prediction.supplier_name.value
+puts result.document.inference.prediction.supplier_name.value
 ```
 
 
@@ -137,19 +150,19 @@ puts result.inference.prediction.supplier_name.value
 * `value` (Float): The tax amount.
 ```ruby
 # Show the amount of the first tax
-puts result.inference.prediction.taxes[0].value
+puts result.document.inference.prediction.taxes[0].value
 ```
 
 * `code` (String): The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..).
 ```ruby
 # Show the code of the first tax
-puts result.inference.prediction.taxes[0].code
+puts result.document.inference.prediction.taxes[0].code
 ```
 
 * `rate` (Float): The tax rate.
 ```ruby
 # Show the rate of the first tax
-puts result.inference.prediction.taxes[0].rate
+puts result.document.inference.prediction.taxes[0].rate
 ```
 
 ### Time
@@ -157,26 +170,26 @@ puts result.inference.prediction.taxes[0].rate
     * `value` (string): Time of purchase with 24 hours formatting (hh:mm).
 
 ```ruby
-puts result.inference.prediction.time.value
+puts result.document.inference.prediction.time.value
 ```
 
 ### Totals
 * **`total_amount`** (Field): Total amount including taxes
 
 ```ruby
-puts result.inference.prediction.total_amount.value
+puts result.document.inference.prediction.total_amount.value
 ```
 
 * **`total_net`** (Field): Total amount paid excluding taxes
 
 ```ruby
-puts result.inference.prediction.total_net.value
+puts result.document.inference.prediction.total_net.value
 ```
 
 * **`total_tax`** (Field): Total tax value from tax lines
 
 ```ruby
-puts result.inference.prediction.total_tax.value
+puts result.document.inference.prediction.total_tax.value
 ```
 
 ## Questions?