deploy: f57ba8d

Author: ianardee

code_samples/workflow_ots_rag.txt

@@ -0,0 +1,25 @@
+#
+# Install the Python client library by running:
+# pip install mindee
+#
+
+from mindee import Client, product, AsyncPredictResponse
+
+# Init a new client
+mindee_client = Client(api_key="my-api-key")
+
+# Load a file from disk
+input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
+
+# Load a file from disk and enqueue it.
+result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
+    product.FinancialDocumentV1,
+    input_doc,
+    # Set the workflow ID
+    workflow_id="workflow-id",
+    # Enable RAG on the workflow
+    rag=True,
+)
+
+# Print a brief summary of the parsed data
+print(result.document)

genindex.html

@@ -588,6 +588,8 @@ <h2 id="C">C</h2>
 
       <ul>
         <li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.category">(FinancialDocumentV1Document attribute)</a>
+</li>
+        <li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.category">(InvoiceV4Document attribute)</a>
 </li>
         <li><a href="product/fr/payslip_v2.html#mindee.product.fr.payslip.payslip_v2_employment.PayslipV2Employment.category">(PayslipV2Employment attribute)</a>
 </li>
@@ -2806,6 +2808,8 @@ <h2 id="P">P</h2>
       <li><a href="product/driver_license_v1.html#mindee.product.driver_license.driver_license_v1_document.DriverLicenseV1Document.place_of_birth">place_of_birth (DriverLicenseV1Document attribute)</a>
 </li>
       <li><a href="product/bill_of_lading_v1.html#mindee.product.bill_of_lading.bill_of_lading_v1_document.BillOfLadingV1Document.place_of_delivery">place_of_delivery (BillOfLadingV1Document attribute)</a>
+</li>
+      <li><a href="product/us/healthcare_card_v1.html#mindee.product.us.healthcare_card.healthcare_card_v1_document.HealthcareCardV1Document.plan_name">plan_name (HealthcareCardV1Document attribute)</a>
 </li>
       <li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.po_number">po_number (FinancialDocumentV1Document attribute)</a>
 
@@ -3474,6 +3478,8 @@ <h2 id="S">S</h2>
       <li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.subcategory">subcategory (FinancialDocumentV1Document attribute)</a>
 
       <ul>
+        <li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4_document.InvoiceV4Document.subcategory">(InvoiceV4Document attribute)</a>
+</li>
         <li><a href="product/receipt_v5.html#mindee.product.receipt.receipt_v5_document.ReceiptV5Document.subcategory">(ReceiptV5Document attribute)</a>
 </li>
       </ul></li>

guide/expense_receipts_v5.md

@@ -237,6 +237,9 @@ The following fields are extracted for Receipt V5:
  - 'gasoline'
  - 'telecom'
  - 'miscellaneous'
+ - 'software'
+ - 'shopping'
+ - 'energy'
 
 ```py
 print(result.document.inference.prediction.category.value)
@@ -291,6 +294,15 @@ print(result.document.inference.prediction.receipt_number.value)
  - 'train'
  - 'restaurant'
  - 'shopping'
+ - 'other'
+ - 'groceries'
+ - 'cultural'
+ - 'electronics'
+ - 'office_supplies'
+ - 'micromobility'
+ - 'car_rental'
+ - 'public'
+ - 'delivery'
  - None
 
 ```py

guide/financial_document_v1.md

@@ -70,12 +70,12 @@ print(result.document)
 ########
 Document
 ########
-:Mindee ID: f52333ab-811e-4647-993e-ad79e072afa3
+:Mindee ID: 6dd26385-719b-4527-bf6f-87d9da619de5
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/financial_document v1.12
+:Product: mindee/financial_document v1.14
 :Rotation applied: Yes
 
 Prediction
@@ -203,6 +203,21 @@ A typical `BaseField` object will have the following attributes:
 Aside from the previous attributes, all basic fields have access to a custom `__str__` method that can be used to print their value as a string.
 
 
