diff --git a/docs/expense_receipts_v5.md b/docs/expense_receipts_v5.md index 8e8c5e168..e0a55816d 100644 --- a/docs/expense_receipts_v5.md +++ b/docs/expense_receipts_v5.md @@ -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); ``` @@ -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); ``` @@ -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); ``` diff --git a/docs/financial_document_v1.md b/docs/financial_document_v1.md index 475d1e408..65a9a0791 100644 --- a/docs/financial_document_v1.md +++ b/docs/financial_document_v1.md @@ -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); ``` @@ -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); ``` @@ -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); ``` diff --git a/docs/idcard_fr_v2.md b/docs/idcard_fr_v2.md index f8fd88f50..bf00ee1d7 100644 --- a/docs/idcard_fr_v2.md +++ b/docs/idcard_fr_v2.md @@ -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()) { @@ -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()) { diff --git a/docs/international_id_v2.md b/docs/international_id_v2.md index a8e295832..24663bcce 100644 --- a/docs/international_id_v2.md +++ b/docs/international_id_v2.md @@ -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); ``` diff --git a/docs/invoices_v4.md b/docs/invoices_v4.md index ce327f940..95a433107 100644 --- a/docs/invoices_v4.md +++ b/docs/invoices_v4.md @@ -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); ``` diff --git a/docs/resume_v1.md b/docs/resume_v1.md index f4eba174c..66c66d939 100644 --- a/docs/resume_v1.md +++ b/docs/resume_v1.md @@ -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 @@ -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. @@ -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); ```