revise entire endpoint slug generation system & refactor input parameters

Author: sebastianMindee

mindee/client_v2.py

@@ -16,13 +16,11 @@
     is_valid_post_response,
 )
 from mindee.parsing.v2.common_response import CommonStatus
-from mindee.v2 import BaseInferenceResponse
+from mindee.v2.parsing.inference.base_response import BaseResponse
 from mindee.parsing.v2.inference_response import InferenceResponse
 from mindee.parsing.v2.job_response import JobResponse
 
-TypeBaseInferenceResponse = TypeVar(
-    "TypeBaseInferenceResponse", bound=BaseInferenceResponse
-)
+TypeBaseInferenceResponse = TypeVar("TypeBaseInferenceResponse", bound=BaseResponse)
 
 
 class ClientV2(ClientMixin):
@@ -48,7 +46,6 @@ def enqueue_inference(
         self,
         input_source: Union[LocalInputSource, UrlInputSource],
         params: BaseParameters,
-        slug: Optional[str] = None,
         disable_redundant_warnings: bool = False,
     ) -> JobResponse:
         """[Deprecated] Use `enqueue` instead."""
@@ -58,13 +55,12 @@ def enqueue_inference(
                 DeprecationWarning,
                 stacklevel=2,
             )
-        return self.enqueue(input_source, params, slug)
+        return self.enqueue(input_source, params)
 
     def enqueue(
         self,
         input_source: Union[LocalInputSource, UrlInputSource],
         params: BaseParameters,
-        slug: Optional[str] = None,
     ) -> JobResponse:
         """
         Enqueues a document to a given model.
@@ -77,7 +73,7 @@ def enqueue(
         """
         logger.debug("Enqueuing inference using model: %s", params.model_id)
         response = self.mindee_api.req_post_inference_enqueue(
-            input_source=input_source, params=params, slug=slug
+            input_source=input_source, params=params, slug=params.get_enqueue_slug()
         )
         dict_response = response.json()
 
