mindee 4.0.0 → 4.1.2

data/docs/global_products/financial_document_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Financial Document
+title: Financial Document
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-financial-document-ocr
 parentDoc: 67b49df15b843f3fa9cd622b
@@ -284,7 +284,7 @@ objects, it has access to a custom `to_s` method that can render a `TaxField` ob
 Fields which are specific to this product; they are not used in any other product.
 
 ### Line Items Field
-List of line item details.
+List of line item present on the document.
 
 A `FinancialDocumentV1LineItem` implements the following attributes:
 
@@ -308,17 +308,17 @@ puts result.document.inference.prediction.billing_address.value
 ```
 
 ## Purchase Category
-**category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
+**category** ([ClassificationField](#classification-field)): The purchase category, only for receipts.
 
 #### Possible values include:
- - toll
- - food
- - parking
- - transport
- - accommodation
- - gasoline
- - telecom
- - miscellaneous
+ - 'toll'
+ - 'food'
+ - 'parking'
+ - 'transport'
+ - 'accommodation'
+ - 'gasoline'
+ - 'telecom'
+ - 'miscellaneous'
 
 ```rb
 puts result.document.inference.prediction.category.value
@@ -332,7 +332,7 @@ 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.
+**customer_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registration numbers associated to the customer.
 
 ```rb
 result.document.inference.prediction.customer_company_registrations do |customer_company_registrations_elem|
@@ -362,20 +362,20 @@ puts result.document.inference.prediction.date.value
 ```
 
 ## Document Number
