Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions docs/expense_receipts_v5.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,16 @@ The following fields are extracted for Receipt V5:
## Purchase Category
**category**: The purchase category among predefined classes.

#### Possible values include:
- toll
- food
- parking
- transport
- accommodation
- gasoline
- telecom
- miscellaneous

```java
System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
```
Expand All @@ -237,6 +247,10 @@ System.out.println(result.getDocument().getInference().getPrediction().getDate()
## Document Type
**documentType**: One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.

#### Possible values include:
- expense_receipt
- credit_card_receipt

```java
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
```
Expand Down Expand Up @@ -268,6 +282,13 @@ System.out.println(result.getDocument().getInference().getPrediction().getReceip
## Purchase Subcategory
**subcategory**: The purchase subcategory among predefined classes for transport and food.

#### Possible values include:
- plane
- taxi
- train
- restaurant
- shopping

```java
System.out.println(result.getDocument().getInference().getPrediction().getSubcategory().value);
```
Expand Down
23 changes: 23 additions & 0 deletions docs/financial_document_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,16 @@ System.out.println(result.getDocument().getInference().getPrediction().getBillin
## Purchase Category
**category**: The purchase category among predefined classes.

#### Possible values include:
- toll
- food
- parking
- transport
- accommodation
- gasoline
- telecom
- miscellaneous

```java
System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
```
Expand Down Expand Up @@ -365,6 +375,12 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
## Document Type
**documentType**: One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.

#### Possible values include:
- INVOICE
- CREDIT NOTE
- CREDIT CARD RECEIPT
- EXPENSE RECEIPT

```java
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
```
Expand Down Expand Up @@ -427,6 +443,13 @@ System.out.println(result.getDocument().getInference().getPrediction().getShippi
## Purchase Subcategory
**subcategory**: The purchase subcategory among predefined classes for transport and food.

#### Possible values include:
- plane
- taxi
- train
- restaurant
- shopping

```java
System.out.println(result.getDocument().getInference().getPrediction().getSubcategory().value);
```
Expand Down
9 changes: 9 additions & 0 deletions docs/idcard_fr_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,11 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
## Document Sides
[📄](#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

```java
for (ClassificationField documentSideElem : result.getDocument().getInference().getPrediction().getDocumentSide())
{
Expand All @@ -210,6 +215,10 @@ for (ClassificationField documentSideElem : result.getDocument().getInference().
## Document Type
[📄](#page-level-fields "This field is only present on individual pages.")**documentType**: The document type or format.

#### Possible values include:
- NEW
- OLD

```java
for (ClassificationField documentTypeElem : result.getDocument().getInference().getPrediction().getDocumentType())
{
Expand Down
8 changes: 8 additions & 0 deletions docs/international_id_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,14 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
## Document Type
**documentType**: The type of personal identification document.

#### Possible values include:
- IDENTIFICATION_CARD
- PASSPORT
- DRIVER_LICENSE
- VISA
- RESIDENCY_CARD
- VOTER_REGISTRATION

```java
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
```
Expand Down
4 changes: 4 additions & 0 deletions docs/invoices_v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,10 @@ System.out.println(result.getDocument().getInference().getPrediction().getDate()
## Document Type
**documentType**: One of: 'INVOICE', 'CREDIT NOTE'.

#### Possible values include:
- INVOICE
- CREDIT NOTE

```java
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
```
Expand Down
19 changes: 19 additions & 0 deletions docs/resume_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,13 @@ A `ResumeV1Language` implements the following attributes:

* **language** (`String`): The language's ISO 639 code.
* **level** (`String`): The candidate's level for the language.

#### Possible values include:
- Fluent
- Proficient
- Intermediate
- Beginner

Fields which are specific to this product; they are not used in any other product.

### Professional Experiences Field
Expand All @@ -203,6 +210,13 @@ The list of the candidate's professional experiences.
A `ResumeV1ProfessionalExperience` implements the following attributes:

* **contractType** (`String`): The type of contract for the professional experience.

#### Possible values include:
- Full-Time
- Part-Time
- Internship
- Freelance

* **department** (`String`): The specific department or division within the company.
* **employer** (`String`): The name of the company or organization.
* **endMonth** (`String`): The month when the professional experience ended.
Expand Down Expand Up @@ -250,6 +264,11 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
## Document Type
**documentType**: The type of the document sent.

#### Possible values include:
- RESUME
- MOTIVATION_LETTER
- RECOMMENDATION_LETTER

```java
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
```
Expand Down