♻️ update CLI syntax & files layout (#224)

Author: sebastianMindee

docs/expense_receipts_v5.md

@@ -255,7 +255,7 @@ The `Taxes` field represents a List of `TaxField` objects. As it is the represen
 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 line items on the receipt.
 
 A `ReceiptV5LineItem` implements the following attributes:
 
@@ -268,17 +268,17 @@ A `ReceiptV5LineItem` implements the following attributes:
 The following fields are extracted for Receipt V5:
 
 ## Purchase Category
-**category**: The purchase category among predefined classes.
+**category**: The purchase category of the receipt.
 
 #### Possible values include:
- - toll
- - food
- - parking
- - transport
- - accommodation
- - gasoline
- - telecom
- - miscellaneous
+ - 'toll'
+ - 'food'
+ - 'parking'
+ - 'transport'
+ - 'accommodation'
+ - 'gasoline'
+ - 'telecom'
+ - 'miscellaneous'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
@@ -292,18 +292,18 @@ System.out.println(result.getDocument().getInference().getPrediction().getDate()
 ```
 
 ## Document Type
-**documentType**: One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
+**documentType**: The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
 
 #### Possible values include:
- - expense_receipt
- - credit_card_receipt
+ - 'EXPENSE RECEIPT'
+ - 'CREDIT CARD RECEIPT'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
 ```
 
 ## Line Items
-**lineItems**(List<[ReceiptV5LineItem](#line-items-field)>): List of line item details.
+**lineItems**(List<[ReceiptV5LineItem](#line-items-field)>): List of all line items on the receipt.
 
 ```java
 for (lineItemsElem : result.getDocument().getInference().getPrediction().getLineItems())
@@ -313,7 +313,7 @@ for (lineItemsElem : result.getDocument().getInference().getPrediction().getLine
 ```
 
 ## Expense Locale
-**locale**: The locale detected on the document.
+**locale**: The locale of the document.
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getLocale().value);
@@ -327,14 +327,15 @@ System.out.println(result.getDocument().getInference().getPrediction().getReceip
 ```
 
 ## Purchase Subcategory
-**subcategory**: The purchase subcategory among predefined classes for transport and food.
+**subcategory**: The purchase subcategory of the receipt for transport and food.
 
 #### Possible values include:
- - plane
- - taxi
- - train
- - restaurant
- - shopping
+ - 'plane'
+ - 'taxi'
+ - 'train'
+ - 'restaurant'
+ - 'shopping'
+ - null
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getSubcategory().value);
@@ -348,7 +349,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getSuppli
 ```
 
 ## Supplier Company Registrations
-**supplierCompanyRegistrations**: List of company registrations associated to the supplier.
+**supplierCompanyRegistrations**: List of company registration numbers associated to the supplier.
 
 ```java
 for (supplierCompanyRegistrationsElem : result.getDocument().getInference().getPrediction().getSupplierCompanyRegistrations())
@@ -372,7 +373,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getSuppli
 ```
 
 ## Taxes
-**taxes**: List of tax lines information.
+**taxes**: The list of taxes present on the receipt.
 
 ```java
 for (taxesElem : result.getDocument().getInference().getPrediction().getTaxes())
@@ -410,7 +411,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getTotalN
 ```
 
 ## Total Tax
-**totalTax**: The total amount of taxes.
+**totalTax**: The sum of all taxes.
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getTotalTax().value);

docs/financial_document_v1.md

@@ -291,7 +291,7 @@ The `Taxes` field represents a List of `TaxField` objects. As it is the represen
 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:
 
@@ -315,17 +315,17 @@ System.out.println(result.getDocument().getInference().getPrediction().getBillin
 ```
 
 ## Purchase Category
-**category**: The purchase category among predefined classes.
+**category**: 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'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
@@ -339,7 +339,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getCustom
 ```
 
 ## Customer Company Registrations
-**customerCompanyRegistrations**: List of company registrations associated to the customer.
+**customerCompanyRegistrations**: List of company registration numbers associated to the customer.
 
 ```java
 for (customerCompanyRegistrationsElem : result.getDocument().getInference().getPrediction().getCustomerCompanyRegistrations())
@@ -370,20 +370,20 @@ System.out.println(result.getDocument().getInference().getPrediction().getDate()
 ```
 
 ## Document Number
-**documentNumber**: The document number or identifier.
+**documentNumber**: The document number or identifier (invoice number or receipt number).
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getDocumentNumber().value);
 ```
 
 ## Document Type
-**documentType**: One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
+**documentType**: 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'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
@@ -404,7 +404,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getInvoic
 ```
 
 ## Line Items
-**lineItems**(List<[FinancialDocumentV1LineItem](#line-items-field)>): List of line item details.
+**lineItems**(List<[FinancialDocumentV1LineItem](#line-items-field)>): List of line item present on the document.
 
 ```java
 for (lineItemsElem : result.getDocument().getInference().getPrediction().getLineItems())
@@ -414,7 +414,7 @@ for (lineItemsElem : result.getDocument().getInference().getPrediction().getLine
 ```
 
 ## Locale
-**locale**: The locale detected on the document.
+**locale**: The locale of the document.
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getLocale().value);
@@ -428,7 +428,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getPaymen
 ```
 
 ## Purchase Order Number
-**poNumber**: The purchase order number.
+**poNumber**: The purchase order number, only if the document is an invoice.
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getPoNumber().value);
@@ -442,7 +442,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getReceip
 ```
 
 ## Reference Numbers
-**referenceNumbers**: List of Reference numbers, including PO number.
+**referenceNumbers**: List of Reference numbers, including PO number, only if the document is an invoice.
 
 ```java
 for (referenceNumbersElem : result.getDocument().getInference().getPrediction().getReferenceNumbers())
@@ -459,14 +459,15 @@ System.out.println(result.getDocument().getInference().getPrediction().getShippi
 ```
 
 ## Purchase Subcategory
-**subcategory**: The purchase subcategory among predefined classes for transport and food.
+**subcategory**: The purchase subcategory for transport and food, only for receipts.
 
 #### Possible values include:
- - plane
- - taxi
- - train
- - restaurant
- - shopping
+ - 'plane'
+ - 'taxi'
+ - 'train'
+ - 'restaurant'
+ - 'shopping'
+ - null
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getSubcategory().value);
@@ -480,7 +481,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getSuppli
 ```
 
 ## Supplier Company Registrations
-**supplierCompanyRegistrations**: List of company registrations associated to the supplier.
+**supplierCompanyRegistrations**: List of company registration numbers associated to the supplier.
 
 ```java
 for (supplierCompanyRegistrationsElem : result.getDocument().getInference().getPrediction().getSupplierCompanyRegistrations())
@@ -504,7 +505,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getSuppli
 ```
 
 ## Supplier Payment Details
-**supplierPaymentDetails**: List of payment details associated to the supplier.
+**supplierPaymentDetails**: List of payment details associated to the supplier (only for invoices).
 
 ```java
 for (supplierPaymentDetailsElem : result.getDocument().getInference().getPrediction().getSupplierPaymentDetails())
@@ -531,7 +532,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getSuppli
 ```
 
 ## Taxes
-**taxes**: List of tax lines information.
+**taxes**: List of all taxes on the document.
 
 ```java
 for (taxesElem : result.getDocument().getInference().getPrediction().getTaxes())
@@ -541,7 +542,7 @@ for (taxesElem : result.getDocument().getInference().getPrediction().getTaxes())
 ```
 
 ## Purchase Time
-**time**: The time the purchase was made.
+**time**: The time the purchase was made (only for receipts).
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getTime().value);
@@ -569,7 +570,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getTotalN
 ```
 
 ## Total Tax
-**totalTax**: The total amount of taxes.
+**totalTax**: The sum of all taxes present on the document.
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getTotalTax().value);

docs/idcard_fr_v2.md

@@ -200,9 +200,9 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
 [📄](#page-level-fields "This field is only present on individual pages.")**documentSide**: The sides of the document which are visible.
 
 #### Possible values include:
- - RECTO
- - VERSO
- - RECTO & VERSO
+ - 'RECTO'
+ - 'VERSO'
+ - 'RECTO & VERSO'
 
 ```java
 for (ClassificationField documentSideElem : result.getDocument().getInference().getPrediction().getDocumentSide())
@@ -216,8 +216,8 @@ for (ClassificationField documentSideElem : result.getDocument().getInference().
 [📄](#page-level-fields "This field is only present on individual pages.")**documentType**: The document type or format.
 
 #### Possible values include:
- - NEW
- - OLD
+ - 'NEW'
+ - 'OLD'
 
 ```java
 for (ClassificationField documentTypeElem : result.getDocument().getInference().getPrediction().getDocumentType())

docs/ind_passport_v1.md

@@ -194,8 +194,8 @@ System.out.println(result.getDocument().getInference().getPrediction().getFileNu
 **gender**: The gender of the passport holder.
 
 #### Possible values include:
- - M
- - F
+ - 'M'
+ - 'F'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getGender().value);
@@ -289,8 +289,8 @@ System.out.println(result.getDocument().getInference().getPrediction().getOldPas
 **pageNumber**: The page number of the passport document.
 
 #### Possible values include:
- - 1
- - 2
+ - '1'
+ - '2'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getPageNumber().value);

docs/international_id_v2.md

@@ -168,12 +168,12 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
 **documentType**: 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'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);

docs/invoice_splitter_v1.md

@@ -65,25 +65,19 @@ 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 Predictions
-================
-
-Page 0
-------
-:Invoice Page Groups:
-
-Page 1
-------
-:Invoice Page Groups:
+  +--------------------------------------------------------------------------+
+  | Page Indexes                                                             |
+  +==========================================================================+
+  | 0                                                                        |
+  +--------------------------------------------------------------------------+
+  | 1                                                                        |
+  +--------------------------------------------------------------------------+
 ```
 
 # Field Types