-**document_number** ([StringField](#string-field)): The document number or identifier.
+**document_number** ([StringField](#string-field)): The document number or identifier (invoice number or receipt number).
 
 ```rb
 puts result.document.inference.prediction.document_number.value
 ```
 
 ## Document Type
-**document_type** ([ClassificationField](#classification-field)): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
+**document_type** ([ClassificationField](#classification-field)): The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it is a receipt.
 
 #### Possible values include:
- - INVOICE
- - CREDIT NOTE
- - CREDIT CARD RECEIPT
- - EXPENSE RECEIPT
+ - 'INVOICE'
+ - 'CREDIT NOTE'
+ - 'CREDIT CARD RECEIPT'
+ - 'EXPENSE RECEIPT'
 
 ```rb
 puts result.document.inference.prediction.document_type.value
@@ -396,7 +396,7 @@ puts result.document.inference.prediction.invoice_number.value
 ```
 
 ## Line Items
-**line_items** (Array<[FinancialDocumentV1LineItem](#line-items-field)>): List of line item details.
+**line_items** (Array<[FinancialDocumentV1LineItem](#line-items-field)>): List of line item present on the document.
 
 ```rb
 result.document.inference.prediction.line_items do |line_items_elem|
@@ -405,7 +405,7 @@ end
 ```
 
 ## Locale
-**locale** ([LocaleField](#locale-field)): The locale detected on the document.
+**locale** ([LocaleField](#locale-field)): The locale of the document.
 
 ```rb
 puts result.document.inference.prediction.locale.value
@@ -419,7 +419,7 @@ puts result.document.inference.prediction.payment_date.value
 ```
 
 ## Purchase Order Number
-**po_number** ([StringField](#string-field)): The purchase order number.
+**po_number** ([StringField](#string-field)): The purchase order number, only if the document is an invoice.
 
 ```rb
 puts result.document.inference.prediction.po_number.value
@@ -433,7 +433,7 @@ puts result.document.inference.prediction.receipt_number.value
 ```
 
 ## Reference Numbers
-**reference_numbers** (Array<[StringField](#string-field)>): List of Reference numbers, including PO number.
+**reference_numbers** (Array<[StringField](#string-field)>): List of Reference numbers, including PO number, only if the document is an invoice.
 
 ```rb
 result.document.inference.prediction.reference_numbers do |reference_numbers_elem|
@@ -449,14 +449,15 @@ puts result.document.inference.prediction.shipping_address.value
 ```
 
 ## Purchase Subcategory
-**subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
+**subcategory** ([ClassificationField](#classification-field)): The purchase subcategory for transport and food, only for receipts.
 
 #### Possible values include:
- - plane
- - taxi
- - train
- - restaurant
- - shopping
+ - 'plane'
+ - 'taxi'
+ - 'train'
+ - 'restaurant'
+ - 'shopping'
+ - nil
 
 ```rb
 puts result.document.inference.prediction.subcategory.value
@@ -470,7 +471,7 @@ 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.
+**supplier_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registration numbers associated to the supplier.
 
 ```rb
 result.document.inference.prediction.supplier_company_registrations do |supplier_company_registrations_elem|
@@ -493,7 +494,7 @@ 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.
+**supplier_payment_details** (Array<[PaymentDetailsField](#payment-details-field)>): List of payment details associated to the supplier (only for invoices).
 
 ```rb
 result.document.inference.prediction.supplier_payment_details do |supplier_payment_details_elem|
@@ -519,7 +520,7 @@ puts result.document.inference.prediction.supplier_website.value
 ```
 
 ## Taxes
-**taxes** (Array<[TaxField](#taxes-field)>): List of tax lines information.
+**taxes** (Array<[TaxField](#taxes-field)>): List of all taxes on the document.
 
 ```rb
 result.document.inference.prediction.taxes do |taxes_elem|
@@ -528,7 +529,7 @@ end
 ```
 
 ## Purchase Time
-**time** ([StringField](#string-field)): The time the purchase was made.
+**time** ([StringField](#string-field)): The time the purchase was made (only for receipts).
 
 ```rb
 puts result.document.inference.prediction.time.value
@@ -556,7 +557,7 @@ puts result.document.inference.prediction.total_net.value
 ```
 
 ## Total Tax
-**total_tax** ([AmountField](#amount-field)): The total amount of taxes.
+**total_tax** ([AmountField](#amount-field)): The sum of all taxes present on the document.
 
 ```rb
 puts result.document.inference.prediction.total_tax.value

data/docs/global_products/international_id_v2.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - International ID
+title: International ID
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-international-id-ocr
 parentDoc: 67b49df15b843f3fa9cd622b
@@ -168,12 +168,12 @@ puts result.document.inference.prediction.document_number.value
 **document_type** ([ClassificationField](#classification-field)): The type of personal identification document.
 
 #### Possible values include:
- - IDENTIFICATION_CARD
- - PASSPORT
- - DRIVER_LICENSE
- - VISA
- - RESIDENCY_CARD
- - VOTER_REGISTRATION
+ - 'IDENTIFICATION_CARD'
+ - 'PASSPORT'
+ - 'DRIVER_LICENSE'
+ - 'VISA'
+ - 'RESIDENCY_CARD'
+ - 'VOTER_REGISTRATION'
 
 ```rb
 puts result.document.inference.prediction.document_type.value

data/docs/global_products/invoice_splitter_v1.md

@@ -1,35 +1,42 @@
 ---
-title: Invoice Splitter API Ruby
+title: Invoice Splitter
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-invoice-splitter-ocr
 parentDoc: 67b49df15b843f3fa9cd622b
 ---
 The Ruby Client Library supports the [Invoice Splitter API](https://platform.mindee.com/mindee/invoice_splitter).
 
+
 > 📝 Product Specs
 >
-> | Specification                  | Details            |
-> | ------------------------------ |--------------------|
-> | Endpoint Name                  | `invoice_splitter` |
-> | Recommended Version            | `v1.2`             |
-> | Supports Polling/Webhooks      | ✔️ Yes             |
-> | Support Synchronous HTTP Calls | ❌ No               |
-> | Geography                      | 🌐 Global          |
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `invoice_splitter`                                 |
+> | Recommended Version            | `v1.2`                                             |
+> | 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 [this sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoice_splitter/default_sample.pdf), we are going to illustrate detect the pages of multiple invoices within the same document using the
-Ruby Client Library.
 
-# Quick-Start
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/invoice_splitter/default_sample.pdf),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
+![Invoice Splitter sample](https://github.com/mindee/client-lib-test-data/blob/main/products/invoice_splitter/default_sample.pdf?raw=true)
 
+# Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -38,6 +45,7 @@ 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::InvoiceSplitter::InvoiceSplitterV1
@@ -60,46 +68,58 @@ Document
 
 Inference
 #########
-:Product: mindee/invoice_splitter v1.1
+:Product: mindee/invoice_splitter v1.2
 :Rotation applied: No
 
 Prediction
 ==========
 :Invoice Page Groups:
-  :Page indexes: 0
-  :Page indexes: 1
+  +--------------------------------------------------------------------------+
+  | Page Indexes                                                             |
+  +==========================================================================+
+  | 0                                                                        |
+  +--------------------------------------------------------------------------+
+  | 1                                                                        |
+  +--------------------------------------------------------------------------+
+```
 
-Page Predictions
-================
+# Field Types
+## Standard Fields
+These fields are generic and used in several products.
 
-Page 0
-------
-:Invoice Page Groups:
+### 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:
 
-Page 1
-------
-:Invoice Page Groups:
-```
+* **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.
 
-# Field Types
 ## Specific Fields
-### Invoice Splitter V1 Page Group
-List of page group indexes.
+Fields which are specific to this product; they are not used in any other product.
+
+### Invoice Page Groups Field
+List of page groups. Each group represents a single invoice within a multi-invoice document.
 
-An `InvoiceSplitterV1PageGroup` implements the following attributes:
+A `InvoiceSplitterV1InvoicePageGroup` 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.
+* `page_indexes` (Array<Integer>): List of page indexes that belong to the same invoice (group).
 
 # 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.
+**invoice_page_groups** (Array<[InvoiceSplitterV1InvoicePageGroup](#invoice-page-groups-field)>): List of page groups. Each group represents a single invoice within a multi-invoice document.
 
 ```rb
-result.document.inference.prediction.invoice_page_groups.each do |invoice_page_groups_elem|
-  puts invoice_page_groups_elem.page_indexes.join(', ')
+result.document.inference.prediction.invoice_page_groups do |invoice_page_groups_elem|
+  puts invoice_page_groups_elem.value
 end
 ```
 

data/docs/global_products/invoices_v4.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Invoice
+title: Invoice
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-invoice-ocr
 parentDoc: 67b49df15b843f3fa9cd622b
@@ -272,12 +272,12 @@ objects, it has access to a custom `to_s` method that can render a `TaxField` ob
 Fields which are specific to this product; they are not used in any other product.
 
 ### Line Items Field
-List of line item details.
+List of all the line items present on the invoice.
 
 A `InvoiceV4LineItem` implements the following attributes:
 
 * `description` (String): The item description.
-* `product_code` (String): The product code referring to the item.
+* `product_code` (String): The product code of the item.
 * `quantity` (Float): The item quantity
 * `tax_amount` (Float): The item tax amount.
 * `tax_rate` (Float): The item tax rate in percentage.
@@ -289,7 +289,7 @@ A `InvoiceV4LineItem` implements the following attributes:
 The following fields are extracted for Invoice V4:
 
 ## Billing Address
-**billing_address** ([StringField](#string-field)): The customer's address used for billing.
+**billing_address** ([StringField](#string-field)): The customer billing address.
 
 ```rb
 puts result.document.inference.prediction.billing_address.value
@@ -303,7 +303,7 @@ 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.
+**customer_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registration numbers associated to the customer.
 
 ```rb
 result.document.inference.prediction.customer_company_registrations do |customer_company_registrations_elem|
@@ -333,11 +333,11 @@ puts result.document.inference.prediction.date.value
 ```
 
 ## Document Type
-**document_type** ([ClassificationField](#classification-field)): One of: 'INVOICE', 'CREDIT NOTE'.
+**document_type** ([ClassificationField](#classification-field)): Document type: INVOICE or CREDIT NOTE.
 
 #### Possible values include:
- - INVOICE
- - CREDIT NOTE
+ - 'INVOICE'
+ - 'CREDIT NOTE'
 
 ```rb
 puts result.document.inference.prediction.document_type.value
@@ -358,7 +358,7 @@ puts result.document.inference.prediction.invoice_number.value
 ```
 
 ## Line Items
-**line_items** (Array<[InvoiceV4LineItem](#line-items-field)>): List of line item details.
+**line_items** (Array<[InvoiceV4LineItem](#line-items-field)>): List of all the line items present on the invoice.
 
 ```rb
 result.document.inference.prediction.line_items do |line_items_elem|
@@ -367,14 +367,14 @@ end
 ```
 
 ## Locale
-**locale** ([LocaleField](#locale-field)): The locale detected on the document.
+**locale** ([LocaleField](#locale-field)): The locale of the document.
 
 ```rb
 puts result.document.inference.prediction.locale.value
 ```
 
 ## Payment Date
-**payment_date** ([DateField](#date-field)): The date on which the payment is due/ was full-filled.
+**payment_date** ([DateField](#date-field)): The date on which the payment is due / was full-filled.
 
 ```rb
 puts result.document.inference.prediction.payment_date.value
@@ -388,7 +388,7 @@ puts result.document.inference.prediction.po_number.value
 ```
 
 ## Reference Numbers
-**reference_numbers** (Array<[StringField](#string-field)>): List of Reference numbers, including PO number.
+**reference_numbers** (Array<[StringField](#string-field)>): List of all reference numbers on the invoice, including the purchase order number.
 
 ```rb
 result.document.inference.prediction.reference_numbers do |reference_numbers_elem|
@@ -411,7 +411,7 @@ 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.
+**supplier_company_registrations** (Array<[CompanyRegistrationField](#company-registration-field)>): List of company registration numbers associated to the supplier.
 
 ```rb
 result.document.inference.prediction.supplier_company_registrations do |supplier_company_registrations_elem|
@@ -420,7 +420,7 @@ end
 ```
 
 ## Supplier Email
-**supplier_email** ([StringField](#string-field)): The email of the supplier or merchant.
+**supplier_email** ([StringField](#string-field)): The email address of the supplier or merchant.
 
 ```rb
 puts result.document.inference.prediction.supplier_email.value
@@ -434,7 +434,7 @@ 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.
+**supplier_payment_details** (Array<[PaymentDetailsField](#payment-details-field)>): List of payment details associated to the supplier of the invoice.
 
 ```rb
 result.document.inference.prediction.supplier_payment_details do |supplier_payment_details_elem|
@@ -460,7 +460,7 @@ puts result.document.inference.prediction.supplier_website.value
 ```
 
 ## Taxes
-**taxes** (Array<[TaxField](#taxes-field)>): List of tax line details.
+**taxes** (Array<[TaxField](#taxes-field)>): List of taxes. Each item contains the detail of the tax.
 
 ```rb
 result.document.inference.prediction.taxes do |taxes_elem|
@@ -469,21 +469,21 @@ end
 ```
 
 ## Total Amount
-**total_amount** ([AmountField](#amount-field)): The total amount paid: includes taxes, tips, fees, and other charges.
+**total_amount** ([AmountField](#amount-field)): The total amount of the invoice: 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.
+**total_net** ([AmountField](#amount-field)): The net amount of the invoice: does not include taxes, fees, and discounts.
 
 ```rb
 puts result.document.inference.prediction.total_net.value
 ```
 
 ## Total Tax
-**total_tax** ([AmountField](#amount-field)): The total tax: includes all the taxes paid for this invoice.
+**total_tax** ([AmountField](#amount-field)): The total tax: the sum of all the taxes for this invoice.
 
 ```rb
 puts result.document.inference.prediction.total_tax.value

data/docs/global_products/multi_receipts_detector_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Multi Receipts Detector
+title: Multi Receipts Detector
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-multi-receipts-detector-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products/nutrition_facts_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Nutrition Facts Label
+title: Nutrition Facts Label
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-nutrition-facts-label-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products/passport_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Passport
+title: Passport
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-passport-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products/resume_v1.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Client Library - Resume
+title: Resume
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-resume-ocr
 parentDoc: 67b49df15b843f3fa9cd622b
@@ -265,9 +265,9 @@ puts result.document.inference.prediction.document_language.value
 **document_type** ([ClassificationField](#classification-field)): The type of the document sent.
 
 #### Possible values include:
- - RESUME
- - MOTIVATION_LETTER
- - RECOMMENDATION_LETTER
+ - 'RESUME'
+ - 'MOTIVATION_LETTER'
+ - 'RECOMMENDATION_LETTER'
 
 ```rb
 puts result.document.inference.prediction.document_type.value

data/docs/global_products/universal.md

@@ -1,5 +1,5 @@
 ---
-title: Universal API Ruby
+title: Universal
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-universal-ocr
 parentDoc: 67b49df15b843f3fa9cd622b

data/docs/global_products.md

@@ -3,4 +3,4 @@ title: Global Products
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-global-products
 parentDoc: 6294d97ee723f1008d2ab28e
----
+---