Skip to content

Commit 8f9d545

Browse files
📝 add classification detail to guide documentation (#194)
1 parent 199c228 commit 8f9d545

File tree

6 files changed

+84
-0
lines changed

6 files changed

+84
-0
lines changed

docs/expense_receipts_v5.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,16 @@ The following fields are extracted for Receipt V5:
223223
## Purchase Category
224224
**category**: The purchase category among predefined classes.
225225

226+
#### Possible values include:
227+
- toll
228+
- food
229+
- parking
230+
- transport
231+
- accommodation
232+
- gasoline
233+
- telecom
234+
- miscellaneous
235+
226236
```java
227237
System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
228238
```
@@ -237,6 +247,10 @@ System.out.println(result.getDocument().getInference().getPrediction().getDate()
237247
## Document Type
238248
**documentType**: One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
239249

250+
#### Possible values include:
251+
- expense_receipt
252+
- credit_card_receipt
253+
240254
```java
241255
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
242256
```
@@ -268,6 +282,13 @@ System.out.println(result.getDocument().getInference().getPrediction().getReceip
268282
## Purchase Subcategory
269283
**subcategory**: The purchase subcategory among predefined classes for transport and food.
270284

285+
#### Possible values include:
286+
- plane
287+
- taxi
288+
- train
289+
- restaurant
290+
- shopping
291+
271292
```java
272293
System.out.println(result.getDocument().getInference().getPrediction().getSubcategory().value);
273294
```

docs/financial_document_v1.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,16 @@ System.out.println(result.getDocument().getInference().getPrediction().getBillin
313313
## Purchase Category
314314
**category**: The purchase category among predefined classes.
315315

316+
#### Possible values include:
317+
- toll
318+
- food
319+
- parking
320+
- transport
321+
- accommodation
322+
- gasoline
323+
- telecom
324+
- miscellaneous
325+
316326
```java
317327
System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
318328
```
@@ -365,6 +375,12 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
365375
## Document Type
366376
**documentType**: One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
367377

378+
#### Possible values include:
379+
- INVOICE
380+
- CREDIT NOTE
381+
- CREDIT CARD RECEIPT
382+
- EXPENSE RECEIPT
383+
368384
```java
369385
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
370386
```
@@ -427,6 +443,13 @@ System.out.println(result.getDocument().getInference().getPrediction().getShippi
427443
## Purchase Subcategory
428444
**subcategory**: The purchase subcategory among predefined classes for transport and food.
429445

446+
#### Possible values include:
447+
- plane
448+
- taxi
449+
- train
450+
- restaurant
451+
- shopping
452+
430453
```java
431454
System.out.println(result.getDocument().getInference().getPrediction().getSubcategory().value);
432455
```

docs/idcard_fr_v2.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,11 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
199199
## Document Sides
200200
[📄](#page-level-fields "This field is only present on individual pages.")**documentSide**: The sides of the document which are visible.
201201

202+
#### Possible values include:
203+
- RECTO
204+
- VERSO
205+
- RECTO & VERSO
206+
202207
```java
203208
for (ClassificationField documentSideElem : result.getDocument().getInference().getPrediction().getDocumentSide())
204209
{
@@ -210,6 +215,10 @@ for (ClassificationField documentSideElem : result.getDocument().getInference().
210215
## Document Type
211216
[📄](#page-level-fields "This field is only present on individual pages.")**documentType**: The document type or format.
212217

218+
#### Possible values include:
219+
- NEW
220+
- OLD
221+
213222
```java
214223
for (ClassificationField documentTypeElem : result.getDocument().getInference().getPrediction().getDocumentType())
215224
{

docs/international_id_v2.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,14 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
167167
## Document Type
168168
**documentType**: The type of personal identification document.
169169

170+
#### Possible values include:
171+
- IDENTIFICATION_CARD
172+
- PASSPORT
173+
- DRIVER_LICENSE
174+
- VISA
175+
- RESIDENCY_CARD
176+
- VOTER_REGISTRATION
177+
170178
```java
171179
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
172180
```

docs/invoices_v4.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,10 @@ System.out.println(result.getDocument().getInference().getPrediction().getDate()
339339
## Document Type
340340
**documentType**: One of: 'INVOICE', 'CREDIT NOTE'.
341341

342+
#### Possible values include:
343+
- INVOICE
344+
- CREDIT NOTE
345+
342346
```java
343347
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
344348
```

docs/resume_v1.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,13 @@ A `ResumeV1Language` implements the following attributes:
195195

196196
* **language** (`String`): The language's ISO 639 code.
197197
* **level** (`String`): The candidate's level for the language.
198+
199+
#### Possible values include:
200+
- Fluent
201+
- Proficient
202+
- Intermediate
203+
- Beginner
204+
198205
Fields which are specific to this product; they are not used in any other product.
199206

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

205212
* **contractType** (`String`): The type of contract for the professional experience.
213+
214+
#### Possible values include:
215+
- Full-Time
216+
- Part-Time
217+
- Internship
218+
- Freelance
219+
206220
* **department** (`String`): The specific department or division within the company.
207221
* **employer** (`String`): The name of the company or organization.
208222
* **endMonth** (`String`): The month when the professional experience ended.
@@ -250,6 +264,11 @@ System.out.println(result.getDocument().getInference().getPrediction().getDocume
250264
## Document Type
251265
**documentType**: The type of the document sent.
252266

267+
#### Possible values include:
268+
- RESUME
269+
- MOTIVATION_LETTER
270+
- RECOMMENDATION_LETTER
271+
253272
```java
254273
System.out.println(result.getDocument().getInference().getPrediction().getDocumentType().value);
255274
```

0 commit comments

Comments
 (0)