Skip to content

♻️ update CLI syntax & files layout #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sebastianMindee merged 4 commits into from
Mar 19, 2025
Merged

♻️ update CLI syntax & files layout #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1bff470
temp
sebastianMindee Mar 18, 2025
e355c37
:recycle: update CLI syntax & files layout
sebastianMindee Mar 19, 2025
6112e28
:recycle: upgrade descriptions, documentation & CLI products
sebastianMindee Mar 19, 2025
74e8dec
fix broken CLI
sebastianMindee Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 25 additions & 24 deletions docs/expense_receipts_v5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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);
Expand All @@ -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())
Expand All @@ -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);
Expand All @@ -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);
Expand All @@ -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())
Expand All @@ -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())
Expand Down Expand Up @@ -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);
Expand Down
65 changes: 33 additions & 32 deletions docs/financial_document_v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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);
Expand All @@ -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())
Expand Down Expand Up @@ -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);
Expand All @@ -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())
Expand All @@ -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);
Expand All @@ -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);
Expand All @@ -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())
Expand All @@ -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);
Expand All @@ -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())
Expand All @@ -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())
Expand All @@ -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())
Expand All @@ -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);
Expand Down Expand Up @@ -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);
Expand Down
10 changes: 5 additions & 5 deletions docs/idcard_fr_v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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())
Expand All @@ -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())
Expand Down
8 changes: 4 additions & 4 deletions docs/ind_passport_v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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);
Expand Down
12 changes: 6 additions & 6 deletions docs/international_id_v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
22 changes: 8 additions & 14 deletions docs/invoice_splitter_v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading