mindee 3.1.1 → 3.3.0

data/docs/invoice_splitter_v1.md

@@ -0,0 +1,85 @@
+---
+title: Invoice Splitter API Ruby
+---
+The Ruby OCR SDK supports the [Invoice Splitter API](https://platform.mindee.com/mindee/invoice_splitter).
+
+Using [this sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoice_splitter/default_sample.pdf), we are going to illustrate how to detect the pages of multiple invoices within the same document.
+
+# 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')
+
+result = mindee_client.enqueue_and_parse(
+  input_source,
+  Mindee::Product::InvoiceSplitter::InvoiceSplitterV1
+)
+
+# 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: 8c25cc63-212b-4537-9c9b-3fbd3bd0ee20
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/carte_vitale 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
+:Issuance Date: 2007-01-01
+```
+
+# Field Types
+## Specific Fields
+### Invoice Splitter V1 Page Group
+List of page group indexes.
+
+An `InvoiceSplitterV1PageGroup` implements the following attributes:
+
+* **page_indexes** (Array<`Integer`>): List of indexes of the pages of a single invoice.
+* **confidence** (`Float`): The confidence of the prediction.
+
+# Attributes
+The following fields are extracted for Invoice Splitter V1:
+
+## Invoice Page Groups
+**invoice_page_groups** (Array<[InvoiceSplitterV1PageGroup](#invoice-splitter-v1-page-group)>): List of page indexes that belong to the same invoice in the PDF.
+
+```rb
+for invoice_page_groups_elem in result.document.inference.prediction.invoice_page_groups do 
+  puts invoicePageGroupsElem.pageIndexes.join(', ')
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

data/docs/invoices_v4.md

@@ -0,0 +1,338 @@
+---
+title: Invoice OCR Ruby
+---
+The Ruby OCR SDK supports the [Invoice API](https://platform.mindee.com/mindee/invoices).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/invoices/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Invoice sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoices/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.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):**
+```rst
+########
+Document
+########
+:Mindee ID: 16bd8752-8c4d-450f-8213-f33b2097504c
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/invoices v4.2
+:Rotation applied: Yes
+
+Prediction
+==========
+:Locale: en; en; CAD;
+:Invoice Number: 14
+:Reference Numbers: AD29094
+:Purchase Date: 2018-09-25
+:Due Date: 2018-09-25
+:Total Net:
+:Total Amount: 2608.20
+:Taxes:
+  +---------------+--------+----------+---------------+
+  | Base          | Code   | Rate (%) | Amount        |
+  +===============+========+==========+===============+
+  |               |        | 8.00     | 193.20        |
+  +---------------+--------+----------+---------------+
+:Supplier Payment Details:
+:Supplier Name: TURNPIKE DESIGNS CO.
+:Supplier Company Registrations:
+:Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
+:Customer Name: JIRO DOI
+:Customer Company Registrations:
+:Customer 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     |
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
+
+Page Predictions
+================
+
+Page 0
+------
+:Locale: en; en; CAD;
+:Invoice Number: 14
+:Reference Numbers: AD29094
+:Purchase Date: 2018-09-25
+:Due Date: 2018-09-25
+:Total Net:
+:Total Amount: 2608.20
+:Taxes:
+  +---------------+--------+----------+---------------+
+  | Base          | Code   | Rate (%) | Amount        |
+  +===============+========+==========+===============+
+  |               |        | 8.00     | 193.20        |
+  +---------------+--------+----------+---------------+
+:Supplier Payment Details:
+:Supplier Name: TURNPIKE DESIGNS CO.
+:Supplier Company Registrations:
+:Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
+:Customer Name: JIRO DOI
+:Customer Company Registrations:
+:Customer 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     |
+  +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
+```
+
+# 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, is `nil` when at document-level.
+* **reconstructed** (`Boolean`): indicates whether or not 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`).
+
+
+### 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`.
+
+
+### Company Registration Field
+Aside from the basic `Field` attributes, the company registration field `CompanyRegistrationField` also implements the following:
+
+* **type** (`String`): the type of company.
+
+### 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.
+
+### Locale Field
+The locale field `LocaleField` only implements the **value**, **confidence** and **page_id** base `Field` attributes, but it comes with its own:
+
+* **language** (`String`): ISO 639-1 language code (e.g.: `en` for English). Can be `nil`.
+* **country** (`String`): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.: `GRB` or `GB` for "Great Britain"). Can be `nil`.
+* **currency** (`String`): ISO 4217 code for currencies (e.g.: `USD` for "US Dollars"). Can be `nil`.
+
+### Payment Details Field
+Aside from the basic `Field` attributes, the payment details field `PaymentDetailsField` also implements the following:
+
+* **account_number** (`String`): number of an account, expressed as a string. Can be `nil`.
+* **iban** (`String`): International Bank Account Number. Can be `nil`.
+* **routing_number** (`String`): routing number of an account. Can be `nil`.
+* **swift** (`String`): the account holder's bank's SWIFT Business Identifier Code (BIC). Can be `nil`.
+
+### String Field
+The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
+
+### Taxes Field
+#### Tax
+Aside from the basic `Field` attributes, the tax field `TaxField` also implements the following:
+
+* **rate** (`Float`): the tax rate applied to an item can be expressed as a percentage. Can be `nil`.
+* **code** (`String`): tax code (or equivalent, depending on the origin of the document). Can be `nil`.
+* **base** (`Float`): base amount used for the tax. Can be `nil`.
+
+> Note: currently `TaxField` is not used on its own, and is accessed through a parent `Taxes` object, an array-like structure.
+
+#### Taxes (Array)
+The `Taxes` field represents an array-like collection of `TaxField` objects. As it is the representation of several objects, it has access to a custom `to_s` method that can render a `TaxField` object as a table line.
+
+## Specific Fields
+Fields which are specific to this product; they are not used in any other product.
+
+### Line Items Field
+List of line item details.
+
+A `InvoiceV4LineItem` implements the following attributes:
+
+* `description` (String): The item description.
+* `product_code` (String): The product code referring to the item.
+* `quantity` (Float): The item quantity
+* `tax_amount` (Float): The item tax amount.
+* `tax_rate` (Float): The item tax rate in percentage.
+* `total_amount` (Float): The item total amount.
+* `unit_price` (Float): The item unit price.
+
+# Attributes
+The following fields are extracted for Invoice V4:
+
+## Customer Address
+**customer_address** ([StringField](#string-field)): The address of the customer.
+
+```rb
+puts result.document.inference.prediction.customer_address.value
+```
+
+## Customer Company Registrations
+**customer_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registrations associated to the customer.
+
+```rb
+for customer_company_registrations_elem in result.document.inference.prediction.customer_company_registrations do
+  puts customer_company_registrations_elem.value
+end
+```
+
+## Customer Name
+**customer_name** ([StringField](#string-field)): The name of the customer or client.
+
+```rb
+puts result.document.inference.prediction.customer_name.value
+```
+
+## Purchase Date
+**date** ([DateField](#date-field)): The date the purchase was made.
+
+```rb
+puts result.document.inference.prediction.date.value
+```
+
+## Document Type
+**document_type** ([ClassificationField](#classification-field)): One of: 'INVOICE', 'CREDIT NOTE'.
+
+```rb
+puts result.document.inference.prediction.document_type.value
+```
+
+## Due Date
+**due_date** ([DateField](#date-field)): The date on which the payment is due.
+
+```rb
+puts result.document.inference.prediction.due_date.value
+```
+
+## Invoice Number
+**invoice_number** ([StringField](#string-field)): The invoice number or identifier.
+
+```rb
+puts result.document.inference.prediction.invoice_number.value
+```
+
+## Line Items
+**line_items** (Array<[InvoiceV4LineItem](#line-items-field)>): List of line item details.
+
+```rb
+for line_items_elem in result.document.inference.prediction.line_items do
+  puts line_items_elem.value
+end
+```
+
+## Locale
+**locale** ([LocaleField](#locale-field)): The locale detected on the document.
+
+```rb
+puts result.document.inference.prediction.locale.value
+```
+
+## Reference Numbers
+**reference_numbers** (Array<[StringField](#string-field)>): List of Reference numbers, including PO number.
+
+```rb
+for reference_numbers_elem in result.document.inference.prediction.reference_numbers do
+  puts reference_numbers_elem.value
+end
+```
+
+## Supplier Address
+**supplier_address** ([StringField](#string-field)): The address of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_address.value
+```
+
+## Supplier Company Registrations
+**supplier_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registrations associated to the supplier.
+
+```rb
+for supplier_company_registrations_elem in result.document.inference.prediction.supplier_company_registrations do
+  puts supplier_company_registrations_elem.value
+end
+```
+
+## Supplier Name
+**supplier_name** ([StringField](#string-field)): The name of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_name.value
+```
+
+## Supplier Payment Details
+**supplier_payment_details** (Array<[PaymentDetailsField](#payment-details-field)>): List of payment details associated to the supplier.
+
+```rb
+for supplier_payment_details_elem in result.document.inference.prediction.supplier_payment_details do
+  puts supplier_payment_details_elem.value
+end
+```
+
+## Taxes
+**taxes** (Array<[TaxField](#taxes-field)>): List of tax line details.
+
+```rb
+for taxes_elem in result.document.inference.prediction.taxes do
+  puts taxes_elem.to_s
+end
+```
+
+## Total Amount
+**total_amount** ([AmountField](#amount-field)): The total amount paid: includes taxes, tips, fees, and other charges.
+
+```rb
+puts result.document.inference.prediction.total_amount.value
+```
+
+## Total Net
+**total_net** ([AmountField](#amount-field)): The net amount paid: does not include taxes, fees, and discounts.
+
+```rb
+puts result.document.inference.prediction.total_net.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

data/docs/license_plates_v1.md

@@ -0,0 +1,91 @@
+---
+title: EU License Plate OCR Ruby
+---
+The Ruby OCR SDK supports the [License Plate API](https://platform.mindee.com/mindee/license_plates).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/license_plates/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![License Plate sample](https://github.com/mindee/client-lib-test-data/blob/main/products/license_plates/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.parse(
+  input_source,
+  Mindee::Product::EU::LicensePlate::LicensePlateV1
+)
+
+# 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: f0f48232-2c80-4473-9c6f-88a09111b84d
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/license_plates v1.0
+:Rotation applied: No
+
+Prediction
+==========
+:License Plates: BY-323-YB
+
+Page Predictions
+================
+
+Page 0
+------
+:License Plates: BY-323-YB
+```
+
+# 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, is `nil` when at document-level.
+* **reconstructed** (`Boolean`): indicates whether or not 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.
+
+### 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 License Plate V1:
+
+## License Plates
+**license_plates** (Array<[StringField](#string-field)>): List of all license plates found in the image.
+
+```rb
+for license_plates_elem in result.document.inference.prediction.license_plates do
+  puts license_plates_elem.value
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

data/docs/multi_receipts_detector_v1.md

@@ -0,0 +1,105 @@
+---
+title: Multi Receipts Detector OCR Ruby
+---
+The Ruby OCR SDK 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.
+![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
+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::MultiReceiptsDetector::MultiReceiptsDetectorV1
+)
+
+# 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: d7c5b25f-e0d3-4491-af54-6183afa1aaab
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/multi_receipts_detector v1.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:List of Receipts: Polygon with 4 points.
+                   Polygon with 4 points.
+                   Polygon with 4 points.
+                   Polygon with 4 points.
+                   Polygon with 4 points.
+                   Polygon with 4 points.
+
+Page Predictions
+================
+
+Page 0
+------
+:List of Receipts: Polygon with 4 points.
+                   Polygon with 4 points.
+                   Polygon with 4 points.
+                   Polygon with 4 points.
+                   Polygon with 4 points.
+                   Polygon with 4 points.
+```
+
+# 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, is `nil` when at document-level.
+* **reconstructed** (`Boolean`): indicates whether or not 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:
+
+* **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
+The following fields are extracted for Multi Receipts Detector V1:
+
+## List of Receipts
+**receipts** (Array<[PositionField](#position-field)>): Positions of the receipts on the document.
+
+```rb
+for receipts_elem in result.document.inference.prediction.receipts do
+  puts receipts_elem.polygon
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)