Skip to content

Commit 2aa2688

Browse files
📝 update doc
1 parent 379b92d commit 2aa2688

File tree

2 files changed

+44
-20
lines changed

2 files changed

+44
-20
lines changed

docs/extras/guide/financial_document_v1.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,29 @@ print(result.document)
2525

2626
# Print the document-level summary
2727
# print(result.document.inference.prediction)
28+
29+
```
30+
31+
You can also call this product asynchronously:
32+
33+
```py
34+
from mindee import Client, product, AsyncPredictResponse
35+
36+
# Init a new client
37+
mindee_client = Client(api_key="my-api-key")
38+
39+
# Load a file from disk
40+
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
41+
42+
# Load a file from disk and enqueue it.
43+
result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
44+
product.FinancialDocumentV1,
45+
input_doc,
46+
)
47+
48+
# Print a brief summary of the parsed data
49+
print(result.document)
50+
2851
```
2952

3053
**Output (RST):**

docs/extras/guide/invoices_v4.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,20 @@ print(result.document)
2525

2626
# Print the document-level summary
2727
# print(result.document.inference.prediction)
28+
2829
```
2930

3031
**Output (RST):**
3132
```rst
3233
########
3334
Document
3435
########
35-
:Mindee ID: 128a314f-1adb-42eb-a9e3-402055a8b8ce
36+
:Mindee ID: 372d9d08-59d8-4e1c-9622-06648c1c238b
3637
:Filename: default_sample.jpg
3738
3839
Inference
3940
#########
40-
:Product: mindee/invoices v4.6
41+
:Product: mindee/invoices v4.7
4142
:Rotation applied: Yes
4243
4344
Prediction
@@ -71,15 +72,15 @@ Prediction
7172
:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
7273
:Document Type: INVOICE
7374
:Line Items:
74-
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
75-
| Description | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit Price |
76-
+======================================+==============+==========+============+==============+==============+============+
77-
| Platinum web hosting package Down... | | 1.00 | | | 65.00 | 65.00 |
78-
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
79-
| 2 page website design Includes ba... | | 3.00 | | | 2100.00 | 2100.00 |
80-
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
81-
| Mobile designs Includes responsiv... | | 1.00 | | | 250.00 | 250.00 |
82-
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
75+
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
76+
| Description | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
77+
+======================================+==============+==========+============+==============+==============+=================+============+
78+
| Platinum web hosting package Down... | | 1.00 | | | 65.00 | | 65.00 |
79+
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
80+
| 2 page website design Includes ba... | | 3.00 | | | 2100.00 | | 2100.00 |
81+
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
82+
| Mobile designs Includes responsiv... | | 1.00 | | | 250.00 | 1 | 250.00 |
83+
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
8384
8485
Page Predictions
8586
================
@@ -115,15 +116,15 @@ Page 0
115116
:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
116117
:Document Type: INVOICE
117118
:Line Items:
118-
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
119-
| Description | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit Price |
120-
+======================================+==============+==========+============+==============+==============+============+
121-
| Platinum web hosting package Down... | | 1.00 | | | 65.00 | 65.00 |
122-
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
123-
| 2 page website design Includes ba... | | 3.00 | | | 2100.00 | 2100.00 |
124-
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
125-
| Mobile designs Includes responsiv... | | 1.00 | | | 250.00 | 250.00 |
126-
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
119+
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
120+
| Description | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
121+
+======================================+==============+==========+============+==============+==============+=================+============+
122+
| Platinum web hosting package Down... | | 1.00 | | | 65.00 | | 65.00 |
123+
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
124+
| 2 page website design Includes ba... | | 3.00 | | | 2100.00 | | 2100.00 |
125+
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
126+
| Mobile designs Includes responsiv... | | 1.00 | | | 250.00 | 1 | 250.00 |
127+
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
127128
```
128129

129130
# Field Types

0 commit comments

Comments
 (0)