📝 add classification detail to guide documentation

mindee · Sep 2, 2024 · 97fcc6d · 97fcc6d
1 parent 366ed5d
commit 97fcc6d
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 0 deletions.
diff --git a/docs/expense_receipts_v5.md b/docs/expense_receipts_v5.md
@@ -193,6 +193,16 @@ The following fields are extracted for Receipt V5:
 ## Purchase Category
 **category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
 
+> Possible values include:
+> - toll
+> - food
+> - parking
+> - transport
+> - accommodation
+> - gasoline
+> - telecom
+> - miscellaneous
+
 ```rb
 puts result.document.inference.prediction.category.value
 ```
@@ -207,6 +217,10 @@ puts result.document.inference.prediction.date.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
 
+> Possible values include:
+> - expense_receipt
+> - credit_card_receipt
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```
@@ -237,6 +251,13 @@ puts result.document.inference.prediction.receipt_number.value
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
 
+> Possible values include:
+> - plane
+> - taxi
+> - train
+> - restaurant
+> - shopping
+
 ```rb
 puts result.document.inference.prediction.subcategory.value
 ```

diff --git a/docs/financial_document_v1.md b/docs/financial_document_v1.md
@@ -269,6 +269,16 @@ puts result.document.inference.prediction.billing_address.value
 ## Purchase Category
 **category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
 
+> Possible values include:
+> - toll
+> - food
+> - parking
+> - transport
+> - accommodation
+> - gasoline
+> - telecom
+> - miscellaneous
+
 ```rb
 puts result.document.inference.prediction.category.value
 ```
@@ -320,6 +330,12 @@ puts result.document.inference.prediction.document_number.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
 
+> Possible values include:
+> - INVOICE
+> - CREDIT NOTE
+> - CREDIT CARD RECEIPT
+> - EXPENSE RECEIPT
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```
@@ -380,6 +396,13 @@ puts result.document.inference.prediction.shipping_address.value
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
 
+> Possible values include:
+> - plane
+> - taxi
+> - train
+> - restaurant
+> - shopping
+
 ```rb
 puts result.document.inference.prediction.subcategory.value
 ```

diff --git a/docs/idcard_fr_v2.md b/docs/idcard_fr_v2.md
@@ -173,6 +173,11 @@ puts result.document.inference.prediction.document_number.value
 ## Document Sides
 [📄](#page-level-fields "This field is only present on individual pages.")**document_side** ([ClassificationField](#classification-field)): The sides of the document which are visible.
 
+> Possible values include:
+> - RECTO
+> - VERSO
+> - RECTO & VERSO
+
 ```rb
 for document_side_elem in result.document.document_side do
   puts document_side_elem.value
@@ -182,6 +187,10 @@ end
 ## Document Type
 [📄](#page-level-fields "This field is only present on individual pages.")**document_type** ([ClassificationField](#classification-field)): The document type or format.
 
+> Possible values include:
+> - NEW
+> - OLD
+
 ```rb
 for document_type_elem in result.document.document_type do
   puts document_type_elem.value

diff --git a/docs/international_id_v2.md b/docs/international_id_v2.md
@@ -141,6 +141,14 @@ puts result.document.inference.prediction.document_number.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): The type of personal identification document.
 
+> Possible values include:
+> - IDENTIFICATION_CARD
+> - PASSPORT
+> - DRIVER_LICENSE
+> - VISA
+> - RESIDENCY_CARD
+> - VOTER_REGISTRATION
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```

diff --git a/docs/invoices_v4.md b/docs/invoices_v4.md
@@ -294,6 +294,10 @@ puts result.document.inference.prediction.date.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): One of: 'INVOICE', 'CREDIT NOTE'.
 
+> Possible values include:
+> - INVOICE
+> - CREDIT NOTE
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```

diff --git a/docs/resume_v1.md b/docs/resume_v1.md
@@ -169,6 +169,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
@@ -177,6 +184,13 @@ The list of the candidate's professional experiences.
 A `ResumeV1ProfessionalExperience` implements the following attributes:
 
 * `contract_type` (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.
 * `end_month` (String): The month when the professional experience ended.
@@ -223,6 +237,11 @@ puts result.document.inference.prediction.document_language.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): The type of the document sent.
 
+> Possible values include:
+> - RESUME
+> - MOTIVATION_LETTER
+> - RECOMMENDATION_LETTER
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```