🎨 update all products to new standard

Author: ianardee

docs/extras/guide/financial_document_v1.md

@@ -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
@@ -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
@@ -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
@@ -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
@@ -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      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
 ```
 

docs/extras/guide/invoices_v4.md

@@ -32,12 +32,12 @@ print(result.document)
 ########
 Document
 ########
-:Mindee ID: a9062dd1-0d34-42ab-9505-0481a8545106
+:Mindee ID: 5c0371d0-1433-43a4-b8fb-a3b11aaf9a0e
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.5
+:Product: mindee/invoices v4.6
 :Rotation applied: Yes
 
 Prediction
@@ -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
@@ -59,10 +59,14 @@ 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
@@ -86,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
@@ -99,10 +103,14 @@ 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

docs/extras/guide/material_certificate_v1.md

@@ -8,23 +8,23 @@ The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/prod
 
 # Quick-Start
 ```py
-from mindee import Client, PredictResponse, product
+from mindee import Client, product, AsyncPredictResponse
+from time import sleep
 
 # 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 parse it.
-# The endpoint name must be specified since it cannot be determined from the class.
-result: PredictResponse = mindee_client.parse(product.MaterialCertificateV1, input_doc)
+# Load a file from disk and enqueue it.
+result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
+    product.MaterialCertificateV1,
+    input_doc,
+)
 
-# Print a summary of the API result
+# Print a brief summary of the parsed data
 print(result.document)
