💥 ♻️ rename inference product to extraction and move internals

Author: sebastianMindee

.gitignore

@@ -137,5 +137,6 @@ dmypy.json
 *.swp
 *-swp
 _test.py
+_test*.py
 _test.json
 local_test

docs/extras/code_samples/v2_classification.txt

@@ -1,16 +1,16 @@
-from mindee import (
-    ClientV2,
-    PathInput,
-    ClassificationParameters,
-    ClassificationResponse,
+from mindee import PathInput
+from mindee.v2 import (
+  Client,
+  ClassificationParameters,
+  ClassificationResponse,
 )
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
 model_id = "MY_MODEL_ID"
 
 # Init a new client
-mindee_client = ClientV2(api_key)
+mindee_client = Client(api_key)
 
 # Set parameters
 params = ClassificationParameters(

docs/extras/code_samples/v2_crop.txt

@@ -1,16 +1,16 @@
-from mindee import (
-    ClientV2,
-    PathInput,
-    CropParameters,
-    CropResponse,
+from mindee import PathInput
+from mindee.v2 import (
+  Client,
+  CropParameters,
+  CropResponse,
 )
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
 model_id = "MY_MODEL_ID"
 
 # Init a new client
-mindee_client = ClientV2(api_key)
+mindee_client = Client(api_key)
 
 # Set parameters
 params = CropParameters(

docs/extras/code_samples/v2_extraction.txt

@@ -1,19 +1,19 @@
-from mindee import (
-  ClientV2,
-  InferenceParameters,
-  InferenceResponse,
-  PathInput,
+from mindee import PathInput
+from mindee.v2 import (
+  Client,
+  ExtractionParameters,
+  ExtractionResponse,
 )
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
 model_id = "MY_MODEL_ID"
 
 # Init a new client
-mindee_client = ClientV2(api_key)
+mindee_client = Client(api_key)
 
-# Set inference parameters
-params = InferenceParameters(
+# Set extraction parameters
+params = ExtractionParameters(
     # ID of the model, required.
     model_id=model_id,
 
@@ -35,7 +35,7 @@ input_source = PathInput(input_path)
 
 # Send for processing
 response = mindee_client.enqueue_and_get_result(
-    InferenceResponse,
+    ExtractionResponse,
     input_source,
     params,
 )

docs/extras/code_samples/v2_ocr.txt

@@ -1,16 +1,16 @@
-from mindee import (
-    ClientV2,
-    PathInput,
-    OCRParameters,
-    OCRResponse,
+from mindee import PathInput
+from mindee.v2 import (
+  Client,
+  OCRParameters,
+  OCRResponse,
 )
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
 model_id = "MY_MODEL_ID"
 
 # Init a new client
-mindee_client = ClientV2(api_key)
+mindee_client = Client(api_key)
 
 # Set parameters
 params = OCRParameters(

docs/extras/code_samples/v2_split.txt

@@ -1,16 +1,16 @@
-from mindee import (
-    ClientV2,
-    PathInput,
-    SplitParameters,
-    SplitResponse,
+from mindee import PathInput
+from mindee.v2 import (
+  Client,
+  SplitParameters,
+  SplitResponse,
 )
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
 model_id = "MY_MODEL_ID"
 
 # Init a new client
-mindee_client = ClientV2(api_key)
+mindee_client = Client(api_key)
 
 # Set parameters
 params = SplitParameters(

mindee/__init__.py

@@ -1,22 +1,26 @@
 from mindee.v1 import product
 from mindee.input import LocalResponse, PageOptions, PollingOptions
-from mindee.v2.product.extraction.params.inference_parameters import InferenceParameters
+from mindee.v2.parsing.inference.job_response import JobResponse
+from mindee.v2.product.extraction.params.extraction_parameters import (
+    ExtractionParameters,
+)
 from mindee.input.sources import (
     Base64Input,
     BytesInput,
     FileInput,
     PathInput,
     UrlInputSource,
 )
-from mindee.v2.parsing import InferenceResponse, JobResponse
-from mindee.v2.product.classification.param.classification_parameters import (
+from mindee.v2.product.classification.params.classification_parameters import (
     ClassificationParameters,
 )
 from mindee.v2.product.classification.classification_response import (
     ClassificationResponse,
 )
 from mindee.v2.product.crop.params.crop_parameters import CropParameters
 from mindee.v2.product.crop.crop_response import CropResponse
+from mindee.v2.product.extraction.extraction_response import ExtractionResponse
+from mindee.v2.product.extraction.extraction_result import ExtractionResult
 from mindee.v2.product.ocr.params.ocr_parameters import OCRParameters
 from mindee.v2.product.ocr.ocr_response import OCRResponse
 from mindee.v2.product.split.params.split_parameters import SplitParameters
@@ -30,8 +34,9 @@
     "CropParameters",
     "CropResponse",
     "FileInput",
-    "InferenceParameters",
-    "InferenceResponse",
+    "ExtractionParameters",
+    "ExtractionResponse",
+    "ExtractionResult",
     "JobResponse",
     "LocalResponse",
     "OCRParameters",

mindee/client_mixin.py

@@ -19,8 +19,8 @@ def source_from_path(
         """
         Load a document from a path, as a string or a `Path` object.
 
-        :param input_path: Path of file to open
-        :param fix_pdf: Whether to attempt fixing PDF files before sending.
+        :params input_path: Path of file to open
+        :params fix_pdf: Whether to attempt fixing PDF files before sending.
             Setting this to `True` can modify the data sent to Mindee.
         """
         input_doc = PathInput(input_path)
@@ -33,8 +33,8 @@ def source_from_file(input_file: BinaryIO, fix_pdf: bool = False) -> FileInput:
         """
         Load a document from a normal Python file object/handle.
 
-        :param input_file: Input file handle
-        :param fix_pdf: Whether to attempt fixing PDF files before sending.
+        :params input_file: Input file handle
+        :params fix_pdf: Whether to attempt fixing PDF files before sending.
             Setting this to `True` can modify the data sent to Mindee.
         """
         input_doc = FileInput(input_file)
@@ -49,9 +49,9 @@ def source_from_b64string(
         """
         Load a document from a base64 encoded string.
 
-        :param input_string: Input to parse as base64 string
-        :param filename: The name of the file (without the path)
-        :param fix_pdf: Whether to attempt fixing PDF files before sending.
+        :params input_string: Input to parse as base64 string
+        :params filename: The name of the file (without the path)
+        :params fix_pdf: Whether to attempt fixing PDF files before sending.
             Setting this to `True` can modify the data sent to Mindee.
         """
         input_doc = Base64Input(input_string, filename)
@@ -66,9 +66,9 @@ def source_from_bytes(
         """
         Load a document from raw bytes.
 
-        :param input_bytes: Raw byte input
-        :param filename: The name of the file (without the path)
-        :param fix_pdf: Whether to attempt fixing PDF files before sending.
+        :params input_bytes: Raw byte input
+        :params filename: The name of the file (without the path)
+        :params fix_pdf: Whether to attempt fixing PDF files before sending.
             Setting this to `True` can modify the data sent to Mindee.
         """
         input_doc = BytesInput(input_bytes, filename)
@@ -101,7 +101,7 @@ def source_from_url(
         """
         Load a document from a URL.
 
-        :param url: Raw byte input
+        :params url: Raw byte input
         """
         return UrlInputSource(
             url,

mindee/error/mindee_http_error.py

@@ -16,9 +16,9 @@ def __init__(self, http_error: StringDict, url: str, code: int) -> None:
         """
         Base exception for HTTP calls.
 
-        :param http_error: formatted & parsed error
-        :param url: url/endpoint the exception was raised on
-        :param code: HTTP code for the error
+        :params http_error: formatted & parsed error
+        :params url: url/endpoint the exception was raised on
+        :params code: HTTP code for the error
         """
         self.status_code = code
         self.api_code = http_error["code"] if "code" in http_error else None
@@ -33,7 +33,7 @@ def create_error_obj(response: Union[StringDict, str]) -> StringDict:
     """
     Creates an error object based on a requests' payload.
 
-    :param response: response as sent by the server, as a dict.
+    :params response: response as sent by the server, as a dict.
         In _very_ rare instances, this can be an html string.
     """
     if not isinstance(response, str):
@@ -92,8 +92,8 @@ def handle_error(url: str, response: StringDict) -> MindeeHTTPError:
     """
     Creates an appropriate HTTP error exception, based on retrieved HTTP error code.
 
-    :param url: url of the product
-    :param response: StringDict
+    :params url: url of the product
+    :params response: StringDict
     """
     error_obj = create_error_obj(response)
     if not isinstance(response, str) and (  # type: ignore

mindee/error/v2/mindee_http_error_v2.py

@@ -12,7 +12,7 @@ def __init__(self, response: ErrorResponse) -> None:
         """
         Base exception for HTTP calls.
 
-        :param response:
+        :params response:
         """
         self.status = response.status
         self.title = response.title