📝 update documentation & description on some products (#305)

Author: sebastianMindee

docs/extras/guide/expense_receipts_v5.md

@@ -200,7 +200,7 @@ The `Taxes` field represents a list-like collection of `TaxField` objects. As it
 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:
 
@@ -213,17 +213,17 @@ A `ReceiptV5LineItem` implements the following attributes:
 The following fields are extracted for Receipt V5:
 
 ## Purchase Category
-**category** ([ClassificationField](#classificationfield)): The purchase category among predefined classes.
+**category** ([ClassificationField](#classificationfield)): 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'
 
 ```py
 print(result.document.inference.prediction.category.value)
@@ -237,26 +237,26 @@ print(result.document.inference.prediction.date.value)
 ```
 
 ## Document Type
-**document_type** ([ClassificationField](#classificationfield)): One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
+**document_type** ([ClassificationField](#classificationfield)): The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
 
 #### Possible values include:
- - expense_receipt
- - credit_card_receipt
+ - 'EXPENSE RECEIPT'
+ - 'CREDIT CARD RECEIPT'
 
 ```py
 print(result.document.inference.prediction.document_type.value)
 ```
 
 ## Line Items
-**line_items** (List[[ReceiptV5LineItem](#line-items-field)]): List of line item details.
+**line_items** (List[[ReceiptV5LineItem](#line-items-field)]): List of all line items on the receipt.
 
 ```py
 for line_items_elem in result.document.inference.prediction.line_items:
     print(line_items_elem)
 ```
 
 ## Expense Locale
-**locale** ([LocaleField](#localefield)): The locale detected on the document.
+**locale** ([LocaleField](#localefield)): The locale of the document.
 
 ```py
 print(result.document.inference.prediction.locale.value)
@@ -270,14 +270,15 @@ print(result.document.inference.prediction.receipt_number.value)
 ```
 
 ## Purchase Subcategory
-**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory among predefined classes for transport and food.
+**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory of the receipt for transport and food.
 
 #### Possible values include:
- - plane
- - taxi
- - train
- - restaurant
- - shopping
+ - 'plane'
+ - 'taxi'
+ - 'train'
+ - 'restaurant'
+ - 'shopping'
+ - None
 
 ```py
 print(result.document.inference.prediction.subcategory.value)
@@ -291,7 +292,7 @@ print(result.document.inference.prediction.supplier_address.value)
 ```
 
 ## Supplier Company Registrations
-**supplier_company_registrations** (List[[CompanyRegistrationField](#companyregistrationfield)]): List of company registrations associated to the supplier.
+**supplier_company_registrations** (List[[CompanyRegistrationField](#companyregistrationfield)]): List of company registration numbers associated to the supplier.
 
 ```py
 for supplier_company_registrations_elem in result.document.inference.prediction.supplier_company_registrations:
@@ -313,7 +314,7 @@ print(result.document.inference.prediction.supplier_phone_number.value)
 ```
 
 ## Taxes
-**taxes** (List[[TaxField](#taxes)]): List of tax lines information.
+**taxes** (List[[TaxField](#taxes)]): The list of taxes present on the receipt.
 
 ```py
 for taxes_elem in result.document.inference.prediction.taxes:
@@ -349,7 +350,7 @@ print(result.document.inference.prediction.total_net.value)
 ```
 
 ## Total Tax
-**total_tax** ([AmountField](#amountfield)): The total amount of taxes.
+**total_tax** ([AmountField](#amountfield)): The sum of all taxes.
 
 ```py
 print(result.document.inference.prediction.total_tax.value)

docs/extras/guide/financial_document_v1.md

@@ -244,7 +244,7 @@ The `Taxes` field represents a list-like collection of `TaxField` objects. As it
 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:
 
@@ -268,17 +268,17 @@ print(result.document.inference.prediction.billing_address.value)
 ```
 
 ## Purchase Category
-**category** ([ClassificationField](#classificationfield)): The purchase category among predefined classes.
+**category** ([ClassificationField](#classificationfield)): 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'
 
 ```py
 print(result.document.inference.prediction.category.value)
@@ -292,7 +292,7 @@ print(result.document.inference.prediction.customer_address.value)
 ```
 
 ## Customer Company Registrations
-**customer_company_registrations** (List[[CompanyRegistrationField](#companyregistrationfield)]): List of company registrations associated to the customer.
+**customer_company_registrations** (List[[CompanyRegistrationField](#companyregistrationfield)]): List of company registration numbers associated to the customer.
 
 ```py
 for customer_company_registrations_elem in result.document.inference.prediction.customer_company_registrations:
@@ -321,20 +321,20 @@ print(result.document.inference.prediction.date.value)
 ```
 
 ## Document Number
-**document_number** ([StringField](#stringfield)): The document number or identifier.
+**document_number** ([StringField](#stringfield)): The document number or identifier (invoice number or receipt number).
 
 ```py
 print(result.document.inference.prediction.document_number.value)
 ```
 
 ## Document Type
-**document_type** ([ClassificationField](#classificationfield)): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
+**document_type** ([ClassificationField](#classificationfield)): 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'
 
 ```py
 print(result.document.inference.prediction.document_type.value)
@@ -355,15 +355,15 @@ print(result.document.inference.prediction.invoice_number.value)
 ```
 
 ## Line Items
-**line_items** (List[[FinancialDocumentV1LineItem](#line-items-field)]): List of line item details.
+**line_items** (List[[FinancialDocumentV1LineItem](#line-items-field)]): List of line item present on the document.
 
 ```py
 for line_items_elem in result.document.inference.prediction.line_items:
     print(line_items_elem)
 ```
 
 ## Locale
-**locale** ([LocaleField](#localefield)): The locale detected on the document.
+**locale** ([LocaleField](#localefield)): The locale of the document.
 
 ```py
 print(result.document.inference.prediction.locale.value)
@@ -377,7 +377,7 @@ print(result.document.inference.prediction.payment_date.value)
 ```
 
 ## Purchase Order Number
-**po_number** ([StringField](#stringfield)): The purchase order number.
+**po_number** ([StringField](#stringfield)): The purchase order number, only if the document is an invoice.
 
 ```py
 print(result.document.inference.prediction.po_number.value)
@@ -391,7 +391,7 @@ print(result.document.inference.prediction.receipt_number.value)
 ```
 
 ## Reference Numbers
-**reference_numbers** (List[[StringField](#stringfield)]): List of Reference numbers, including PO number.
+**reference_numbers** (List[[StringField](#stringfield)]): List of Reference numbers, including PO number, only if the document is an invoice.
 
 ```py
 for reference_numbers_elem in result.document.inference.prediction.reference_numbers:
@@ -406,14 +406,15 @@ print(result.document.inference.prediction.shipping_address.value)
 ```
 
 ## Purchase Subcategory
-**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory among predefined classes for transport and food.
+**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory for transport and food, only for receipts.
 
 #### Possible values include:
- - plane
- - taxi
- - train
- - restaurant
- - shopping
+ - 'plane'
+ - 'taxi'
+ - 'train'
+ - 'restaurant'
+ - 'shopping'
+ - None
 
 ```py
 print(result.document.inference.prediction.subcategory.value)
@@ -427,7 +428,7 @@ print(result.document.inference.prediction.supplier_address.value)
 ```
 
 ## Supplier Company Registrations
-**supplier_company_registrations** (List[[CompanyRegistrationField](#companyregistrationfield)]): List of company registrations associated to the supplier.
+**supplier_company_registrations** (List[[CompanyRegistrationField](#companyregistrationfield)]): List of company registration numbers associated to the supplier.
 
 ```py
 for supplier_company_registrations_elem in result.document.inference.prediction.supplier_company_registrations:
@@ -449,7 +450,7 @@ print(result.document.inference.prediction.supplier_name.value)
 ```
 
 ## Supplier Payment Details
-**supplier_payment_details** (List[[PaymentDetailsField](#paymentdetailsfield)]): List of payment details associated to the supplier.
+**supplier_payment_details** (List[[PaymentDetailsField](#paymentdetailsfield)]): List of payment details associated to the supplier (only for invoices).
 
 ```py
 for supplier_payment_details_elem in result.document.inference.prediction.supplier_payment_details:
@@ -471,15 +472,15 @@ print(result.document.inference.prediction.supplier_website.value)
 ```
 
 ## Taxes
-**taxes** (List[[TaxField](#taxes)]): List of tax lines information.
+**taxes** (List[[TaxField](#taxes)]): List of all taxes on the document.
 
 ```py
 for taxes_elem in result.document.inference.prediction.taxes:
     print(taxes_elem.polygon)
 ```
 
 ## Purchase Time
-**time** ([StringField](#stringfield)): The time the purchase was made.
+**time** ([StringField](#stringfield)): The time the purchase was made (only for receipts).
 
 ```py
 print(result.document.inference.prediction.time.value)
@@ -507,7 +508,7 @@ print(result.document.inference.prediction.total_net.value)
 ```
 
 ## Total Tax
-**total_tax** ([AmountField](#amountfield)): The total amount of taxes.
+**total_tax** ([AmountField](#amountfield)): The sum of all taxes present on the document.
 
 ```py
 print(result.document.inference.prediction.total_tax.value)

docs/extras/guide/idcard_fr_v2.md

@@ -174,9 +174,9 @@ print(result.document.inference.prediction.document_number.value)
 [📄](#page-level-fields "This field is only present on individual pages.")**document_side** ([ClassificationField](#classificationfield)): The sides of the document which are visible.
 
 #### Possible values include:
- - RECTO
- - VERSO
- - RECTO & VERSO
+ - 'RECTO'
+ - 'VERSO'
+ - 'RECTO & VERSO'
 
 ```py
 for document_side_elem in result.document.document_side:
@@ -187,8 +187,8 @@ for document_side_elem in result.document.document_side:
 [📄](#page-level-fields "This field is only present on individual pages.")**document_type** ([ClassificationField](#classificationfield)): The document type or format.
 
 #### Possible values include:
- - NEW
- - OLD
+ - 'NEW'
+ - 'OLD'
 
 ```py
 for document_type_elem in result.document.document_type:

docs/extras/guide/ind_passport_v1.md

@@ -167,8 +167,8 @@ print(result.document.inference.prediction.file_number.value)
 **gender** ([ClassificationField](#classificationfield)): The gender of the passport holder.
 
 #### Possible values include:
- - M
- - F
+ - 'M'
+ - 'F'
 
 ```py
 print(result.document.inference.prediction.gender.value)
@@ -262,8 +262,8 @@ print(result.document.inference.prediction.old_passport_place_of_issue.value)
 **page_number** ([ClassificationField](#classificationfield)): The page number of the passport document.
 
 #### Possible values include:
- - 1
- - 2
+ - '1'
+ - '2'
 
 ```py
 print(result.document.inference.prediction.page_number.value)

docs/extras/guide/international_id_v2.md

@@ -141,12 +141,12 @@ print(result.document.inference.prediction.document_number.value)
 **document_type** ([ClassificationField](#classificationfield)): 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'
 
 ```py
 print(result.document.inference.prediction.document_type.value)

docs/extras/guide/invoice_splitter_v1.md

@@ -40,25 +40,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