✨ Add orientation info on all pages

Author: ianardee

mindee/documents/base.py

@@ -3,6 +3,7 @@
 from typing import Any, Dict, List, Optional, TypeVar
 
 from mindee.endpoints import Endpoint
+from mindee.fields.orientation import OrientationField
 from mindee.input.sources import InputSource
 
 TypeApiPrediction = Dict[str, Any]
@@ -36,6 +37,9 @@ class Document:
     """Name of the input document"""
     file_extension: Optional[str] = None
     """File extension of the input document"""
+    # orientation is only present on page-level, not document-level
+    orientation: Optional[OrientationField] = None
+    """Page orientation"""
 
     def __init__(
         self,
@@ -48,13 +52,13 @@ def __init__(
             self.filepath = input_source.filepath
             self.filename = input_source.filename
             self.file_extension = input_source.file_mimetype
-
+        self.checklist = {}
         self.type = document_type
 
-        self._build_from_api_prediction(api_prediction, page_n=page_n)
-        self.checklist = {}
-        self._checklist()
-        self._reconstruct()
+        if page_n is not None:
+            self.orientation = OrientationField(
+                api_prediction["orientation"], page_n=page_n
+            )
 
     @staticmethod
     def request(

mindee/documents/custom/custom_v1.py

@@ -31,6 +31,7 @@ def __init__(
             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

mindee/documents/financial/financial_v1.py

@@ -8,7 +8,6 @@
 from mindee.fields.company_registration import CompanyRegistrationField
 from mindee.fields.date import DateField
 from mindee.fields.locale import LocaleField
-from mindee.fields.orientation import OrientationField
 from mindee.fields.payment_details import PaymentDetails
 from mindee.fields.tax import TaxField
 from mindee.fields.text import TextField
@@ -48,10 +47,6 @@ class FinancialV1(Document):
     total_tax: AmountField
     """Sum total of all taxes"""
 
-    # orientation is only present on page-level, not document-level
-    orientation: Optional[OrientationField] = None
-    """Page orientation"""
-
     def __init__(
         self,
         api_prediction=None,
@@ -75,6 +70,8 @@ def __init__(
             api_prediction=api_prediction,
             page_n=page_n,
         )
+        self._build_from_api_prediction(api_prediction, page_n=page_n)
+        self._checklist()
 
     def _build_from_api_prediction(
         self, api_prediction: TypeApiPrediction, page_n: Optional[int] = None
@@ -85,7 +82,7 @@ def _build_from_api_prediction(
         :param api_prediction: Raw prediction from HTTP response
         :param page_n: Page number for multi pages pdf input
         """
-        if "invoice_number" in api_prediction.keys():
+        if "invoice_number" in api_prediction["prediction"].keys():
             invoice = InvoiceV3(api_prediction, self.input_file, page_n=page_n)
             self.locale = invoice.locale
             self.total_incl = invoice.total_incl

mindee/documents/invoice/invoice_v3.py

@@ -6,7 +6,6 @@
 from mindee.fields.company_registration import CompanyRegistrationField
 from mindee.fields.date import DateField
 from mindee.fields.locale import LocaleField
-from mindee.fields.orientation import OrientationField
 from mindee.fields.payment_details import PaymentDetails
 from mindee.fields.tax import TaxField
 from mindee.fields.text import TextField
@@ -43,9 +42,6 @@ class InvoiceV3(Document):
     """Payment details"""
     company_number: List[CompanyRegistrationField]
     """Company numbers"""
-    # orientation is only present on page-level, not document-level
-    orientation: Optional[OrientationField] = None
-    """Page orientation"""
 
     def __init__(
         self,
@@ -67,6 +63,9 @@ def __init__(
             api_prediction=api_prediction,
             page_n=page_n,
         )
+        self._build_from_api_prediction(api_prediction["prediction"], page_n=page_n)
+        self._checklist()
+        self._reconstruct()
 
     def _build_from_api_prediction(
         self, api_prediction: TypeApiPrediction, page_n: Optional[int] = None
@@ -77,11 +76,6 @@ def _build_from_api_prediction(
         :param api_prediction: Raw prediction from HTTP response
         :param page_n: Page number for multi pages pdf input
         """
-        if page_n is not None:
-            self.orientation = OrientationField(
-                api_prediction["orientation"], page_n=page_n
-            )
-
         self.company_number = [
             CompanyRegistrationField(field_dict, page_n=page_n)
             for field_dict in api_prediction["company_registration"]

mindee/documents/passport/passport_v1.py

@@ -58,6 +58,9 @@ def __init__(
             api_prediction=api_prediction,
             page_n=page_n,
         )
+        self._build_from_api_prediction(api_prediction["prediction"], page_n=page_n)
+        self._checklist()
+        self._reconstruct()
 
     def _build_from_api_prediction(
         self, api_prediction: TypeApiPrediction, page_n: Optional[int] = None

mindee/documents/receipt/receipt_v3.py

@@ -5,7 +5,6 @@
 from mindee.fields.base import field_array_confidence, field_array_sum
 from mindee.fields.date import DateField
 from mindee.fields.locale import LocaleField
-from mindee.fields.orientation import OrientationField
 from mindee.fields.tax import TaxField
 from mindee.fields.text import TextField
 
@@ -29,9 +28,6 @@ class ReceiptV3(Document):
     """Sum total of all taxes"""
     total_excl: AmountField
     """Total excluding taxes"""
-    # orientation is only present on page-level, not document-level
-    orientation: Optional[OrientationField] = None
-    """Page orientation"""
 
     def __init__(
         self,
@@ -53,6 +49,9 @@ def __init__(
             api_prediction=api_prediction,
             page_n=page_n,
         )
+        self._build_from_api_prediction(api_prediction["prediction"], page_n=page_n)
+        self._checklist()
+        self._reconstruct()
 
     def __str__(self) -> str:
         taxes = "\n       ".join(f"{t}" for t in self.taxes)
@@ -80,11 +79,6 @@ def _build_from_api_prediction(
         :param api_prediction: Raw prediction from HTTP response
         :param page_n: Page number for multi pages pdf input
         """
-        if page_n is not None:
-            self.orientation = OrientationField(
-                api_prediction["orientation"], page_n=page_n
-            )
-
         self.locale = LocaleField(api_prediction["locale"], page_n=page_n)
         self.total_incl = AmountField(api_prediction["total_incl"], page_n=page_n)
         self.date = DateField(api_prediction["date"], page_n=page_n)

mindee/documents/receipt/receipt_v4.py

@@ -4,7 +4,6 @@
 from mindee.fields.amount import AmountField
 from mindee.fields.date import DateField
 from mindee.fields.locale import LocaleField
-from mindee.fields.orientation import OrientationField
 from mindee.fields.tax import TaxField
 from mindee.fields.text import TextField
 
@@ -30,9 +29,6 @@ class ReceiptV4(Document):
     "Total amount of the purchase excluding taxes."
     tip: AmountField
     """Total amount of tip and gratuity."""
-    # orientation is only present on page-level, not document-level
-    orientation: Optional[OrientationField] = None
-    """Page orientation"""
 
     def __init__(
         self,
@@ -54,6 +50,7 @@ def __init__(
             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
@@ -64,11 +61,6 @@ def _build_from_api_prediction(
         :param api_prediction: Raw prediction from HTTP response
         :param page_n: Page number for multi pages pdf input
         """
-        if page_n is not None:
-            self.orientation = OrientationField(
-                api_prediction["orientation"], page_n=page_n
-            )
-
         self.locale = LocaleField(api_prediction["locale"], page_n=page_n)
         self.total_amount = AmountField(api_prediction["total_amount"], page_n=page_n)
         self.total_net = AmountField(api_prediction["total_net"], page_n=page_n)

mindee/documents/us/bank_check/bank_check_v1.py

@@ -3,8 +3,7 @@
 from mindee.documents.base import Document, TypeApiPrediction, clean_out_string
 from mindee.fields.amount import AmountField
 from mindee.fields.date import DateField
-from mindee.fields.orientation import OrientationField
-from mindee.fields.position import Position
+from mindee.fields.position import PositionField
 from mindee.fields.text import TextField
 
 
@@ -21,13 +20,10 @@ class BankCheckV1(Document):
     """Payer's bank account routing number"""
     account_number: TextField
     """Payer's bank account number"""
-    check_position: Position
+    check_position: PositionField
     """Check's position in the image"""
-    signatures_positions: List[Position]
+    signatures_positions: List[PositionField]
     """Signatures' positions in the image"""
-    # orientation is only present on page-level, not document-level
-    orientation: Optional[OrientationField] = None
-    """Page orientation"""
 
     def __init__(
         self,
@@ -49,6 +45,7 @@ def __init__(
             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
@@ -59,11 +56,6 @@ def _build_from_api_prediction(
         :param api_prediction: Raw prediction from HTTP response
         :param page_n: Page number for multi pages pdf input
         """
-        if page_n is not None:
-            self.orientation = OrientationField(
-                api_prediction["orientation"], page_n=page_n
-            )
-
         self.routing_number = TextField(api_prediction["routing_number"], page_n=page_n)
         self.account_number = TextField(api_prediction["account_number"], page_n=page_n)
         self.check_number = TextField(api_prediction["check_number"], page_n=page_n)
@@ -72,9 +64,11 @@ def _build_from_api_prediction(
         self.payees = [
             TextField(payee, page_n=page_n) for payee in api_prediction["payees"]
         ]
-        self.check_position = Position(api_prediction["check_position"], page_n=page_n)
+        self.check_position = PositionField(
+            api_prediction["check_position"], page_n=page_n
+        )
         self.signatures_positions = [
-            Position(signature_position, page_n=page_n)
+            PositionField(signature_position, page_n=page_n)
             for signature_position in api_prediction["signatures_positions"]
         ]
 
@@ -83,8 +77,8 @@ def __str__(self) -> str:
             [payee.value if payee.value is not None else "" for payee in self.payees]
         )
         return clean_out_string(
-            "----- US Bank Check -----\n"
-            f"Filename: {self.filename or ''}".rstrip() + "\n"
+            "----- US Bank Check V1 -----\n"
+            f"Filename: {self.filename or ''}\n"
             f"Routing number: {self.routing_number}\n"
             f"Account number: {self.account_number}\n"
             f"Check number: {self.check_number}\n"

mindee/fields/orientation.py

@@ -10,7 +10,7 @@ class OrientationField(BaseField):
     def __init__(
         self,
         prediction: TypePrediction,
-        value_key: str = "degrees",
+        value_key: str = "value",
         reconstructed: bool = False,
         page_n: Optional[int] = None,
     ):
@@ -35,4 +35,3 @@ def __init__(
                 self.value = 0
         except (TypeError, ValueError, KeyError):
             self.value = 0
-            self.confidence = 0.0

mindee/fields/position.py

@@ -10,7 +10,7 @@
 )
 
 
-class Position(BaseField):
+class PositionField(BaseField):
     value: Optional[Polygon] = None
     polygon: Optional[Polygon] = None
     quadrangle: Optional[Quadrilateral] = None