✨ add International ID (beta)

Author: ianardee

docs/extras/code_samples/international_id_v1_async.txt

@@ -0,0 +1,17 @@
+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 enqueue it.
+result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
+    product.InternationalIdV1,
+    input_doc,
+)
+
+# Print a brief summary of the parsed data
+print(result.document)

docs/extras/guide/invoice_splitter_v1.md

@@ -85,7 +85,7 @@ The following fields are extracted for Invoice Splitter V1:
 
 ```py
 for invoice_page_groups_elem in page.prediction.invoice_page_groups):
-    print(invoice_page_groups_elem.polygon)
+    print(invoice_page_groups_elem)
 ```
 
 # Questions?

docs/product/international_id_v1.rst

@@ -0,0 +1,15 @@
+International ID V1
+-------------------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/international_id_v1.txt
+    :language: Python
+
+.. autoclass:: mindee.product.international_id.international_id_v1.InternationalIdV1
+    :members:
+    :inherited-members:
+    
+.. autoclass:: mindee.product.international_id.international_id_v1_document.InternationalIdV1Document
+    :members:
+    :inherited-members:

mindee/product/__init__.py

@@ -1,46 +1,29 @@
 from mindee.product import eu, fr, us
-from mindee.product.barcode_reader.barcode_reader_v1 import BarcodeReaderV1
-from mindee.product.barcode_reader.barcode_reader_v1_document import (
-    BarcodeReaderV1Document,
-)
-from mindee.product.cropper.cropper_v1 import CropperV1
-from mindee.product.cropper.cropper_v1_document import CropperV1Document
-from mindee.product.custom.custom_v1 import CustomV1
-from mindee.product.custom.custom_v1_document import CustomV1Document
-from mindee.product.custom.custom_v1_page import CustomV1Page
-from mindee.product.financial_document.financial_document_v1 import FinancialDocumentV1
-from mindee.product.financial_document.financial_document_v1_document import (
+from mindee.product.barcode_reader import BarcodeReaderV1, BarcodeReaderV1Document
+from mindee.product.cropper import CropperV1, CropperV1Document
+from mindee.product.custom import CustomV1, CustomV1Document, CustomV1Page
+from mindee.product.financial_document import (
+    FinancialDocumentV1,
     FinancialDocumentV1Document,
-)
-from mindee.product.financial_document.financial_document_v1_line_item import (
     FinancialDocumentV1LineItem,
 )
-from mindee.product.invoice.invoice_v4 import InvoiceV4
-from mindee.product.invoice.invoice_v4_document import InvoiceV4Document
-from mindee.product.invoice_splitter.invoice_splitter_v1 import InvoiceSplitterV1
-from mindee.product.invoice_splitter.invoice_splitter_v1_document import (
-    InvoiceSplitterV1Document,
-)
-from mindee.product.material_certificate.material_certificate_v1 import (
+from mindee.product.international_id import InternationalIdV1, InternationalIdV1Document
+from mindee.product.invoice import InvoiceV4, InvoiceV4Document, InvoiceV4LineItem
+from mindee.product.invoice_splitter import InvoiceSplitterV1, InvoiceSplitterV1Document
+from mindee.product.material_certificate import (
     MaterialCertificateV1,
-)
-from mindee.product.material_certificate.material_certificate_v1_document import (
     MaterialCertificateV1Document,
 )
-from mindee.product.multi_receipts_detector.multi_receipts_detector_v1 import (
+from mindee.product.multi_receipts_detector import (
     MultiReceiptsDetectorV1,
-)
-from mindee.product.multi_receipts_detector.multi_receipts_detector_v1_document import (
     MultiReceiptsDetectorV1Document,
 )
-from mindee.product.passport.passport_v1 import PassportV1
-from mindee.product.passport.passport_v1_document import PassportV1Document
-from mindee.product.proof_of_address.proof_of_address_v1 import ProofOfAddressV1
-from mindee.product.proof_of_address.proof_of_address_v1_document import (
-    ProofOfAddressV1Document,
+from mindee.product.passport import PassportV1, PassportV1Document
+from mindee.product.proof_of_address import ProofOfAddressV1, ProofOfAddressV1Document
+from mindee.product.receipt import (
+    ReceiptV4,
+    ReceiptV4Document,
+    ReceiptV5,
+    ReceiptV5Document,
+    ReceiptV5LineItem,
 )
-from mindee.product.receipt.receipt_v4 import ReceiptV4
-from mindee.product.receipt.receipt_v4_document import ReceiptV4Document
-from mindee.product.receipt.receipt_v5 import ReceiptV5
-from mindee.product.receipt.receipt_v5_document import ReceiptV5Document
-from mindee.product.receipt.receipt_v5_line_item import ReceiptV5LineItem

mindee/product/international_id/__init__.py

@@ -0,0 +1,4 @@
+from mindee.product.international_id.international_id_v1 import InternationalIdV1
+from mindee.product.international_id.international_id_v1_document import (
+    InternationalIdV1Document,
+)

mindee/product/international_id/international_id_v1.py

@@ -0,0 +1,32 @@
+from typing import List
+
+from mindee.parsing.common import Inference, Page, StringDict
+from mindee.product.international_id.international_id_v1_document import (
+    InternationalIdV1Document,
+)
+
+
+class InternationalIdV1(Inference):
+    """Inference prediction for International ID, API version 1."""
+
+    prediction: InternationalIdV1Document
+    """Document-level prediction."""
+    pages: List[Page[InternationalIdV1Document]]
+    """Page-level prediction(s)."""
+    endpoint_name = "international_id"
+    """Name of the endpoint."""
+    endpoint_version = "1"
+    """Version of the endpoint."""
+
+    def __init__(self, raw_prediction: StringDict):
+        """
+        International ID v1 inference.
+
+        :param raw_prediction: Raw prediction from the HTTP response.
+        """
+        super().__init__(raw_prediction)
+
+        self.prediction = InternationalIdV1Document(raw_prediction["prediction"])
+        self.pages = []
+        for page in raw_prediction["pages"]:
+            self.pages.append(Page(InternationalIdV1Document, page))

mindee/product/international_id/international_id_v1_document.py

@@ -0,0 +1,136 @@
+from typing import List, Optional
+
+from mindee.parsing.common import Prediction, StringDict, clean_out_string
+from mindee.parsing.standard import ClassificationField, StringField
+
+
+class InternationalIdV1Document(Prediction):
+    """Document data for International ID, API version 1."""
+
+    address: StringField
+    """The physical location of the document holder's residence."""
+    birth_date: StringField
+    """The date of birth of the document holder."""
+    birth_place: StringField
+    """The location where the document holder was born."""
+    country_of_issue: StringField
+    """The country that issued the identification document."""
+    document_number: StringField
+    """The unique identifier assigned to the identification document."""
+    document_type: ClassificationField
+    """The type of identification document being used."""
+    expiry_date: StringField
+    """The date when the document will no longer be valid for use."""
+    given_names: List[StringField]
+    """The first names or given names of the document holder."""
+    issue_date: StringField
+    """The date when the document was issued."""
+    mrz1: StringField
+    """First line of information in a standardized format for easy machine reading and processing."""
+    mrz2: StringField
+    """Second line of information in a standardized format for easy machine reading and processing."""
+    mrz3: StringField
+    """Third line of information in a standardized format for easy machine reading and processing."""
+    nationality: StringField
+    """Indicates the country of citizenship or nationality of the document holder."""
+    sex: StringField
+    """The document holder's biological sex, such as male or female."""
+    surnames: List[StringField]
+    """The surnames of the document holder."""
+
+    def __init__(
+        self,
+        raw_prediction: StringDict,
+        page_id: Optional[int] = None,
+    ):
+        """
+        International ID document.
+
+        :param raw_prediction: Raw prediction from HTTP response
+        :param page_id: Page number for multi pages pdf input
+        """
+        super().__init__(raw_prediction, page_id)
+        self.address = StringField(
+            raw_prediction["address"],
+            page_id=page_id,
+        )
+        self.birth_date = StringField(
+            raw_prediction["birth_date"],
+            page_id=page_id,
+        )
+        self.birth_place = StringField(
+            raw_prediction["birth_place"],
+            page_id=page_id,
+        )
+        self.country_of_issue = StringField(
+            raw_prediction["country_of_issue"],
+            page_id=page_id,
+        )
+        self.document_number = StringField(
+            raw_prediction["document_number"],
+            page_id=page_id,
+        )
+        self.document_type = ClassificationField(
+            raw_prediction["document_type"],
+            page_id=page_id,
+        )
+        self.expiry_date = StringField(
+            raw_prediction["expiry_date"],
+            page_id=page_id,
+        )
+        self.given_names = [
+            StringField(prediction, page_id=page_id)
+            for prediction in raw_prediction["given_names"]
+        ]
+        self.issue_date = StringField(
+            raw_prediction["issue_date"],
+            page_id=page_id,
+        )
+        self.mrz1 = StringField(
+            raw_prediction["mrz1"],
+            page_id=page_id,
+        )
+        self.mrz2 = StringField(
+            raw_prediction["mrz2"],
+            page_id=page_id,
+        )
+        self.mrz3 = StringField(
+            raw_prediction["mrz3"],
+            page_id=page_id,
+        )
+        self.nationality = StringField(
+            raw_prediction["nationality"],
+            page_id=page_id,
+        )
+        self.sex = StringField(
+            raw_prediction["sex"],
+            page_id=page_id,
+        )
+        self.surnames = [
+            StringField(prediction, page_id=page_id)
+            for prediction in raw_prediction["surnames"]
+        ]
+
+    def __str__(self) -> str:
+        given_names = f"\n { ' ' * 13 }".join(
+            [str(item) for item in self.given_names],
+        )
+        surnames = f"\n { ' ' * 10 }".join(
+            [str(item) for item in self.surnames],
+        )
+        out_str: str = f":Document Type: {self.document_type}\n"
+        out_str += f":Document Number: {self.document_number}\n"
+        out_str += f":Country of Issue: {self.country_of_issue}\n"
+        out_str += f":Surnames: {surnames}\n"
+        out_str += f":Given Names: {given_names}\n"
+        out_str += f":Gender: {self.sex}\n"
+        out_str += f":Birth date: {self.birth_date}\n"
+        out_str += f":Birth Place: {self.birth_place}\n"
+        out_str += f":Nationality: {self.nationality}\n"
+        out_str += f":Issue Date: {self.issue_date}\n"
+        out_str += f":Expiry Date: {self.expiry_date}\n"
+        out_str += f":Address: {self.address}\n"
+        out_str += f":Machine Readable Zone Line 1: {self.mrz1}\n"
+        out_str += f":Machine Readable Zone Line 2: {self.mrz2}\n"
+        out_str += f":Machine Readable Zone Line 3: {self.mrz3}\n"
+        return clean_out_string(out_str)

mindee/product/invoice/__init__.py

@@ -0,0 +1,3 @@
+from mindee.product.invoice.invoice_v4 import InvoiceV4
+from mindee.product.invoice.invoice_v4_document import InvoiceV4Document
+from mindee.product.invoice.invoice_v4_line_item import InvoiceV4LineItem

mindee/product/invoice_splitter/__init__.py

@@ -1 +1,7 @@
 from mindee.product.invoice_splitter.invoice_splitter_v1 import InvoiceSplitterV1
+from mindee.product.invoice_splitter.invoice_splitter_v1_document import (
+    InvoiceSplitterV1Document,
+)
+from mindee.product.invoice_splitter.invoice_splitter_v1_page_group import (
+    InvoiceSplitterV1PageGroup,
+)