♻️ add async invoice call & update doc (#251)

mindee · Jul 25, 2024 · 7ca1672 · 7ca1672
1 parent eb75930
commit 7ca1672
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/docs/extras/code_samples/invoices_v4_async.txt b/docs/extras/code_samples/invoices_v4_async.txt
@@ -0,0 +1,16 @@
+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.InvoiceV4,
+    input_doc,
+)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/extras/guide/financial_document_v1.md b/docs/extras/guide/financial_document_v1.md
@@ -25,7 +25,6 @@ print(result.document)
 
 # Print the document-level summary
 # print(result.document.inference.prediction)
-
 ```
 
 You can also call this product asynchronously:
@@ -47,7 +46,6 @@ result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
 
 # Print a brief summary of the parsed data
 print(result.document)
-
 ```
 
 **Output (RST):**

diff --git a/docs/extras/guide/invoices_v4.md b/docs/extras/guide/invoices_v4.md
@@ -25,7 +25,27 @@ print(result.document)
 
 # Print the document-level summary
 # print(result.document.inference.prediction)
+```
+
+You can also call this product asynchronously:
+
+```py
+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.InvoiceV4,
+    input_doc,
+)
 
+# Print a brief summary of the parsed data
+print(result.document)
 ```
 
 **Output (RST):**