Skip to content

Commit

Permalink
deploy: 47a8a84
Browse files Browse the repository at this point in the history
  • Loading branch information
@ianardee
ianardee committed Apr 30, 2024
1 parent f6325a0 commit 13f748f
Show file tree
Hide file tree
Showing 29 changed files with 248 additions and 82 deletions.
36 changes: 32 additions & 4 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,12 @@ <h2 id="B">B</h2>
</li>
<li><a href="parsing/custom.html#mindee.parsing.custom.line_items.CustomLine.bbox">bbox (CustomLine attribute)</a>
</li>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.billing_address">billing_address (InvoiceV4Document attribute)</a>
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.billing_address">billing_address (FinancialDocumentV1Document attribute)</a>

<ul>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.billing_address">(InvoiceV4Document attribute)</a>
</li>
</ul></li>
<li><a href="product/fr/id_card_v1.html#mindee.product.fr.id_card.id_card_v1_document.IdCardV1Document.birth_date">birth_date (IdCardV1Document attribute)</a>

<ul>
Expand Down Expand Up @@ -580,6 +584,12 @@ <h2 id="C">C</h2>

<ul>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.customer_company_registrations">(InvoiceV4Document attribute)</a>
</li>
</ul></li>
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.customer_id">customer_id (FinancialDocumentV1Document attribute)</a>

<ul>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.customer_id">(InvoiceV4Document attribute)</a>
</li>
</ul></li>
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.customer_name">customer_name (FinancialDocumentV1Document attribute)</a>
Expand Down Expand Up @@ -2287,8 +2297,12 @@ <h2 id="S">S</h2>
<li><a href="product/international_id_v2.html#mindee.product.international_id.international_id_v2_document.InternationalIdV2Document.sex">(InternationalIdV2Document attribute)</a>
</li>
</ul></li>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.shipping_address">shipping_address (InvoiceV4Document attribute)</a>
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.shipping_address">shipping_address (FinancialDocumentV1Document attribute)</a>