-
-# Print the document-level summary
-# print(result.document.inference.prediction)
 ```
 # Field Types
 ## Standard Fields

mindee/product/barcode_reader/barcode_reader_v1.py

@@ -7,7 +7,7 @@
 
 
 class BarcodeReaderV1(Inference):
-    """Inference prediction for Barcode Reader, API version 1."""
+    """Barcode Reader API version 1 inference prediction."""
 
     prediction: BarcodeReaderV1Document
     """Document-level prediction."""

mindee/product/barcode_reader/barcode_reader_v1_document.py

@@ -5,7 +5,7 @@
 
 
 class BarcodeReaderV1Document(Prediction):
-    """Document data for Barcode Reader, API version 1."""
+    """Barcode Reader API version 1.0 document data."""
 
     codes_1d: List[StringField]
     """List of decoded 1D barcodes."""

mindee/product/cropper/cropper_v1.py

@@ -1,12 +1,16 @@
 from typing import List
 
 from mindee.parsing.common import Inference, Page, StringDict
-from mindee.product.cropper.cropper_v1_document import CropperV1Document
-from mindee.product.cropper.cropper_v1_page import CropperV1Page
+from mindee.product.cropper.cropper_v1_document import (
+    CropperV1Document,
+)
+from mindee.product.cropper.cropper_v1_page import (
+    CropperV1Page,
+)
 
 
 class CropperV1(Inference):
-    """Inference prediction for Cropper, API version 1."""
+    """Cropper API version 1 inference prediction."""
 
     prediction: CropperV1Document
     """Document-level prediction."""

mindee/product/cropper/cropper_v1_document.py

@@ -2,7 +2,7 @@
 
 
 class CropperV1Document(Prediction):
-    """Document data for Cropper, API version 1."""
+    """Cropper API version 1.1 document data."""
 
     def __str__(self) -> str:
         return ""

mindee/product/cropper/cropper_v1_page.py

@@ -2,11 +2,13 @@
 
 from mindee.parsing.common import StringDict, clean_out_string
 from mindee.parsing.standard import PositionField
-from mindee.product.cropper.cropper_v1_document import CropperV1Document
+from mindee.product.cropper.cropper_v1_document import (
+    CropperV1Document,
+)
 
 
 class CropperV1Page(CropperV1Document):
-    """Page data for Cropper, API version 1."""
+    """Cropper API version 1.1 page data."""
 
     cropping: List[PositionField]
     """List of documents found in the image."""

mindee/product/eu/driver_license/driver_license_v1.py

@@ -4,11 +4,13 @@
 from mindee.product.eu.driver_license.driver_license_v1_document import (
     DriverLicenseV1Document,
 )
-from mindee.product.eu.driver_license.driver_license_v1_page import DriverLicenseV1Page
+from mindee.product.eu.driver_license.driver_license_v1_page import (
+    DriverLicenseV1Page,
+)
 
 
 class DriverLicenseV1(Inference):
-    """Inference prediction for Driver License, API version 1."""
+    """Driver License API version 1 inference prediction."""
 
     prediction: DriverLicenseV1Document
     """Document-level prediction."""

mindee/product/eu/driver_license/driver_license_v1_document.py

@@ -5,7 +5,7 @@
 
 
 class DriverLicenseV1Document(Prediction):
-    """Document data for Driver License, API version 1."""
+    """Driver License API version 1.0 document data."""
 
     address: StringField
     """EU driver license holders address"""

mindee/product/eu/driver_license/driver_license_v1_page.py

@@ -8,7 +8,7 @@
 
 
 class DriverLicenseV1Page(DriverLicenseV1Document):
-    """Page data for Driver License, API version 1."""
+    """Driver License API version 1.0 page data."""
 
     photo: PositionField
     """Has a photo of the EU driver license holder"""

mindee/product/eu/license_plate/license_plate_v1.py

@@ -7,7 +7,7 @@
 
 
 class LicensePlateV1(Inference):
-    """Inference prediction for License Plate, API version 1."""
+    """License Plate API version 1 inference prediction."""
 
     prediction: LicensePlateV1Document
     """Document-level prediction."""

mindee/product/eu/license_plate/license_plate_v1_document.py

@@ -5,7 +5,7 @@
 
 
 class LicensePlateV1Document(Prediction):
-    """Document data for License Plate, API version 1."""
+    """License Plate API version 1.1 document data."""
 
     license_plates: List[StringField]
     """List of all license plates found in the image."""

mindee/product/financial_document/financial_document_v1.py

@@ -7,7 +7,7 @@
 
 
 class FinancialDocumentV1(Inference):
-    """Inference prediction for Financial Document, API version 1."""
+    """Financial Document API version 1 inference prediction."""
 
     prediction: FinancialDocumentV1Document
     """Document-level prediction."""

mindee/product/financial_document/financial_document_v1_document.py

@@ -17,7 +17,7 @@
 
 
 class FinancialDocumentV1Document(Prediction):
-    """Document data for Financial Document, API version 1."""
+    """Financial Document API version 1.6 document data."""
 
     billing_address: StringField
     """The customer's address used for billing."""

mindee/product/fr/bank_account_details/bank_account_details_v1.py

@@ -7,7 +7,7 @@
 
 
 class BankAccountDetailsV1(Inference):
-    """Inference prediction for Bank Account Details, API version 1."""
+    """Bank Account Details API version 1 inference prediction."""
 
     prediction: BankAccountDetailsV1Document
     """Document-level prediction."""

mindee/product/fr/bank_account_details/bank_account_details_v1_document.py

@@ -5,7 +5,7 @@
 
 
 class BankAccountDetailsV1Document(Prediction):
-    """Document data for Bank Account Details, API version 1."""
+    """Bank Account Details API version 1.0 document data."""
 
     account_holder_name: StringField
     """The name of the account holder as seen on the document."""

mindee/product/fr/bank_account_details/bank_account_details_v2.py

@@ -7,7 +7,7 @@
 
 
 class BankAccountDetailsV2(Inference):
-    """Inference prediction for Bank Account Details, API version 2."""
+    """Bank Account Details API version 2 inference prediction."""
 
     prediction: BankAccountDetailsV2Document
     """Document-level prediction."""

mindee/product/fr/bank_account_details/bank_account_details_v2_document.py

@@ -8,7 +8,7 @@
 
 
 class BankAccountDetailsV2Document(Prediction):
-    """Document data for Bank Account Details, API version 2."""
+    """Bank Account Details API version 2.0 document data."""
 
     account_holders_names: StringField
     """Full extraction of the account holders names."""

mindee/product/fr/carte_grise/carte_grise_v1.py

@@ -1,11 +1,13 @@
 from typing import List
 
 from mindee.parsing.common import Inference, Page, StringDict
-from mindee.product.fr.carte_grise.carte_grise_v1_document import CarteGriseV1Document
+from mindee.product.fr.carte_grise.carte_grise_v1_document import (
+    CarteGriseV1Document,
+)
 
 
 class CarteGriseV1(Inference):
-    """Inference prediction for Carte Grise, API version 1."""
+    """Carte Grise API version 1 inference prediction."""
 
     prediction: CarteGriseV1Document
     """Document-level prediction."""

mindee/product/fr/carte_grise/carte_grise_v1_document.py

@@ -5,7 +5,7 @@
 
 
 class CarteGriseV1Document(Prediction):
-    """Document data for Carte Grise, API version 1."""
+    """Carte Grise API version 1.1 document data."""
 
     a: StringField
     """The vehicle's license plate number."""

mindee/product/fr/carte_vitale/carte_vitale_v1.py

@@ -7,7 +7,7 @@
 
 
 class CarteVitaleV1(Inference):
-    """Inference prediction for Carte Vitale, API version 1."""
+    """Carte Vitale API version 1 inference prediction."""
 
     prediction: CarteVitaleV1Document
     """Document-level prediction."""

mindee/product/fr/carte_vitale/carte_vitale_v1_document.py

@@ -5,7 +5,7 @@
 
 
 class CarteVitaleV1Document(Prediction):
-    """Document data for Carte Vitale, API version 1."""
+    """Carte Vitale API version 1.1 document data."""
 
     given_names: List[StringField]
     """The given name(s) of the card holder."""