Skip to content

Commit 619b3fc

Browse files
sebastianMindeesebastianMindee
committed
fix doc samples
1 parent 05c55d8 commit 619b3fc

File tree

6 files changed

+273
-9
lines changed

6 files changed

+273
-9
lines changed

‎docs/extras/guide/bill_of_lading_v1.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ parentDoc: 609808f773b0b90051d839de
66
---
77
The Python OCR SDK supports the [Bill of Lading API](https://platform.mindee.com/mindee/bill_of_lading).
88

9-
The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/bill_of_lading/default_sample.jpg) can be used for testing purposes.
9+
Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/bill_of_lading/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
1010
![Bill of Lading sample](https://github.com/mindee/client-lib-test-data/blob/main/products/bill_of_lading/default_sample.jpg?raw=true)
1111

1212
# Quick-Start
@@ -29,6 +29,55 @@ result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
2929
print(result.document)
3030

3131
```
32+
33+
**Output (RST):**
34+
```rst
35+
########
36+
Document
37+
########
38+
:Mindee ID: 3b5250a1-b52c-4e0b-bc3e-2f0146b04e29
39+
:Filename: default_sample.jpg
40+
41+
Inference
42+
#########
43+
:Product: mindee/bill_of_lading v1.1
44+
:Rotation applied: No
45+
46+
Prediction
47+
==========
48+
:Bill of Lading Number: XYZ123456
49+
:Shipper:
50+
:Address: 123 OCEAN DRIVE, SHANGHAI, CHINA
51+
:Email:
52+
:Name: GLOBAL FREIGHT SOLUTIONS INC.
53+
:Phone: 86-21-12345678
54+
:Consignee:
55+
:Address: 789 TRADE STREET, SINGAPORE 567890, SINGAPORE
56+
:Email:
57+
:Name: PACIFIC TRADING CO.
58+
:Phone: 65-65432100
59+
:Notify Party:
60+
:Address: 789 TRADE STREET, SINGAPORE 567890, SINGAPORE
61+
:Email:
62+
:Name: PACIFIC TRADING CO.
63+
:Phone: 65-65432100
64+
:Carrier:
65+
:Name: GLOBAL SHIPPING CO.,LTD.
66+
:Professional Number:
67+
:SCAC:
68+
:Items:
69+
+--------------------------------------+--------------+-------------+------------------+----------+-------------+
70+
| Description | Gross Weight | Measurement | Measurement Unit | Quantity | Weight Unit |
71+
+======================================+==============+=============+==================+==========+=============+
72+
| ELECTRONIC COMPONENTS\nP/N: 12345... | 500.00 | 1.50 | cbm | 1.00 | kgs |
73+
+--------------------------------------+--------------+-------------+------------------+----------+-------------+
74+
:Port of Loading: SHANGHAI, CHINA
75+
:Port of Discharge: LOS ANGELES, USA
76+
:Place of Delivery: LOS ANGELES, USA
77+
:Date of issue: 2022-09-30
78+
:Departure Date:
79+
```
80+
3281
# Field Types
3382
## Standard Fields
3483
These fields are generic and used in several products.

‎docs/extras/guide/energy_bill_fra_v1.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ parentDoc: 609808f773b0b90051d839de
66
---
77
The Python OCR SDK supports the [Energy Bill API](https://platform.mindee.com/mindee/energy_bill_fra).
88

9-
The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg) can be used for testing purposes.
9+
Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
1010
![Energy Bill sample](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg?raw=true)
1111

1212
# Quick-Start
@@ -29,6 +29,66 @@ result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
2929
print(result.document)
3030

3131
```
32+
33+
**Output (RST):**
34+
```rst
35+
########
36+
Document
37+
########
38+
:Mindee ID: 17f0ccef-e3fe-4a28-838d-d704489d6ce7
39+
:Filename: default_sample.pdf
40+
41+
Inference
42+
#########
43+
:Product: mindee/energy_bill_fra v1.0
44+
:Rotation applied: No
45+
46+
Prediction
47+
==========
48+
:Invoice Number: 10123590373
49+
:Contract ID: 1234567890
50+
:Delivery Point: 98765432109876
51+
:Invoice Date: 2021-01-29
52+
:Due Date: 2021-02-15
53+
:Total Before Taxes: 1241.03
54+
:Total Taxes: 238.82
55+
:Total Amount: 1479.85
56+
:Energy Supplier:
57+
:Address: TSA 12345, 12345 DEMOCITY CEDEX, 75001 PARIS
58+
:Name: EDF
59+
:Energy Consumer:
60+
:Address: 12 AVENUE DES RÊVES, RDC A 123 COUR FAUSSE A, 75000 PARIS
61+
:Name: John Doe
62+
:Subscription:
63+
+--------------------------------------+------------+------------+----------+-----------+------------+
64+
| Description | End Date | Start Date | Tax Rate | Total | Unit Price |
65+
+======================================+============+============+==========+===========+============+
66+
| Abonnement électricité | 2021-02-28 | 2021-01-01 | 5.50 | 59.00 | 29.50 |
67+
+--------------------------------------+------------+------------+----------+-----------+------------+
68+
:Energy Usage:
69+
+--------------------------------------+------------+------------+----------+-----------+------------+
70+
| Description | End Date | Start Date | Tax Rate | Total | Unit Price |
71+
+======================================+============+============+==========+===========+============+
72+
| Consommation (HT) | 2021-01-27 | 2020-11-28 | 20.00 | 898.43 | 10.47 |
73+
+--------------------------------------+------------+------------+----------+-----------+------------+
74+
:Taxes and Contributions:
75+
+--------------------------------------+------------+------------+----------+-----------+------------+
76+
| Description | End Date | Start Date | Tax Rate | Total | Unit Price |
77+
+======================================+============+============+==========+===========+============+
78+
| Contribution au Service Public de... | 2021-01-27 | 2020-11-28 | 20.00 | 193.07 | 2.25 |
79+
+--------------------------------------+------------+------------+----------+-----------+------------+
80+
| Départementale sur la Conso Final... | 2020-12-31 | 2020-11-28 | 20.00 | 13.98 | 0.3315 |
81+
+--------------------------------------+------------+------------+----------+-----------+------------+
82+
| Communale sur la Conso Finale Ele... | 2021-01-27 | 2021-01-01 | 20.00 | 28.56 | 0.6545 |
83+
+--------------------------------------+------------+------------+----------+-----------+------------+
84+
| Contribution Tarifaire d'Achemine... | 2020-12-31 | 2020-11-28 | 20.00 | 27.96 | 0.663 |
85+
+--------------------------------------+------------+------------+----------+-----------+------------+
86+
:Meter Details:
87+
:Meter Number: 620
88+
:Meter Type: electricity
89+
:Unit of Measure: kWh
90+
```
91+
3292
# Field Types
3393
## Standard Fields
3494
These fields are generic and used in several products.

‎docs/extras/guide/expense_receipts_v5.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Prediction
4848
==========
4949
:Expense Locale: en-GB; en; GB; GBP;
5050
:Purchase Category: food
51-
:Purchase Subcategory: restaurant
51+
:Purchase Subcategory:
5252
:Document Type: EXPENSE RECEIPT
5353
:Purchase Date: 2016-02-26
5454
:Purchase Time: 15:20
@@ -62,7 +62,7 @@ Prediction
6262
+===============+========+==========+===============+
6363
| 8.50 | VAT | 20.00 | 1.70 |
6464
+---------------+--------+----------+---------------+
65-
:Supplier Name: clachan
65+
:Supplier Name: Clachan
6666
:Supplier Company Registrations: Type: VAT NUMBER, Value: 232153895
6767
Type: VAT NUMBER, Value: 232153895
6868
:Supplier Address: 34 Kingley Street W1B 50H
@@ -82,7 +82,7 @@ Page 0
8282
------
8383
:Expense Locale: en-GB; en; GB; GBP;
8484
:Purchase Category: food
85-
:Purchase Subcategory: restaurant
85+
:Purchase Subcategory:
8686
:Document Type: EXPENSE RECEIPT
8787
:Purchase Date: 2016-02-26
8888
:Purchase Time: 15:20
@@ -96,7 +96,7 @@ Page 0
9696
+===============+========+==========+===============+
9797
| 8.50 | VAT | 20.00 | 1.70 |
9898
+---------------+--------+----------+---------------+
99-
:Supplier Name: clachan
99+
:Supplier Name: Clachan
100100
:Supplier Company Registrations: Type: VAT NUMBER, Value: 232153895
101101
Type: VAT NUMBER, Value: 232153895
102102
:Supplier Address: 34 Kingley Street W1B 50H

‎docs/extras/guide/nutrition_facts_v1.md

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ parentDoc: 609808f773b0b90051d839de
66
---
77
The Python OCR SDK supports the [Nutrition Facts Label API](https://platform.mindee.com/mindee/nutrition_facts).
88

9-
The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/default_sample.jpg) can be used for testing purposes.
9+
Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
1010
![Nutrition Facts Label sample](https://github.com/mindee/client-lib-test-data/blob/main/products/nutrition_facts/default_sample.jpg?raw=true)
1111

1212
# Quick-Start
@@ -29,6 +29,85 @@ result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
2929
print(result.document)
3030

3131
```
32+
33+
**Output (RST):**
34+
```rst
35+
########
36+
Document
37+
########
38+
:Mindee ID: 38a12fe0-5d69-4ca4-9b30-12f1b659311c
39+
:Filename: default_sample.jpg
40+
41+
Inference
42+
#########
43+
:Product: mindee/nutrition_facts v1.0
44+
:Rotation applied: No
45+
46+
Prediction
47+
==========
48+
:Serving per Box: 2.00
49+
:Serving Size:
50+
:Amount: 228.00
51+
:Unit: g
52+
:Calories:
53+
:Daily Value:
54+
:Per 100g:
55+
:Per Serving: 250.00
56+
:Total Fat:
57+
:Daily Value:
58+
:Per 100g:
59+
:Per Serving: 12.00
60+
:Saturated Fat:
61+
:Daily Value: 15.00
62+
:Per 100g:
63+
:Per Serving: 3.00
64+
:Trans Fat:
65+
:Daily Value:
66+
:Per 100g:
67+
:Per Serving: 3.00
68+
:Cholesterol:
69+
:Daily Value: 10.00
70+
:Per 100g:
71+
:Per Serving: 30.00
72+
:Total Carbohydrate:
73+
:Daily Value: 10.00
74+
:Per 100g:
75+
:Per Serving: 31.00
76+
:Dietary Fiber:
77+
:Daily Value: 0.00
78+
:Per 100g:
79+
:Per Serving: 0.00
80+
:Total Sugars:
81+
:Daily Value:
82+
:Per 100g:
83+
:Per Serving: 5.00
84+
:Added Sugars:
85+
:Daily Value:
86+
:Per 100g:
87+
:Per Serving:
88+
:Protein:
89+
:Daily Value:
90+
:Per 100g:
91+
:Per Serving: 5.00
92+
:sodium:
93+
:Daily Value: 20.00
94+
:Per 100g:
95+
:Per Serving: 470.00
96+
:Unit: mg
97+
:nutrients:
98+
+-------------+----------------------+----------+-------------+------+
99+
| Daily Value | Name | Per 100g | Per Serving | Unit |
100+
+=============+======================+==========+=============+======+
101+
| 12.00 | Vitamin A | | 4.00 | mcg |
102+
+-------------+----------------------+----------+-------------+------+
103+
| 12.00 | Vitamin C | | 2.00 | mg |
104+
+-------------+----------------------+----------+-------------+------+
105+
| 12.00 | Calcium | | 45.60 | mg |
106+
+-------------+----------------------+----------+-------------+------+
107+
| 12.00 | Iron | | 0.90 | mg |
108+
+-------------+----------------------+----------+-------------+------+
109+
```
110+
32111
# Field Types
33112
## Standard Fields
34113
These fields are generic and used in several products.

‎docs/extras/guide/payslip_fra_v2.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ parentDoc: 609808f773b0b90051d839de
66
---
77
The Python OCR SDK supports the [Payslip API](https://platform.mindee.com/mindee/payslip_fra).
88

9-
The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/default_sample.jpg) can be used for testing purposes.
9+
Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
1010
![Payslip sample](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/default_sample.jpg?raw=true)
1111

1212
# Quick-Start
@@ -29,6 +29,82 @@ result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
2929
print(result.document)
3030

3131
```
32+
33+
**Output (RST):**
34+
```rst
35+
########
36+
Document
37+
########
38+
:Mindee ID: 972edba5-25aa-49d0-8431-e2557ddd788e
39+
:Filename: default_sample.jpg
40+
41+
Inference
42+
#########
43+
:Product: mindee/payslip_fra v2.0
44+
:Rotation applied: No
45+
46+
Prediction
47+
==========
48+
:Employee:
49+
:Address: 52 RUE DES FLEURS 33500 LIBOURNE FRANCE
50+
:Date of Birth:
51+
:First Name: Jean Luc
52+
:Last Name: Picard
53+
:Phone Number:
54+
:Registration Number:
55+
:Social Security Number: 123456789012345
56+
:Employer:
57+
:Address: 1 RUE DU TONNOT 25210 DOUBS
58+
:Company ID: 12345678901234
59+
:Company Site:
60+
:NAF Code: 1234A
61+
:Name: DEMO COMPANY
62+
:Phone Number:
63+
:URSSAF Number:
64+
:Bank Account Details:
65+
:Bank Name:
66+
:IBAN:
67+
:SWIFT:
68+
:Employment:
69+
:Category: Cadre
70+
:Coefficient: 600.00
71+
:Collective Agreement: Construction -- Promotion
72+
:Job Title: Directeur Régional du Développement
73+
:Position Level:
74+
:Start Date: 2022-05-01
75+
:Salary Details:
76+
+--------------+-----------+--------------------------------------+-----------+
77+
| Amount | Base | Description | Rate |
78+
+==============+===========+======================================+===========+
79+
| 6666.67 | | Salaire de base | |
80+
+--------------+-----------+--------------------------------------+-----------+
81+
| 9.30 | | Part patronale Mutuelle NR | |
82+
+--------------+-----------+--------------------------------------+-----------+
83+
| 508.30 | | Avantages en nature voiture | |
84+
+--------------+-----------+--------------------------------------+-----------+
85+
:Pay Detail:
86+
:Gross Salary: 7184.27
87+
:Gross Salary YTD: 18074.81
88+
:Income Tax Rate: 17.60
89+
:Income Tax Withheld: 1030.99
90+
:Net Paid: 3868.32
91+
:Net Paid Before Tax: 4899.31
92+
:Net Taxable: 5857.90
93+
:Net Taxable YTD: 14752.73
94+
:Total Cost Employer: 10486.94
95+
:Total Taxes and Deductions: 1650.36
96+
:PTO:
97+
:Accrued This Period: 6.17
98+
:Balance End of Period: 6.17
99+
:Used This Period:
100+
:Pay Period:
101+
:End Date: 2023-03-31
102+
:Month: 03
103+
:Payment Date: 2023-03-29
104+
:Start Date: 2023-03-01
105+
:Year: 2023
106+
```
107+
32108
# Field Types
33109
## Standard Fields
34110
These fields are generic and used in several products.

‎docs/extras/guide/us_mail_v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ print(result.document)
3535
:Sender Name: zed
3636
:Sender Address:
3737
:City: Dallas
38-
:Complete Address: 54321 Elm Street, Dallas, Texas ...
38+
:Complete Address: 54321 Elm Street, Dallas, Texas 54321
3939
:Postal Code: 54321
4040
:State: TX
4141
:Street: 54321 Elm Street

0 commit comments

Comments
 (0)