<ul>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.shipping_address">(InvoiceV4Document attribute)</a>
</li>
</ul></li>
<li><a href="product/eu/driver_license_v1.html#mindee.product.eu.driver_license.driver_license_v1_page.DriverLicenseV1Page.signature">signature (DriverLicenseV1Page attribute)</a>, <a href="product/us/driver_license_v1.html#mindee.product.us.driver_license.driver_license_v1_page.DriverLicenseV1Page.signature">[1]</a>
</li>
<li><a href="product/us/w9_v1.html#mindee.product.us.w9.w9_v1_page.W9V1Page.signature_date_position">signature_date_position (W9V1Page attribute)</a>
Expand Down Expand Up @@ -2341,8 +2355,6 @@ <h2 id="S">S</h2>
</li>
<li><a href="parsing/common.html#mindee.parsing.common.job.Job.status">status (Job attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="parsing/common.html#mindee.parsing.common.api_request.ApiRequest.status_code">status_code (ApiRequest attribute)</a>

<ul>
Expand All @@ -2353,6 +2365,8 @@ <h2 id="S">S</h2>
<li><a href="misc/error.html#mindee.error.MindeeHTTPServerError.status_code">(MindeeHTTPServerError attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="parsing/custom.html#mindee.parsing.common.string_dict.StringDict">StringDict (in module mindee.parsing.common.string_dict)</a>
</li>
<li><a href="parsing/standard.html#mindee.parsing.standard.text.StringField">StringField (class in mindee.parsing.standard.text)</a>
Expand Down Expand Up @@ -2381,6 +2395,12 @@ <h2 id="S">S</h2>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.supplier_company_registrations">(InvoiceV4Document attribute)</a>
</li>
<li><a href="product/receipt_v5.html#mindee.product.receipt.receipt_v5_document.ReceiptV5Document.supplier_company_registrations">(ReceiptV5Document attribute)</a>
</li>
</ul></li>
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.supplier_email">supplier_email (FinancialDocumentV1Document attribute)</a>

<ul>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.supplier_email">(InvoiceV4Document attribute)</a>
</li>
</ul></li>
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.supplier_name">supplier_name (FinancialDocumentV1Document attribute)</a>
Expand All @@ -2400,7 +2420,15 @@ <h2 id="S">S</h2>
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.supplier_phone_number">supplier_phone_number (FinancialDocumentV1Document attribute)</a>

<ul>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.supplier_phone_number">(InvoiceV4Document attribute)</a>
</li>
<li><a href="product/receipt_v5.html#mindee.product.receipt.receipt_v5_document.ReceiptV5Document.supplier_phone_number">(ReceiptV5Document attribute)</a>
</li>
</ul></li>
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.supplier_website">supplier_website (FinancialDocumentV1Document attribute)</a>

<ul>
<li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.supplier_website">(InvoiceV4Document attribute)</a>
</li>
</ul></li>
<li><a href="product/fr/carte_vitale_v1.html#mindee.product.fr.carte_vitale.carte_vitale_v1_document.CarteVitaleV1Document.surname">surname (CarteVitaleV1Document attribute)</a>
Expand Down
2 changes: 1 addition & 1 deletion guide/expense_receipts_v5.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ print(result.document.inference.prediction.document_type.value)

```py
for line_items_elem in result.document.inference.prediction.line_items:
print(line_items_elem.value)
print(line_items_elem)
```

## Expense Locale
Expand Down
63 changes: 54 additions & 9 deletions guide/financial_document_v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,20 @@ print(result.document)
########
Document
########
:Mindee ID: a6b54e2d-a7fa-4e08-8de6-6cd296f50f3d
:Mindee ID: 503895c6-eced-42e2-a6fc-0292b7ccf680
:Filename: default_sample.jpg
Inference
#########
:Product: mindee/financial_document v1.2
:Product: mindee/financial_document v1.6
:Rotation applied: Yes
Prediction
==========
:Locale: en; en; USD;
:Locale: en; USD;
:Invoice Number: INT-001
:Reference Numbers: 2412/2019
:Purchase Date: 2019-02-11
:Purchase Date: 2019-11-02
:Due Date: 2019-02-26
:Total Net: 195.00
:Total Amount: 204.75
Expand All @@ -61,8 +61,13 @@ Prediction
:Supplier Address: 4490 Oak Drive Albany, NY 12210
:Supplier Phone Number:
:Customer Name: JESSIE M HORNE
:Supplier Website:
:Supplier Email:
:Customer Company Registrations:
:Customer Address: 2019 Redbud Drive New York, NY 10011
:Customer ID: 1234567890
:Shipping Address: 2019 Redbud Drive New York, NY 10011
:Billing Address: 4312 Wood Road New York, NY 10031
:Document Type: INVOICE
:Purchase Subcategory:
:Purchase Category: miscellaneous
Expand All @@ -77,18 +82,18 @@ Prediction
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
| New set of pedal arms | | 2.00 | | | 50.00 | 25.00 |
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
| Labon 3hrs | | 3.00 | | | 45.00 | 15.00 |
| Labor 3hrs | | 3.00 | | | 45.00 | 15.00 |
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
Page Predictions
================
Page 0
------
:Locale: en; en; USD;
:Locale: en; USD;
:Invoice Number: INT-001
:Reference Numbers: 2412/2019
:Purchase Date: 2019-02-11
:Purchase Date: 2019-11-02
:Due Date: 2019-02-26
:Total Net: 195.00
:Total Amount: 204.75
Expand All @@ -104,8 +109,13 @@ Page 0
:Supplier Address: 4490 Oak Drive Albany, NY 12210
:Supplier Phone Number:
:Customer Name: JESSIE M HORNE
:Supplier Website:
:Supplier Email:
:Customer Company Registrations:
:Customer Address: 2019 Redbud Drive New York, NY 10011
:Customer ID: 1234567890
:Shipping Address: 2019 Redbud Drive New York, NY 10011
:Billing Address: 4312 Wood Road New York, NY 10031
:Document Type: INVOICE
:Purchase Subcategory:
:Purchase Category: miscellaneous
Expand All @@ -120,7 +130,7 @@ Page 0
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
| New set of pedal arms | | 2.00 | | | 50.00 | 25.00 |
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
| Labon 3hrs | | 3.00 | | | 45.00 | 15.00 |
| Labor 3hrs | | 3.00 | | | 45.00 | 15.00 |
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
```

Expand Down Expand Up @@ -215,6 +225,13 @@ A `FinancialDocumentV1LineItem` implements the following attributes:
# Attributes
The following fields are extracted for Financial Document V1:

## Billing Address
**billing_address** ([StringField](#stringfield)): The customer's address used for billing.

```py
print(result.document.inference.prediction.billing_address.value)
```

## Purchase Category
**category** ([ClassificationField](#classificationfield)): The purchase category among predefined classes.

Expand All @@ -237,6 +254,13 @@ for customer_company_registrations_elem in result.document.inference.prediction.
print(customer_company_registrations_elem.value)
```

## Customer ID
**customer_id** ([StringField](#stringfield)): The customer account number or identifier from the supplier.

```py
print(result.document.inference.prediction.customer_id.value)
```

## Customer Name
**customer_name** ([StringField](#stringfield)): The name of the customer.

Expand Down Expand Up @@ -277,7 +301,7 @@ print(result.document.inference.prediction.invoice_number.value)

```py
for line_items_elem in result.document.inference.prediction.line_items:
print(line_items_elem.value)
print(line_items_elem)
```

## Locale
Expand All @@ -295,6 +319,13 @@ for reference_numbers_elem in result.document.inference.prediction.reference_num
print(reference_numbers_elem.value)
```

## Shipping Address
**shipping_address** ([StringField](#stringfield)): The customer's address used for shipping.

```py
print(result.document.inference.prediction.shipping_address.value)
```

## Purchase Subcategory
**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory among predefined classes for transport and food.

Expand All @@ -317,6 +348,13 @@ for supplier_company_registrations_elem in result.document.inference.prediction.
print(supplier_company_registrations_elem.value)
```

## Supplier Email
**supplier_email** ([StringField](#stringfield)): The email of the supplier or merchant.

```py
print(result.document.inference.prediction.supplier_email.value)
```

## Supplier Name
**supplier_name** ([StringField](#stringfield)): The name of the supplier or merchant.

Expand All @@ -339,6 +377,13 @@ for supplier_payment_details_elem in result.document.inference.prediction.suppli
print(result.document.inference.prediction.supplier_phone_number.value)
```

## Supplier Website
**supplier_website** ([StringField](#stringfield)): The website URL of the supplier or merchant.

```py
print(result.document.inference.prediction.supplier_website.value)
```

## Taxes
**taxes** (List[[TaxField](#taxes)]): List of tax lines information.

Expand Down
54 changes: 47 additions & 7 deletions guide/invoices_v4.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ print(result.document)
########
Document
########
:Mindee ID: 80f2328c-58a5-486a-9599-eb2d738680f0
:Mindee ID: 5c0371d0-1433-43a4-b8fb-a3b11aaf9a0e
:Filename: default_sample.jpg
Inference
#########
:Product: mindee/invoices v4.4
:Product: mindee/invoices v4.6
:Rotation applied: Yes
Prediction
Expand All @@ -46,7 +46,7 @@ Prediction
:Invoice Number: 14
:Reference Numbers: AD29094
:Purchase Date: 2018-09-25
:Due Date: 2018-09-25
:Due Date:
:Total Net:
:Total Amount: 2608.20
:Total Tax: 193.20
Expand All @@ -59,10 +59,16 @@ Prediction
:Supplier Payment Details:
:Supplier Name: TURNPIKE DESIGNS
:Supplier Company Registrations:
:Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
:Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
:Supplier Phone Number: 4165551212
:Supplier Website:
:Supplier Email: i_doi@example.com
:Customer Name: JIRO DOI
:Customer Company Registrations:
:Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
:Customer ID:
:Shipping Address:
:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
:Document Type: INVOICE
:Line Items:
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
Expand All @@ -84,7 +90,7 @@ Page 0
:Invoice Number: 14
:Reference Numbers: AD29094
:Purchase Date: 2018-09-25
:Due Date: 2018-09-25
:Due Date:
:Total Net:
:Total Amount: 2608.20
:Total Tax: 193.20
Expand All @@ -97,10 +103,16 @@ Page 0
:Supplier Payment Details:
:Supplier Name: TURNPIKE DESIGNS
:Supplier Company Registrations:
:Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
:Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
:Supplier Phone Number: 4165551212
:Supplier Website:
:Supplier Email: i_doi@example.com
:Customer Name: JIRO DOI
:Customer Company Registrations:
:Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
:Customer ID:
:Shipping Address:
:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
:Document Type: INVOICE
:Line Items:
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
Expand Down Expand Up @@ -227,6 +239,13 @@ for customer_company_registrations_elem in result.document.inference.prediction.
print(customer_company_registrations_elem.value)
```

## Customer ID
**customer_id** ([StringField](#stringfield)): The customer account number or identifier from the supplier.

```py
print(result.document.inference.prediction.customer_id.value)
```

## Customer Name
**customer_name** ([StringField](#stringfield)): The name of the customer or client.

Expand Down Expand Up @@ -267,7 +286,7 @@ print(result.document.inference.prediction.invoice_number.value)

```py
for line_items_elem in result.document.inference.prediction.line_items:
print(line_items_elem.value)
print(line_items_elem)
```

## Locale
Expand Down Expand Up @@ -307,6 +326,13 @@ for supplier_company_registrations_elem in result.document.inference.prediction.
print(supplier_company_registrations_elem.value)
```

## Supplier Email
**supplier_email** ([StringField](#stringfield)): The email of the supplier or merchant.

```py
print(result.document.inference.prediction.supplier_email.value)
```

## Supplier Name
**supplier_name** ([StringField](#stringfield)): The name of the supplier or merchant.

Expand All @@ -322,6 +348,20 @@ for supplier_payment_details_elem in result.document.inference.prediction.suppli
print(supplier_payment_details_elem.value)
```

## Supplier Phone Number
**supplier_phone_number** ([StringField](#stringfield)): The phone number of the supplier or merchant.

```py
print(result.document.inference.prediction.supplier_phone_number.value)
```

## Supplier Website
**supplier_website** ([StringField](#stringfield)): The website URL of the supplier or merchant.

```py
print(result.document.inference.prediction.supplier_website.value)
```

## Taxes
**taxes** (List[[TaxField](#taxes)]): List of tax line details.

Expand Down
Loading

0 comments on commit 13f748f

Please sign in to comment.