💥 ♻️ harmonize v1 and v2 namespaces with other client libraries

.gitignore

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

docs/extras/code_samples/bank_account_details_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/bank_account_details_v2.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/bank_check_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/barcode_reader_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/carte_grise_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/cropper_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/custom_v1.txt

@@ -1,4 +1,4 @@
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/default.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/default_async.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, AsyncPredictResponse, product
+from mindee.v1 import Client, AsyncPredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/expense_receipts_v5.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/expense_receipts_v5_async.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, product, AsyncPredictResponse
+from mindee.v1 import Client, product, AsyncPredictResponse
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/financial_document_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/financial_document_v1_async.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, product, AsyncPredictResponse
+from mindee.v1 import Client, product, AsyncPredictResponse
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/idcard_fr_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/idcard_fr_v2.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/international_id_v2_async.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, product, AsyncPredictResponse
+from mindee.v1 import Client, product, AsyncPredictResponse
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/invoice_splitter_v1_async.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, product, AsyncPredictResponse
+from mindee.v1 import Client, product, AsyncPredictResponse
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/invoices_v4.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/invoices_v4_async.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, product, AsyncPredictResponse
+from mindee.v1 import Client, product, AsyncPredictResponse
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/multi_receipts_detector_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/passport_v1.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

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(

docs/extras/code_samples/workflow_execution.txt

@@ -3,8 +3,8 @@
 # pip install mindee
 #
 
-from mindee import Client, WorkflowResponse
-from mindee.parsing.common import ExecutionPriority
+from mindee.v1 import Client, WorkflowResponse
+from mindee.v1.parsing.common import ExecutionPriority
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

docs/extras/code_samples/workflow_ots_rag.txt

@@ -3,7 +3,7 @@
 # pip install mindee
 #
 
-from mindee import Client, product, AsyncPredictResponse
+from mindee.v1 import Client, product, AsyncPredictResponse
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")

examples/auto_invoice_splitter_extraction_example.py

@@ -1,8 +1,8 @@
-from mindee import Client
+from mindee.v1.client import Client
 from mindee.extraction.pdf_extractor import PdfExtractor
-from mindee.input.sources.path_input import PathInput
-from mindee.product.invoice.invoice_v4 import InvoiceV4
-from mindee.product.invoice_splitter.invoice_splitter_v1 import InvoiceSplitterV1
+from mindee.input.path_input import PathInput
+from mindee.v1.product.invoice.invoice_v4 import InvoiceV4
+from mindee.v1.product.invoice_splitter.invoice_splitter_v1 import InvoiceSplitterV1
 
 mindee_client = Client(api_key="my-api-key")
 # mindee_client = Client()  # Optionally, set from env.

examples/auto_multi_receipts_extraction_example.py

@@ -1,4 +1,5 @@
-from mindee import Client, product
+from mindee.v1.client import Client
+from mindee.v1 import product
 from mindee.extraction.multi_receipts_extractor.multi_receipts_extractor import (
     extract_receipts,
 )

examples/custom_line_items_reconstruction.py

@@ -1,7 +1,8 @@
 import os
 
-from mindee import Client, product
-from mindee.parsing.common.predict_response import PredictResponse
+from mindee.v1.client import Client
+from mindee.v1 import product
+from mindee.v1.parsing.common import PredictResponse
 
 CUSTOM_ENDPOINT_NAME = os.getenv("CUSTOM_ENDPOINT_NAME", "my-endpoint-name")
 CUSTOM_ACCOUNT_NAME = os.getenv("CUSTOM_ACCOUNT_NAME", "my-account-name")

examples/display_cropping.py

@@ -15,8 +15,9 @@
 import cv2
 import numpy as np
 
-from mindee import Client, product
-from mindee.parsing.common.predict_response import PredictResponse
+from mindee.v1.client import Client
+from mindee.v1 import product
+from mindee.v1.parsing.common import PredictResponse
 
 
 def relative_to_pixel_pos(polygon, image_h: int, image_w: int) -> List[Tuple[int, int]]: