From df19c09c3eb33c5cbff31d1aabbe732c19021877 Mon Sep 17 00:00:00 2001 From: sebastianMindee Date: Mon, 2 Sep 2024 16:18:29 +0200 Subject: [PATCH 1/2] :memo: add classification detail to guide documentation --- docs/expense_receipts_v5.md | 21 +++++++++++++++++++++ docs/financial_document_v1.md | 23 +++++++++++++++++++++++ docs/idcard_fr_v2.md | 9 +++++++++ docs/international_id_v2.md | 8 ++++++++ docs/invoices_v4.md | 4 ++++ docs/resume_v1.md | 19 +++++++++++++++++++ 6 files changed, 84 insertions(+) diff --git a/docs/expense_receipts_v5.md b/docs/expense_receipts_v5.md index 8e8c5e168..d30cfb2f7 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..144217bee 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..d049bb54a 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..78d2a17f9 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..0cc95db50 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..f8f033dcb 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); ``` From 8637963a3591651e6e7f178c110d7d377228d4e8 Mon Sep 17 00:00:00 2001 From: sebastianMindee Date: Wed, 4 Sep 2024 17:54:48 +0200 Subject: [PATCH 2/2] update syntax --- docs/expense_receipts_v5.md | 36 +++++++++++++++---------------- docs/financial_document_v1.md | 40 +++++++++++++++++------------------ docs/idcard_fr_v2.md | 14 ++++++------ docs/international_id_v2.md | 14 ++++++------ docs/invoices_v4.md | 6 +++--- docs/resume_v1.md | 28 ++++++++++++------------ 6 files changed, 69 insertions(+), 69 deletions(-) diff --git a/docs/expense_receipts_v5.md b/docs/expense_receipts_v5.md index d30cfb2f7..e0a55816d 100644 --- a/docs/expense_receipts_v5.md +++ b/docs/expense_receipts_v5.md @@ -223,15 +223,15 @@ 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 +#### Possible values include: + - toll + - food + - parking + - transport + - accommodation + - gasoline + - telecom + - miscellaneous ```java System.out.println(result.getDocument().getInference().getPrediction().getCategory().value); @@ -247,9 +247,9 @@ 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 +#### Possible values include: + - expense_receipt + - credit_card_receipt ```java System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value); @@ -282,12 +282,12 @@ 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 +#### 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 144217bee..65a9a0791 100644 --- a/docs/financial_document_v1.md +++ b/docs/financial_document_v1.md @@ -313,15 +313,15 @@ 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 +#### Possible values include: + - toll + - food + - parking + - transport + - accommodation + - gasoline + - telecom + - miscellaneous ```java System.out.println(result.getDocument().getInference().getPrediction().getCategory().value); @@ -375,11 +375,11 @@ 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 +#### Possible values include: + - INVOICE + - CREDIT NOTE + - CREDIT CARD RECEIPT + - EXPENSE RECEIPT ```java System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value); @@ -443,12 +443,12 @@ 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 +#### 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 d049bb54a..bf00ee1d7 100644 --- a/docs/idcard_fr_v2.md +++ b/docs/idcard_fr_v2.md @@ -199,10 +199,10 @@ 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 +#### Possible values include: + - RECTO + - VERSO + - RECTO & VERSO ```java for (ClassificationField documentSideElem : result.getDocument().getInference().getPrediction().getDocumentSide()) @@ -215,9 +215,9 @@ 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 +#### 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 78d2a17f9..24663bcce 100644 --- a/docs/international_id_v2.md +++ b/docs/international_id_v2.md @@ -167,13 +167,13 @@ 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 +#### 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 0cc95db50..95a433107 100644 --- a/docs/invoices_v4.md +++ b/docs/invoices_v4.md @@ -339,9 +339,9 @@ System.out.println(result.getDocument().getInference().getPrediction().getDate() ## Document Type **documentType**: One of: 'INVOICE', 'CREDIT NOTE'. -> Possible values include: -> - 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 f8f033dcb..66c66d939 100644 --- a/docs/resume_v1.md +++ b/docs/resume_v1.md @@ -196,11 +196,11 @@ 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 +#### Possible values include: + - Fluent + - Proficient + - Intermediate + - Beginner Fields which are specific to this product; they are not used in any other product. @@ -211,11 +211,11 @@ 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 +#### 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. @@ -264,10 +264,10 @@ 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 +#### Possible values include: + - RESUME + - MOTIVATION_LETTER + - RECOMMENDATION_LETTER ```java System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);