+### AddressField
+Aside from the basic `BaseField` attributes, the address field `AddressField` also implements the following:
+
+* **street_number** (`str`): String representation of the street number. Can be `None`.
+* **street_name** (`str`): Name of the street. Can be `None`.
+* **po_box** (`str`): String representation of the PO Box number. Can be `None`.
+* **address_complement** (`str`): Address complement. Can be `None`.
+* **city** (`str`): City name. Can be `None`.
+* **postal_code** (`str`): String representation of the postal code. Can be `None`.
+* **state** (`str`): State name. Can be `None`.
+* **country** (`str`): Country name. Can be `None`.
+
+Note: The `value` field of an AddressField should be a concatenation of the rest of the values.
+
+
 ### AmountField
 The amount field `AmountField` only has one constraint: its **value** is an `Optional[float]`.
 
@@ -276,14 +291,14 @@ A `FinancialDocumentV1LineItem` implements the following attributes:
 The following fields are extracted for Financial Document V1:
 
 ## Billing Address
-**billing_address** ([StringField](#stringfield)): The customer's address used for billing.
+**billing_address** ([AddressField](#addressfield)): The customer's address used for billing.
 
 ```py
 print(result.document.inference.prediction.billing_address.value)
 ```
 
 ## Purchase Category
-**category** ([ClassificationField](#classificationfield)): The purchase category, only for receipts.
+**category** ([ClassificationField](#classificationfield)): The purchase category.
 
 #### Possible values include:
  - 'toll'
@@ -294,13 +309,16 @@ print(result.document.inference.prediction.billing_address.value)
  - 'gasoline'
  - 'telecom'
  - 'miscellaneous'
+ - 'software'
+ - 'shopping'
+ - 'energy'
 
 ```py
 print(result.document.inference.prediction.category.value)
 ```
 
 ## Customer Address
-**customer_address** ([StringField](#stringfield)): The address of the customer.
+**customer_address** ([AddressField](#addressfield)): The address of the customer.
 
 ```py
 print(result.document.inference.prediction.customer_address.value)
@@ -432,29 +450,38 @@ for reference_numbers_elem in result.document.inference.prediction.reference_num
 ```
 
 ## Shipping Address
-**shipping_address** ([StringField](#stringfield)): The customer's address used for shipping.
+**shipping_address** ([AddressField](#addressfield)): The customer's address used for shipping.
 
 ```py
 print(result.document.inference.prediction.shipping_address.value)
 ```
 
 ## Purchase Subcategory
-**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory for transport and food, only for receipts.
+**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory for transport, food and shooping.
 
 #### Possible values include:
  - 'plane'
  - 'taxi'
  - 'train'
  - 'restaurant'
  - 'shopping'
+ - 'other'
+ - 'groceries'
+ - 'cultural'
+ - 'electronics'
+ - 'office_supplies'
+ - 'micromobility'
+ - 'car_rental'
+ - 'public'
+ - 'delivery'
  - None
 
 ```py
 print(result.document.inference.prediction.subcategory.value)
 ```
 
 ## Supplier Address
-**supplier_address** ([StringField](#stringfield)): The address of the supplier or merchant.
+**supplier_address** ([AddressField](#addressfield)): The address of the supplier or merchant.
 
 ```py
 print(result.document.inference.prediction.supplier_address.value)

guide/ind_passport_v1.md

@@ -45,7 +45,7 @@ Document
 
 Inference
 #########
-:Product: mindee/ind_passport v1.0
+:Product: mindee/ind_passport v1.2
 :Rotation applied: Yes
 
 Prediction
@@ -68,10 +68,10 @@ Prediction
 :Name of Mother:
 :Old Passport Date of Issue:
 :Old Passport Number:
+:Old Passport Place of Issue:
 :Address Line 1:
 :Address Line 2:
 :Address Line 3:
-:Old Passport Place of Issue:
 :File Number:
 ```
 

guide/invoices_v4.md

@@ -70,12 +70,12 @@ print(result.document)
 ########
 Document
 ########
-:Mindee ID: 3e524d26-f7dc-4852-9bbf-833a127a9570
+:Mindee ID: 744748d5-9051-461c-b70c-bbf81f5ff943
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.10
+:Product: mindee/invoices v4.11
 :Rotation applied: Yes
 
 Prediction
@@ -111,6 +111,8 @@ Prediction
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
 :Document Type Extended: INVOICE
+:Purchase Subcategory:
+:Purchase Category: miscellaneous
 :Line Items:
   +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
   | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
@@ -158,6 +160,8 @@ Page 0
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
 :Document Type Extended: INVOICE
+:Purchase Subcategory:
+:Purchase Category: miscellaneous
 :Line Items:
   +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
   | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
@@ -191,6 +195,21 @@ A typical `BaseField` object will have the following attributes:
 Aside from the previous attributes, all basic fields have access to a custom `__str__` method that can be used to print their value as a string.
 
 
+### AddressField
+Aside from the basic `BaseField` attributes, the address field `AddressField` also implements the following:
+
+* **street_number** (`str`): String representation of the street number. Can be `None`.
+* **street_name** (`str`): Name of the street. Can be `None`.
+* **po_box** (`str`): String representation of the PO Box number. Can be `None`.
+* **address_complement** (`str`): Address complement. Can be `None`.
+* **city** (`str`): City name. Can be `None`.
+* **postal_code** (`str`): String representation of the postal code. Can be `None`.
+* **state** (`str`): State name. Can be `None`.
+* **country** (`str`): Country name. Can be `None`.
+
+Note: The `value` field of an AddressField should be a concatenation of the rest of the values.
+
+
 ### AmountField
 The amount field `AmountField` only has one constraint: its **value** is an `Optional[float]`.
 
@@ -264,14 +283,33 @@ A `InvoiceV4LineItem` implements the following attributes:
 The following fields are extracted for Invoice V4:
 
 ## Billing Address
-**billing_address** ([StringField](#stringfield)): The customer billing address.
+**billing_address** ([AddressField](#addressfield)): The customer billing address.
 
 ```py
 print(result.document.inference.prediction.billing_address.value)
 ```
 
+## Purchase Category
+**category** ([ClassificationField](#classificationfield)): The purchase category.
+
+#### Possible values include:
+ - 'toll'
+ - 'food'
+ - 'parking'
+ - 'transport'
+ - 'accommodation'
+ - 'telecom'
+ - 'miscellaneous'
+ - 'software'
+ - 'shopping'
+ - 'energy'
+
+```py
+print(result.document.inference.prediction.category.value)
+```
+
 ## Customer Address
-**customer_address** ([StringField](#stringfield)): The address of the customer.
+**customer_address** ([AddressField](#addressfield)): The address of the customer.
 
 ```py
 print(result.document.inference.prediction.customer_address.value)
@@ -387,14 +425,38 @@ for reference_numbers_elem in result.document.inference.prediction.reference_num
 ```
 
 ## Shipping Address
-**shipping_address** ([StringField](#stringfield)): Customer's delivery address.
+**shipping_address** ([AddressField](#addressfield)): Customer's delivery address.
 
 ```py
 print(result.document.inference.prediction.shipping_address.value)
 ```
 
+## Purchase Subcategory
+**subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory for transport, food and shopping.
+
+#### Possible values include:
+ - 'plane'
+ - 'taxi'
+ - 'train'
+ - 'restaurant'
+ - 'shopping'
+ - 'other'
+ - 'groceries'
+ - 'cultural'
+ - 'electronics'
+ - 'office_supplies'
+ - 'micromobility'
+ - 'car_rental'
+ - 'public'
+ - 'delivery'
+ - None
+
+```py
+print(result.document.inference.prediction.subcategory.value)
+```
+
 ## Supplier Address
-**supplier_address** ([StringField](#stringfield)): The address of the supplier or merchant.
+**supplier_address** ([AddressField](#addressfield)): The address of the supplier or merchant.
 
 ```py
 print(result.document.inference.prediction.supplier_address.value)