✨ add support for Multi Receipts Detector V1

Author: sebastianMindee

docs/extras/code_samples/multi_receipts_detector_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 Multi Receipts Detector by passing the appropriate type
+result = input_doc.parse(documents.TypeMultiReceiptsDetectorV1)
+
+# Print a brief summary of the parsed data
+print(result.document)

docs/predictions/standard/documents/multi_receipts_detector_v1.rst

@@ -0,0 +1,10 @@
+Multi Receipts Detector V1
+--------------------------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/multi_receipts_detector_v1.txt
+    :language: Python
+
+.. autoclass:: mindee.documents.MultiReceiptsDetectorV1
+    :members:

mindee/client.py

@@ -474,6 +474,11 @@ def _init_default_endpoints(self) -> None:
                 url_name="material_certificate",
                 version="1",
             ),
+            ConfigSpec(
+                doc_class=documents.MultiReceiptsDetectorV1,
+                url_name="multi_receipts_detector",
+                version="1",
+            ),
             ConfigSpec(
                 doc_class=documents.us.W9V1,
                 url_name="us_w9",

mindee/documents/__init__.py

@@ -15,6 +15,10 @@
     MaterialCertificateV1,
     TypeMaterialCertificateV1,
 )
+from mindee.documents.multi_receipts_detector import (
+    MultiReceiptsDetectorV1,
+    TypeMultiReceiptsDetectorV1,
+)
 from mindee.documents.passport import PassportV1, TypePassportV1
 from mindee.documents.proof_of_address import ProofOfAddressV1, TypeProofOfAddressV1
 from mindee.documents.receipt import (

mindee/documents/multi_receipts_detector/__init__.py

@@ -0,0 +1 @@
+from .multi_receipts_detector_v1 import MultiReceiptsDetectorV1, TypeMultiReceiptsDetectorV1

mindee/documents/multi_receipts_detector/multi_receipts_detector_v1.py

@@ -0,0 +1,63 @@
+from typing import List, Optional, TypeVar
+
+from mindee.documents.base import Document, TypeApiPrediction, clean_out_string
+from mindee.fields.position import PositionField
+
+
+class MultiReceiptsDetectorV1(Document):
+    """Multi Receipts Detector v1 prediction results."""
+
+    receipts: List[PositionField]
+    """Positions of the receipts on the document."""
+
+    def __init__(
+        self,
+        api_prediction=None,
+        input_source=None,
+        page_n: Optional[int] = None,
+    ):
+        """
+        Multi Receipts Detector 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="multi_receipts_detector",
+            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.receipts = [
+            PositionField(prediction, page_id=page_n)
+            for prediction in api_prediction["receipts"]
+        ]
+
+    def __str__(self) -> str:
+        receipts = f"\n { ' ' * 18 }".join(
+            [str(item) for item in self.receipts],
+        )
+        return clean_out_string(
+            "Multi Receipts Detector V1 Prediction\n"
+            "=====================================\n"
+            f":Filename: {self.filename or ''}\n"
+            f":List of Receipts: {receipts}\n"
+        )
+
+
+TypeMultiReceiptsDetectorV1 = TypeVar(
+    "TypeMultiReceiptsDetectorV1",
+    bound=MultiReceiptsDetectorV1,
+)

mindee/fields/position.py

@@ -72,6 +72,12 @@ def get_polygon(key: str) -> Optional[Polygon]:
         self.value = self.polygon
 
     def __str__(self) -> str:
-        if self.polygon is None:
-            return ""
-        return f"Polygon with {len(self.polygon)} points."
+        if self.polygon is not None:
+            return f"Polygon with {len(self.polygon)} points."
+        if self.bounding_box is not None:
+            return f"Polygon with {len(self.bounding_box)} points."
+        if self.rectangle is not None:
+            return f"Polygon with {len(self.rectangle)} points."
+        if self.quadrangle is not None:
+            return f"Polygon with {len(self.quadrangle)} points."
+        return ""

tests/documents/test_barcode_reader_v1.py

@@ -5,8 +5,12 @@
 from mindee.documents import BarcodeReaderV1
 
 BARCODE_READER_DATA_DIR = "./tests/data/products/barcode_reader"
-FILE_PATH_BARCODE_READER_V1_COMPLETE = f"{ BARCODE_READER_DATA_DIR }/response_v1/complete.json"
-FILE_PATH_BARCODE_READER_V1_EMPTY = f"{ BARCODE_READER_DATA_DIR }/response_v1/empty.json"
+FILE_PATH_BARCODE_READER_V1_COMPLETE = (
+    f"{ BARCODE_READER_DATA_DIR }/response_v1/complete.json"
+)
+FILE_PATH_BARCODE_READER_V1_EMPTY = (
+    f"{ BARCODE_READER_DATA_DIR }/response_v1/empty.json"
+)
 
 
 @pytest.fixture

tests/documents/test_multi_receipts_detector_v1.py

@@ -0,0 +1,31 @@
+import json
+
+import pytest
+
+from mindee.documents import MultiReceiptsDetectorV1
+
+MULTI_RECEIPTS_DETECTOR_DATA_DIR = "./tests/data/products/multi_receipts_detector"
+FILE_PATH_MULTI_RECEIPTS_DETECTOR_V1_COMPLETE = f"{ MULTI_RECEIPTS_DETECTOR_DATA_DIR }/response_v1/complete.json"
+FILE_PATH_MULTI_RECEIPTS_DETECTOR_V1_EMPTY = f"{ MULTI_RECEIPTS_DETECTOR_DATA_DIR }/response_v1/empty.json"
+
+
+@pytest.fixture
+def multi_receipts_detector_v1_doc() -> MultiReceiptsDetectorV1:
+    json_data = json.load(open(FILE_PATH_MULTI_RECEIPTS_DETECTOR_V1_COMPLETE, encoding="utf-8"))
+    return MultiReceiptsDetectorV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def multi_receipts_detector_v1_doc_empty() -> MultiReceiptsDetectorV1:
+    json_data = json.load(open(FILE_PATH_MULTI_RECEIPTS_DETECTOR_V1_EMPTY, encoding="utf-8"))
+    return MultiReceiptsDetectorV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def multi_receipts_detector_v1_page0():
+    json_data = json.load(open(FILE_PATH_MULTI_RECEIPTS_DETECTOR_V1_COMPLETE, encoding="utf-8"))
+    return MultiReceiptsDetectorV1(json_data["document"]["inference"]["pages"][0], page_n=0)
+
+
+def test_empty_doc_constructor(multi_receipts_detector_v1_doc_empty):
+    assert len(multi_receipts_detector_v1_doc_empty.receipts) == 0