✨ add support for material certificate v1

Author: ianardee

docs/extras/code_samples/material_certificate_v1.txt

@@ -0,0 +1,13 @@
+from mindee import Client, documents
+
+# Init a new client
+mindee_client = Client(api_key="my-api-key")
+
+# Load a file from disk
+input_doc = mindee_client.doc_from_path("/path/to/the/file.ext")
+
+# Parse the Material Certificate by passing the appropriate type
+result = input_doc.parse(documents.TypeMaterialCertificateV1)
+
+# Print a brief summary of the parsed data
+print(result.document)

docs/predictions/standard/documents/material_certificate_v1.rst

@@ -0,0 +1,10 @@
+Material Certificate V1
+-----------------------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/material_certificate_v1.txt
+    :language: Python
+
+.. autoclass:: mindee.documents.MaterialCertificateV1
+    :members:

docs/predictions/standard/international.rst

@@ -12,3 +12,4 @@ International
 .. include:: ./documents/invoice_splitter_v1.rst
 .. include:: ./documents/proof_of_address_v1.rst
 .. include:: ./documents/cropper_v1.rst
+.. include:: ./documents/material_certificate.rst

mindee/client.py

@@ -455,6 +455,11 @@ def _init_default_endpoints(self) -> None:
                 url_name="invoice_splitter",
                 version="1",
             ),
+            ConfigSpec(
+                doc_class=documents.MaterialCertificateV1,
+                url_name="material_certificate",
+                version="1",
+            ),
         ]
 
         for config in configs:

mindee/documents/__init__.py

@@ -9,6 +9,10 @@
 )
 from mindee.documents.invoice import InvoiceV3, InvoiceV4, TypeInvoiceV3, TypeInvoiceV4
 from mindee.documents.invoice_splitter import InvoiceSplitterV1, TypeInvoiceSplitterV1
+from mindee.documents.material_certificate import (
+    MaterialCertificateV1,
+    TypeMaterialCertificateV1,
+)
 from mindee.documents.passport import PassportV1, TypePassportV1
 from mindee.documents.proof_of_address import ProofOfAddressV1, TypeProofOfAddressV1
 from mindee.documents.receipt import (

mindee/documents/material_certificate/__init__.py

@@ -0,0 +1 @@
+from .material_certificate_v1 import MaterialCertificateV1, TypeMaterialCertificateV1

mindee/documents/material_certificate/material_certificate_v1.py

@@ -0,0 +1,73 @@
+from typing import Optional, TypeVar
+
+from mindee.documents.base import Document, TypeApiPrediction, clean_out_string
+from mindee.fields.text import TextField
+
+
+class MaterialCertificateV1(Document):
+    """Material Certificate v1 prediction results."""
+
+    certificate_type: TextField
+    """Material Type field is the type of material used in the product, such as metal, plastic, or wood."""
+    heat_number: TextField
+    """Heat Number is a unique identifier assigned to a batch of material produced in a manufacturing process."""
+    norm: TextField
+    """Material Grade field is the designation of the material's chemical and physical properties."""
+
+    def __init__(
+        self,
+        api_prediction=None,
+        input_source=None,
+        page_n: Optional[int] = None,
+    ):
+        """
+        Material Certificate v1 prediction results.
+
+        :param api_prediction: Raw prediction from HTTP response
+        :param input_source: Input object
+        :param page_n: Page number for multi pages pdf input
+        """
+        super().__init__(
+            input_source=input_source,
+            document_type="material_certificate",
+            api_prediction=api_prediction,
+            page_n=page_n,
+        )
+        self._build_from_api_prediction(api_prediction["prediction"], page_n=page_n)
+
+    def _build_from_api_prediction(
+        self, api_prediction: TypeApiPrediction, page_n: Optional[int] = None
+    ) -> None:
+        """
+        Build the object from the prediction API JSON.
+
+        :param api_prediction: Raw prediction from HTTP response
+        :param page_n: Page number
+        """
+        self.certificate_type = TextField(
+            api_prediction["certificate_type"],
+            page_id=page_n,
+        )
+        self.heat_number = TextField(
+            api_prediction["heat_number"],
+            page_id=page_n,
+        )
+        self.norm = TextField(
+            api_prediction["norm"],
+            page_id=page_n,
+        )
+
+    def __str__(self) -> str:
+        return clean_out_string(
+            "Material Certificate V1 Prediction\n"
+            "==================================\n"
+            f":Filename: {self.filename or ''}\n"
+            f":Material Type: {self.certificate_type}\n"
+            f":Material Grade: {self.norm}\n"
+            f":Heat Number: {self.heat_number}\n"
+        )
+
+
+TypeMaterialCertificateV1 = TypeVar(
+    "TypeMaterialCertificateV1", bound=MaterialCertificateV1
+)

tests/data

@@ -0,0 +1,38 @@
+import json
+
+import pytest
+
+from mindee.documents import MaterialCertificateV1
+
+MATERIAL_CERTIFICATE_DATA_DIR = "./tests/data/material_certificate"
+
+FILE_PATH_MATERIAL_CERTIFICATE_V1_COMPLETE = (
+    f"{ MATERIAL_CERTIFICATE_DATA_DIR }/response_v1/complete.json"
+)
+FILE_PATH_MATERIAL_CERTIFICATE_V1_EMPTY = (
+    f"{ MATERIAL_CERTIFICATE_DATA_DIR }/response_v1/empty.json"
+)
+
+
+@pytest.fixture
+def material_certificate_v1_doc() -> MaterialCertificateV1:
+    json_data = json.load(open(FILE_PATH_MATERIAL_CERTIFICATE_V1_COMPLETE))
+    return MaterialCertificateV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def material_certificate_v1_doc_empty() -> MaterialCertificateV1:
+    json_data = json.load(open(FILE_PATH_MATERIAL_CERTIFICATE_V1_EMPTY))
+    return MaterialCertificateV1(json_data["document"]["inference"], page_n=None)
+
+
+def test_empty_doc_constructor(material_certificate_v1_doc_empty):
+    assert material_certificate_v1_doc_empty.certificate_type.value is None
+    assert material_certificate_v1_doc_empty.norm.value is None
+    assert material_certificate_v1_doc_empty.heat_number.value is None
+
+
+def test_doc_constructor(material_certificate_v1_doc):
+    file_path = f"{ MATERIAL_CERTIFICATE_DATA_DIR }/response_v1/doc_to_string.rst"
+    reference_str = open(file_path, "r", encoding="utf-8").read()
+    assert str(material_certificate_v1_doc) == reference_str