@@ -105,9 +101,9 @@ def get_job(self, job_id: str) -> JobResponse:
     def get_inference(
         self,
         inference_id: str,
-        response_type: Type[BaseInferenceResponse] = InferenceResponse,
+        response_type: Type[BaseResponse] = InferenceResponse,
         disable_redundant_warnings: bool = False,
-    ) -> BaseInferenceResponse:
+    ) -> BaseResponse:
         """[Deprecated] Use `get_result` instead."""
         if not disable_redundant_warnings:
             warnings.warn(
@@ -120,8 +116,8 @@ def get_inference(
     def get_result(
         self,
         inference_id: str,
-        response_type: Type[BaseInferenceResponse] = InferenceResponse,
-    ) -> BaseInferenceResponse:
+        response_type: Type[BaseResponse] = InferenceResponse,
+    ) -> BaseResponse:
         """
         Get the result of an inference that was previously enqueued.
 
@@ -132,11 +128,10 @@ def get_result(
         :return: An inference response.
         """
         logger.debug("Fetching inference: %s", inference_id)
-        slug = None
-        if response_type and response_type is not InferenceResponse:
-            slug = "utilities/" + response_type.get_inference_slug()
 
-        response = self.mindee_api.req_get_inference(inference_id, slug)
+        response = self.mindee_api.req_get_inference(
+            inference_id, response_type.get_result_slug()
+        )
         if not is_valid_get_response(response):
             handle_error_v2(response.json())
         dict_response = response.json()
@@ -146,8 +141,8 @@ def _enqueue_and_get(
         self,
         input_source: Union[LocalInputSource, UrlInputSource],
         params: BaseParameters,
-        response_type: Optional[Type[BaseInferenceResponse]] = InferenceResponse,
-    ) -> BaseInferenceResponse:
+        response_type: Optional[Type[BaseResponse]] = InferenceResponse,
+    ) -> BaseResponse:
         """
         Enqueues to an asynchronous endpoint and automatically polls for a response.
 
@@ -164,10 +159,7 @@ def _enqueue_and_get(
             params.polling_options.delay_sec,
             params.polling_options.max_retries,
         )
-        slug = None
-        if response_type and response_type is not InferenceResponse:
-            slug = "utilities/" + response_type.get_inference_slug()
-        enqueue_response = self.enqueue_inference(input_source, params, slug, True)
+        enqueue_response = self.enqueue_inference(input_source, params, True)
         logger.debug(
             "Successfully enqueued document with job id: %s", enqueue_response.job.id
         )

mindee/input/__init__.py

@@ -1,7 +1,7 @@
 from mindee.input.local_response import LocalResponse
 from mindee.input.base_parameters import BaseParameters
 from mindee.input.inference_parameters import InferenceParameters
-from mindee.v2.parsing.inference.split.split_parameters import SplitParameters
+from mindee.v2.parsing.inference.utilities.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

mindee/input/base_parameters.py

@@ -1,5 +1,5 @@
 from abc import ABC
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Dict, Optional, List, Union
 
 from mindee.input.polling_options import PollingOptions
@@ -9,6 +9,9 @@
 class BaseParameters(ABC):
     """Base class for parameters accepted by all V2 endpoints."""
 
+    _slug: str = field(init=False)
+    """Slug of the endpoint."""
+
     model_id: str
     """ID of the model, required."""
     alias: Optional[str] = None
@@ -34,3 +37,8 @@ def get_config(self) -> Dict[str, Union[str, List[str]]]:
         if self.webhook_ids and len(self.webhook_ids) > 0:
             data["webhook_ids"] = self.webhook_ids
         return data
+
+    @classmethod
+    def get_enqueue_slug(cls) -> str:
+        """Getter for the enqueue slug."""
+        return cls._slug

mindee/input/inference_parameters.py

@@ -1,5 +1,5 @@
 import json
-from dataclasses import dataclass, asdict
+from dataclasses import dataclass, asdict, field
 from typing import Dict, List, Optional, Union
 
 from mindee.input.base_parameters import BaseParameters
@@ -81,6 +81,9 @@ def __post_init__(self) -> None:
 class InferenceParameters(BaseParameters):
     """Inference parameters to set when sending a file."""
 
+    _slug: str = field(init=False, default="inferences")
+    """Slug of the endpoint."""
+
     rag: Optional[bool] = None
     """Enhance extraction accuracy with Retrieval-Augmented Generation."""
     raw_text: Optional[bool] = None

mindee/mindee_http/mindee_api_v2.py

@@ -74,7 +74,7 @@ def req_post_inference_enqueue(
         self,
         input_source: Union[LocalInputSource, UrlInputSource],
         params: BaseParameters,
-        slug: Optional[str] = None,
+        slug: str,
     ) -> requests.Response:
         """
         Make an asynchronous request to POST a document for prediction on the V2 API.
