⬆️ update invoices to v4.4 (#214)

* ⬆️ update invoices to v4.4
* ✨ add support for raw_value in string fields

Author: ianardee

docs/extras/code_samples/invoices_v4.txt

@@ -10,5 +10,8 @@ input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
 # The endpoint name must be specified since it cannot be determined from the class.
 result: PredictResponse = mindee_client.parse(product.InvoiceV4, input_doc)
 
-# Print a brief summary of the parsed data
+# Print a summary of the API result
 print(result.document)
+
+# Print the document-level summary
+# print(result.document.inference.prediction)

docs/extras/guide/invoices_v4.md

@@ -20,8 +20,11 @@ input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
 # The endpoint name must be specified since it cannot be determined from the class.
 result: PredictResponse = mindee_client.parse(product.InvoiceV4, input_doc)
 
-# Print a brief summary of the parsed data
+# Print a summary of the API result
 print(result.document)
+
+# Print the document-level summary
+# print(result.document.inference.prediction)
 ```
 
 **Output (RST):**
@@ -325,5 +328,12 @@ print(result.document.inference.prediction.total_amount.value)
 print(result.document.inference.prediction.total_net.value)
 ```
 
+## Total Tax
+**total_tax** ([AmountField](#amountfield)): The total tax: includes all the taxes paid for this invoice.
+
+```py
+print(result.document.inference.prediction.total_tax.value)
+```
+
 # Questions?
 [Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

mindee/parsing/standard/text.py

@@ -8,6 +8,8 @@ class StringField(FieldPositionMixin, BaseField):
     """A field containing a text value."""
 
     value: Optional[str]
+    raw_value: Optional[str]
+    """The value as it appears on the document."""
 
     def __init__(
         self,
@@ -32,3 +34,4 @@ def __init__(
             page_id=page_id,
         )
         self._set_position(raw_prediction)
+        self.raw_value = raw_prediction.get("raw_value", None)

mindee/product/invoice/invoice_v4_document.py

@@ -51,6 +51,8 @@ class InvoiceV4Document(Prediction):
     """The total amount paid: includes taxes, tips, fees, and other charges."""
     total_net: AmountField
     """The net amount paid: does not include taxes, fees, and discounts."""
+    total_tax: AmountField
+    """The total tax: includes all the taxes paid for this invoice."""
 
     def __init__(
         self,
@@ -129,6 +131,10 @@ def __init__(
             raw_prediction["total_net"],
             page_id=page_id,
         )
+        self.total_tax = AmountField(
+            raw_prediction["total_tax"],
+            page_id=page_id,
+        )
 
     @staticmethod
     def _line_items_separator(char: str) -> str:
@@ -183,6 +189,7 @@ def __str__(self) -> str:
         out_str += f":Due Date: {self.due_date}\n"
         out_str += f":Total Net: {self.total_net}\n"
         out_str += f":Total Amount: {self.total_amount}\n"
+        out_str += f":Total Tax: {self.total_tax}\n"
         out_str += f":Taxes: {self.taxes}\n"
         out_str += f":Supplier Payment Details: {supplier_payment_details}\n"
         out_str += f":Supplier Name: {self.supplier_name}\n"

tests/data

@@ -0,0 +1,34 @@
+from mindee.parsing.standard.text import StringField
+
+
+def test_constructor_no_raw_value():
+    field_dict = {
+        "value": "hello world",
+        "confidence": 0.1,
+        "polygon": [
+            [0.016, 0.707],
+            [0.414, 0.707],
+            [0.414, 0.831],
+            [0.016, 0.831],
+        ],
+    }
+    field = StringField(field_dict)
+    assert field.value == "hello world"
+    assert field.raw_value is None
+
+
+def test_constructor_raw_value():
+    field_dict = {
+        "value": "hello world",
+        "raw_value": "HelLO wOrld",
+        "confidence": 0.1,
+        "polygon": [
+            [0.016, 0.707],
+            [0.414, 0.707],
+            [0.414, 0.831],
+            [0.016, 0.831],
+        ],
+    }
+    field = StringField(field_dict)
+    assert field.value == "hello world"
+    assert field.raw_value == "HelLO wOrld"

tests/fields/test_text.py

@@ -62,6 +62,7 @@ def test_empty_doc(empty_doc: Document[InvoiceV4Document, Page[InvoiceV4Document
     assert prediction.due_date.value is None
     assert prediction.total_net.value is None
     assert prediction.total_amount.value is None
+    assert prediction.total_tax.value is None
     assert len(prediction.taxes) == 0
     assert len(prediction.supplier_payment_details) == 0
     assert prediction.supplier_name.value is None