mixpeek 0.8.1__py3-none-any.whl → 0.8.2__py3-none-any.whl

mixpeek/endpoints/index.py

@@ -6,17 +6,19 @@ class Index:
         self.base_url = base_url
         self.headers = headers
 
-    def _prepare_data(self, base_data, metadata=None, settings=None):
+    def _prepare_data(self, base_data, metadata=None, video_settings=None, image_settings=None):
         if metadata is not None:
             base_data["metadata"] = metadata
-        if settings is not None:
-            base_data["settings"] = settings
+        if video_settings is not None:
+            base_data["video_settings"] = video_settings
+        if image_settings is not None:
+            base_data["image_settings"] = image_settings
         return base_data
 
-    def url(self, target_url, collection_id, metadata=None, settings=None):
+    def url(self, target_url, collection_id, metadata=None, video_settings=None, image_settings=None):
         try:
             endpoint = f"{self.base_url}index/url"
-            data = self._prepare_data({"url": target_url, "collection_id": collection_id}, metadata, settings)
+            data = self._prepare_data({"url": target_url, "collection_id": collection_id}, metadata, video_settings, image_settings)
 
             response = requests.post(endpoint, json=data, headers=self.headers)
             response.raise_for_status()

{mixpeek-0.8.1.dist-info → mixpeek-0.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mixpeek
-Version: 0.8.1
+Version: 0.8.2
 Summary: Mixpeek Python SDK
 Home-page: https://github.com/mixpeek/mixpeek-python
 Author: Ethan Steininger
@@ -293,6 +293,58 @@ The `process` method returns a list of dictionaries, each containing:
 
 This tool is particularly useful when you need to embed long videos, as it allows you to process the video in smaller chunks and embed each chunk separately.
 
+### Register
+
+The `register` module provides methods for registering various types of data, such as faces for facial recognition.
+
+#### Face Registration
+
+```python
+from mixpeek import Mixpeek
+
+# Initialize the Mixpeek client
+mixpeek = Mixpeek(api_key="your_api_key_here")
+
+# Path to the local image file containing faces
+face_image_path = "/path/to/your/face_image.jpg"
+
+# Start the face registration task
+task = mixpeek.register.faces(
+    file_path=face_image_path,
+    collection_id="face-recognition-collection",
+    metadata={"name": "John Doe", "age": 30},
+    settings={"detection_threshold": 0.8}
+)
+
+# Define a callback function (optional)
+def on_task_update(status):
+    print(f"Current task status: {status}")
+
+# Wait for the task to complete
+status = task.wait_for_done(
+    sleep_interval=1,
+    callback=on_task_update
+)
+
+print(f"Face registration completed with status: {status}")
+
+# If you want to do something with the final result
+if status.get("status") == "DONE":
+    result = status.get("result")
+    print("Face registration result:", result)
+else:
+    print("Face registration failed or was interrupted")
+```
+
+Parameters for `mixpeek.register.faces`:
+
+- `file_path` (str): Path to the local image file containing faces to register.
+- `collection_id` (str): The ID of the collection to add the registered faces to.
+- `metadata` (dict, optional): Additional metadata for the registered faces.
+- `settings` (dict, optional): Processing settings for face registration.
+
+The `faces` method returns a `Task` object that allows you to monitor the progress of the face registration process.
+
 ## Response Format
 
 All methods return a JSON response. In case of an error, the response will contain an "error" key with a description of the error.

{mixpeek-0.8.1.dist-info → mixpeek-0.8.2.dist-info}/RECORD

@@ -4,12 +4,12 @@ mixpeek/exceptions.py,sha256=Orhdo5UFLn3fcWVJtlgkznW8Iy5ndL96h0qTY8zOlDA,235
 mixpeek/endpoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mixpeek/endpoints/collections.py,sha256=-mxmI4Bs60OH6HRPzE03rr0XVnzqUxL_iHgF-_4R6Qc,3232
 mixpeek/endpoints/embed.py,sha256=ybDqyIt0oJiwIdH1QSwuV-CPeJgd-zW0etNAcBdgZYE,2290
-mixpeek/endpoints/index.py,sha256=kG5bf0ycIWvooicA5xowXrWH4x6nbzP6XdyK-XQHqU0,1976
+mixpeek/endpoints/index.py,sha256=MGwhQSkJqstu-TtlefwwREhu7dfA5kYam2MD2B69Rbc,2166
 mixpeek/endpoints/register.py,sha256=ZVes4BPxQsPRNk70tGeVe_CYr4eVQKL-CTVmzpJAHM4,1314
 mixpeek/endpoints/search.py,sha256=u3onbss7Llx0AgcTSRtel6bGO5Ly3jvraXPcA26GzsY,2387
 mixpeek/endpoints/tasks.py,sha256=GBkscCYVv46JkJ4MVOtM6tL__rymnM3bmt4PrdRK04Y,839
 mixpeek/endpoints/tools.py,sha256=T8qb9zngY3V_vwtmBBrTqPvqZl1QIL8q3at3UGIj4bg,4709
-mixpeek-0.8.1.dist-info/METADATA,sha256=aCVFiT_BXaKmv-DydThZYI6HJhgpcaeg1NXnFwN-9vk,10616
-mixpeek-0.8.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-mixpeek-0.8.1.dist-info/top_level.txt,sha256=EJ8Jc4IhqyUwnUlBwKbs498Ju4O9a-IDh2kXc_lo6Vg,8
-mixpeek-0.8.1.dist-info/RECORD,,
+mixpeek-0.8.2.dist-info/METADATA,sha256=2g-yVma_tM5bb7WdQh6dyL9_YHgrB9XHw1eCQIdeKFs,12223
+mixpeek-0.8.2.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+mixpeek-0.8.2.dist-info/top_level.txt,sha256=EJ8Jc4IhqyUwnUlBwKbs498Ju4O9a-IDh2kXc_lo6Vg,8
+mixpeek-0.8.2.dist-info/RECORD,,