@@ -84,8 +84,6 @@ def req_post_inference_enqueue(
         :param slug: Slug to use for the enqueueing, defaults to 'inferences'.
         :return: requests response.
         """
-        if not slug:
-            slug = "inferences"
         data = params.get_config()
         url = f"{self.url_root}/{slug}/enqueue"
 
@@ -123,20 +121,15 @@ def req_get_job(self, job_id: str) -> requests.Response:
             allow_redirects=False,
         )
 
-    def req_get_inference(
-        self, inference_id: str, slug: Optional[str]
-    ) -> requests.Response:
+    def req_get_inference(self, inference_id: str, slug: str) -> requests.Response:
         """
         Sends a request matching a given queue_id. Returns either a Job or a Document.
 
         :param inference_id: Inference ID, returned by the job request.
         :param slug: Slug of the inference, defaults to nothing.
         """
 
-        if not slug:
-            url = f"{self.url_root}/inferences/{inference_id}"
-        else:
-            url = f"{self.url_root}/{slug}/{inference_id}"
+        url = f"{self.url_root}/{slug}/{inference_id}"
         return requests.get(
             url,
             headers=self.base_headers,

mindee/parsing/v2/inference.py

@@ -11,8 +11,6 @@ class Inference(BaseInference):
     """Result of the inference."""
     active_options: InferenceActiveOptions
     """Active options for the inference."""
-    _slug: str = "inferences"
-    """Slug of the inference."""
 
     def __init__(self, raw_response: StringDict):
         super().__init__(raw_response)

mindee/parsing/v2/inference_response.py

@@ -1,16 +1,17 @@
 from mindee.parsing.common.string_dict import StringDict
 from mindee.parsing.v2.inference import Inference
-from mindee.v2.parsing.inference.base_inference_response import (
-    BaseInferenceResponse,
+from mindee.v2.parsing.inference.base_response import (
+    BaseResponse,
 )
 
 
-class InferenceResponse(BaseInferenceResponse[Inference]):
+class InferenceResponse(BaseResponse):
     """Represent an inference response from Mindee V2 API."""
 
     inference: Inference
     """Inference result."""
-    inference_type = Inference
+    _slug: str = "inferences"
+    """Slug of the inference."""
 
     def __init__(self, raw_response: StringDict) -> None:
         super().__init__(raw_response)
@@ -19,5 +20,7 @@ def __init__(self, raw_response: StringDict) -> None:
     def __str__(self) -> str:
         return str(self.inference)
 
-    def _set_inference_type(self, inference_response: StringDict):
-        return Inference
+    @classmethod
+    def get_result_slug(cls) -> str:
+        """Getter for the inference slug."""
+        return cls._slug

mindee/v2/__init__.py

@@ -1,15 +1,8 @@
 from mindee.v2.parsing import SplitParameters
-from mindee.v2.parsing.inference.base_inference import BaseInference
-from mindee.v2.parsing.inference.base_inference_response import (
-    BaseInferenceResponse,
-    TypeInferenceResponse,
-)
-from mindee.v2.parsing.inference.split.split_response import SplitResponse
+
+from mindee.v2.parsing.inference.utilities.split.split_response import SplitResponse
 
 __all__ = [
-    "BaseInference",
-    "BaseInferenceResponse",
-    "TypeInferenceResponse",
     "SplitResponse",
     "SplitParameters",
 ]

mindee/v2/parsing/__init__.py

@@ -1,15 +1,7 @@
 from mindee.v2.parsing.inference import SplitParameters
-from mindee.v2.parsing.inference.base_inference import BaseInference
-from mindee.v2.parsing.inference.base_inference_response import (
-    BaseInferenceResponse,
-    TypeInferenceResponse,
-)
-from mindee.v2.parsing.inference.split.split_response import SplitResponse
+from mindee.v2.parsing.inference.utilities.split.split_response import SplitResponse
 
 __all__ = [
-    "BaseInference",
-    "BaseInferenceResponse",
-    "TypeInferenceResponse",
     "SplitResponse",
     "SplitParameters",
 ]

mindee/v2/parsing/inference/__init__.py

@@ -1,19 +1,17 @@
 from mindee.v2.parsing.inference.base_inference import BaseInference
-from mindee.v2.parsing.inference.base_inference_response import (
-    BaseInferenceResponse,
-    TypeInferenceResponse,
+from mindee.v2.parsing.inference.base_response import (
+    BaseResponse,
 )
-from mindee.v2.parsing.inference.split.split import Split
-from mindee.v2.parsing.inference.split.split_inference import SplitInference
-from mindee.v2.parsing.inference.split.split_parameters import SplitParameters
-from mindee.v2.parsing.inference.split.split_response import SplitResponse
-from mindee.v2.parsing.inference.split.split_result import SplitResult
+from mindee.v2.parsing.inference.utilities.split.split_split import SplitSplit
+from mindee.v2.parsing.inference.utilities.split import SplitInference
+from mindee.v2.parsing.inference.utilities.split.split_parameters import SplitParameters
+from mindee.v2.parsing.inference.utilities.split.split_response import SplitResponse
+from mindee.v2.parsing.inference.utilities.split.split_result import SplitResult
 
 __all__ = [
     "BaseInference",
-    "BaseInferenceResponse",
-    "TypeInferenceResponse",
-    "Split",
+    "BaseResponse",
+    "SplitSplit",
     "SplitInference",
     "SplitParameters",
     "SplitResponse",