✨ add support for crop utility

Author: sebastianMindee

mindee/input/__init__.py

@@ -1,7 +1,6 @@
 from mindee.input.local_response import LocalResponse
 from mindee.input.base_parameters import BaseParameters
 from mindee.input.inference_parameters import InferenceParameters
-from mindee.v2.product.split.split_parameters import SplitParameters
 from mindee.input.page_options import PageOptions
 from mindee.input.polling_options import PollingOptions
 from mindee.input.sources.base_64_input import Base64Input
@@ -26,6 +25,5 @@
     "PathInput",
     "PollingOptions",
     "UrlInputSource",
-    "SplitParameters",
     "WorkflowOptions",
 ]

mindee/v2/__init__.py

@@ -1,7 +1,11 @@
+from mindee.v2.product.crop.crop_parameters import CropParameters
+from mindee.v2.product.crop.crop_response import CropResponse
 from mindee.v2.product.split.split_parameters import SplitParameters
 from mindee.v2.product.split.split_response import SplitResponse
 
 __all__ = [
+    "CropParameters",
+    "CropResponse",
     "SplitResponse",
     "SplitParameters",
 ]

mindee/v2/product/crop/__init__.py

@@ -0,0 +1,13 @@
+from mindee.v2.product.crop.crop_box import CropBox
+from mindee.v2.product.crop.crop_inference import CropInference
+from mindee.v2.product.crop.crop_parameters import CropParameters
+from mindee.v2.product.crop.crop_response import CropResponse
+from mindee.v2.product.crop.crop_result import CropResult
+
+__all__ = [
+    "CropBox",
+    "CropInference",
+    "CropParameters",
+    "CropResponse",
+    "CropResult",
+]

mindee/v2/product/crop/crop_box.py

@@ -0,0 +1,18 @@
+from mindee.parsing.common.string_dict import StringDict
+from mindee.parsing.v2.field.field_location import FieldLocation
+
+
+class CropBox:
+    """Crop inference result."""
+
+    location: FieldLocation
+    """Page box of the crop inference."""
+    object_type: str
+    """Document type of the crop inference."""
+
+    def __init__(self, server_response: StringDict):
+        self.location = FieldLocation(server_response["location"])
+        self.object_type = server_response["object_type"]
+
+    def __str__(self) -> str:
+        return f"* :Location: {self.location}\n  :Object Type: {self.object_type}"

mindee/v2/product/crop/crop_inference.py

@@ -0,0 +1,19 @@
+from mindee.parsing.common.string_dict import StringDict
+from mindee.v2.parsing.inference.base_inference import BaseInference
+from mindee.v2.product.crop.crop_result import CropResult
+
+
+class CropInference(BaseInference):
+    """Crop inference result."""
+
+    result: CropResult
+    """Result of a crop inference."""
+    _slug: str = "crop"
+    """Slug of the endpoint."""
+
+    def __init__(self, raw_response: StringDict) -> None:
+        super().__init__(raw_response)
+        self.result = CropResult(raw_response["result"])
+
+    def __str__(self) -> str:
+        return f"Inference\n#########\n{self.model}\n{self.file}\n{self.result}\n"

mindee/v2/product/crop/crop_parameters.py

@@ -0,0 +1,9 @@
+from mindee.input.base_parameters import BaseParameters
+
+
+class CropParameters(BaseParameters):
+    """
+    Parameters accepted by the crop utility v2 endpoint.
+    """
+
+    _slug: str = "utilities/crop"

mindee/v2/product/crop/crop_response.py

@@ -0,0 +1,17 @@
+from mindee.parsing.common.string_dict import StringDict
+from mindee.v2.parsing.inference import BaseResponse
+from mindee.v2.product.crop.crop_inference import CropInference
+
+
+class CropResponse(BaseResponse):
+    """Represent a crop inference response from Mindee V2 API."""
+
+    inference: CropInference
+    """Inference object for crop inference."""
+
+    _slug: str = "utilities/crop"
+    """Slug of the inference."""
+
+    def __init__(self, raw_response: StringDict) -> None:
+        super().__init__(raw_response)
+        self.inference = CropInference(raw_response["inference"])

mindee/v2/product/crop/crop_result.py

@@ -0,0 +1,20 @@
+from typing import List
+
+from mindee.parsing.common.string_dict import StringDict
+from mindee.v2.product.crop.crop_box import CropBox
+
+
+class CropResult:
+    """Crop result info."""
+
+    crops: List[CropBox]
+
+    def __init__(self, raw_response: StringDict) -> None:
+        self.crops = [CropBox(crop) for crop in raw_response["crops"]]
+
+    def __str__(self) -> str:
+        crops = "\n"
+        if len(self.crops) > 0:
+            crops += "\n\n".join([str(crop) for crop in self.crops])
+        out_str = f"Crops\n======{crops}"
+        return out_str