Skip to content

Commit 17c4207

Browse files
📝 add classification detail to guide documentation (#257)
1 parent 7eb2775 commit 17c4207

File tree

6 files changed

+84
-0
lines changed

6 files changed

+84
-0
lines changed

docs/extras/guide/expense_receipts_v5.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,16 @@ The following fields are extracted for Receipt V5:
193193
## Purchase Category
194194
**category** ([ClassificationField](#classificationfield)): The purchase category among predefined classes.
195195

196+
#### Possible values include:
197+
- toll
198+
- food
199+
- parking
200+
- transport
201+
- accommodation
202+
- gasoline
203+
- telecom
204+
- miscellaneous
205+
196206
```py
197207
print(result.document.inference.prediction.category.value)
198208
```
@@ -207,6 +217,10 @@ print(result.document.inference.prediction.date.value)
207217
## Document Type
208218
**document_type** ([ClassificationField](#classificationfield)): One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
209219

220+
#### Possible values include:
221+
- expense_receipt
222+
- credit_card_receipt
223+
210224
```py
211225
print(result.document.inference.prediction.document_type.value)
212226
```
@@ -236,6 +250,13 @@ print(result.document.inference.prediction.receipt_number.value)
236250
## Purchase Subcategory
237251
**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory among predefined classes for transport and food.
238252

253+
#### Possible values include:
254+
- plane
255+
- taxi
256+
- train
257+
- restaurant
258+
- shopping
259+
239260
```py
240261
print(result.document.inference.prediction.subcategory.value)
241262
```

docs/extras/guide/financial_document_v1.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,16 @@ print(result.document.inference.prediction.billing_address.value)
266266
## Purchase Category
267267
**category** ([ClassificationField](#classificationfield)): The purchase category among predefined classes.
268268

269+
#### Possible values include:
270+
- toll
271+
- food
272+
- parking
273+
- transport
274+
- accommodation
275+
- gasoline
276+
- telecom
277+
- miscellaneous
278+
269279
```py
270280
print(result.document.inference.prediction.category.value)
271281
```
@@ -316,6 +326,12 @@ print(result.document.inference.prediction.document_number.value)
316326
## Document Type
317327
**document_type** ([ClassificationField](#classificationfield)): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
318328

329+
#### Possible values include:
330+
- INVOICE
331+
- CREDIT NOTE
332+
- CREDIT CARD RECEIPT
333+
- EXPENSE RECEIPT
334+
319335
```py
320336
print(result.document.inference.prediction.document_type.value)
321337
```
@@ -374,6 +390,13 @@ print(result.document.inference.prediction.shipping_address.value)
374390
## Purchase Subcategory
375391
**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory among predefined classes for transport and food.
376392

393+
#### Possible values include:
394+
- plane
395+
- taxi
396+
- train
397+
- restaurant
398+
- shopping
399+
377400
```py
378401
print(result.document.inference.prediction.subcategory.value)
379402
```

docs/extras/guide/idcard_fr_v2.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,11 @@ print(result.document.inference.prediction.document_number.value)
173173
## Document Sides
174174
[📄](#page-level-fields "This field is only present on individual pages.")**document_side** ([ClassificationField](#classificationfield)): The sides of the document which are visible.
175175

176+
#### Possible values include:
177+
- RECTO
178+
- VERSO
179+
- RECTO & VERSO
180+
176181
```py
177182
for document_side_elem in result.document.document_side:
178183
print(document_side_elem.value)
@@ -181,6 +186,10 @@ for document_side_elem in result.document.document_side:
181186
## Document Type
182187
[📄](#page-level-fields "This field is only present on individual pages.")**document_type** ([ClassificationField](#classificationfield)): The document type or format.
183188

189+
#### Possible values include:
190+
- NEW
191+
- OLD
192+
184193
```py
185194
for document_type_elem in result.document.document_type:
186195
print(document_type_elem.value)

docs/extras/guide/international_id_v2.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,14 @@ print(result.document.inference.prediction.document_number.value)
140140
## Document Type
141141
**document_type** ([ClassificationField](#classificationfield)): The type of personal identification document.
142142

143+
#### Possible values include:
144+
- IDENTIFICATION_CARD
145+
- PASSPORT
146+
- DRIVER_LICENSE
147+
- VISA
148+
- RESIDENCY_CARD
149+
- VOTER_REGISTRATION
150+
143151
```py
144152
print(result.document.inference.prediction.document_type.value)
145153
```

docs/extras/guide/invoices_v4.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,10 @@ print(result.document.inference.prediction.date.value)
290290
## Document Type
291291
**document_type** ([ClassificationField](#classificationfield)): One of: 'INVOICE', 'CREDIT NOTE'.
292292

293+
#### Possible values include:
294+
- INVOICE
295+
- CREDIT NOTE
296+
293297
```py
294298
print(result.document.inference.prediction.document_type.value)
295299
```

docs/extras/guide/resume_v1.md

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

169169
* **language** (`str`): The language's ISO 639 code.
170170
* **level** (`str`): The candidate's level for the language.
171+
172+
#### Possible values include:
173+
- Fluent
174+
- Proficient
175+
- Intermediate
176+
- Beginner
177+
171178
Fields which are specific to this product; they are not used in any other product.
172179

173180
### Professional Experiences Field
@@ -176,6 +183,13 @@ The list of the candidate's professional experiences.
176183
A `ResumeV1ProfessionalExperience` implements the following attributes:
177184

178185
* **contract_type** (`str`): The type of contract for the professional experience.
186+
187+
#### Possible values include:
188+
- Full-Time
189+
- Part-Time
190+
- Internship
191+
- Freelance
192+
179193
* **department** (`str`): The specific department or division within the company.
180194
* **employer** (`str`): The name of the company or organization.
181195
* **end_month** (`str`): The month when the professional experience ended.
@@ -221,6 +235,11 @@ print(result.document.inference.prediction.document_language.value)
221235
## Document Type
222236
**document_type** ([ClassificationField](#classificationfield)): The type of the document sent.
223237

238+
#### Possible values include:
239+
- RESUME
240+
- MOTIVATION_LETTER
241+
- RECOMMENDATION_LETTER
242+
224243
```py
225244
print(result.document.inference.prediction.document_type.value)
226245
```

0 commit comments

Comments
 (0)