dataroom-client 1.0.1.post13.dev0__tar.gz → 1.0.1.post49.dev0__tar.gz

{dataroom_client-1.0.1.post13.dev0 → dataroom_client-1.0.1.post49.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dataroom-client
-Version: 1.0.1.post13.dev0
+Version: 1.0.1.post49.dev0
 Summary: A python client to interface with the Dataroom backend API
 Author: Ales Kocjancic
 Author-email: hi@ales.io
@@ -38,5 +38,5 @@ For more examples see [client_example.ipynb](./notebooks/client_example.ipynb).
 
 # Developing
 
-Check out the `dataroom` repo and follow the instructions in the README.
+Follow the instructions in the main [README](../README.md).
 

{dataroom_client-1.0.1.post13.dev0 → dataroom_client-1.0.1.post49.dev0}/README.md

@@ -23,4 +23,4 @@ For more examples see [client_example.ipynb](./notebooks/client_example.ipynb).
 
 # Developing
 
-Check out the `dataroom` repo and follow the instructions in the README.
+Follow the instructions in the main [README](../README.md).

{dataroom_client-1.0.1.post13.dev0 → dataroom_client-1.0.1.post49.dev0}/dataroom_client/client.py

@@ -87,6 +87,7 @@ class ImageUpdate(TypedDict, total=False):
     tags: Optional[List[str]]
     coca_embedding: Optional[str]
     related_images: Optional[dict[str, str]]
+    datasets: Optional[list[str]]
 
 
 class ImageCreate(TypedDict, total=False):
@@ -97,6 +98,7 @@ class ImageCreate(TypedDict, total=False):
     attributes: Optional[dict]
     tags: Optional[list[str]]
     related_images: Optional[dict[str, str]]
+    datasets: Optional[list[str]]
 
 
 def arg_deprecation_msg(arg_name, msg=''):
@@ -305,6 +307,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
         headers = {}
         if cache_ttl:
@@ -368,6 +375,11 @@ class DataRoomClient:
                     "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
                     "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
                     "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+                    "datasets": ",".join(datasets) if datasets else None,
+                    "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+                    "datasets__all": ",".join(datasets__all) if datasets__all else None,
+                    "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+                    "datasets__empty": datasets__empty,
                 }
             ),
             headers=headers,
@@ -427,6 +439,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
         headers = {}
         if cache_ttl:
@@ -490,6 +507,11 @@ class DataRoomClient:
                     "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
                     "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
                     "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+                    "datasets": ",".join(datasets) if datasets else None,
+                    "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+                    "datasets__all": ",".join(datasets__all) if datasets__all else None,
+                    "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+                    "datasets__empty": datasets__empty,
                 }
             ),
             headers=headers,
@@ -550,6 +572,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
         """
         Get a list of random images.
@@ -621,6 +648,11 @@ class DataRoomClient:
                     "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
                     "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
                     "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+                    "datasets": ",".join(datasets) if datasets else None,
+                    "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+                    "datasets__all": ",".join(datasets__all) if datasets__all else None,
+                    "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+                    "datasets__empty": datasets__empty,
                 }
             ),
             headers=headers,
@@ -672,6 +704,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
 
         if source is not None:
@@ -725,6 +762,11 @@ class DataRoomClient:
                     "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
                     "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
                     "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+                    "datasets": ",".join(datasets) if datasets else None,
+                    "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+                    "datasets__all": ",".join(datasets__all) if datasets__all else None,
+                    "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+                    "datasets__empty": datasets__empty,
                 }
             ),
         )
@@ -759,6 +801,7 @@ class DataRoomClient:
         attributes: dict = None,
         tags: list[str] = None,
         related_images: dict[str, str] | None = None,
+        datasets: list[str] = None,
     ):
         if not image_file and not image_url:
             raise DataRoomError('Please provide either an "image_file" or "image_url" field')
@@ -777,6 +820,7 @@ class DataRoomClient:
                 "attributes": attributes,
                 "tags": tags,
                 "related_images": related_images,
+                "datasets": datasets,
             }
         )
 
@@ -836,6 +880,7 @@ class DataRoomClient:
                 "attributes": image.get('attributes'),
                 "tags": image.get('tags'),
                 "related_images": image.get('related_images'),
+                "datasets": image.get('datasets'),
             })
             files.append((
                 f"json_{i}",
@@ -853,9 +898,15 @@ class DataRoomClient:
         tags: list[str] = None,
         coca_embedding: str = None,
         related_images: dict[str, str] | None = None,
+        datasets: list[str] = None,
     ):
         """
-        Update the image, overwriting the tags and merging attributes, latents and related_images.
+        Update the image:
+         * overwrite tags
+         * merge attributes
+         * merge latents
+         * merge related_images
+         * merge datasets
         """
 
         if coca_embedding:
@@ -895,6 +946,7 @@ class DataRoomClient:
                 "tags": tags,
                 "coca_embedding": coca_embedding,
                 "related_images": related_images,
+                "datasets": datasets,
             })
             files.append((
                 "json",
@@ -911,6 +963,7 @@ class DataRoomClient:
                     "tags": tags,
                     "coca_embedding": coca_embedding,
                     "related_images": related_images,
+                    "datasets": datasets,
                 }),
             )
 
@@ -919,7 +972,12 @@ class DataRoomClient:
         images: List[ImageUpdate],
     ):
         """
-        Bulk update images, overwriting the tags and merging attributes, latents and related_images.
+        Bulk update images:
+         * overwrite tags
+         * merge attributes
+         * merge latents
+         * merge related_images
+         * merge datasets
         """
         for image in images:
             if 'id' not in image:
@@ -929,6 +987,7 @@ class DataRoomClient:
             image.setdefault('tags', None)
             image.setdefault('coca_embedding', None)
             image.setdefault('related_images', None)
+            image.setdefault('datasets', None)
         
         return await self._make_request(
             url=f"images/bulk_update/",
@@ -941,6 +1000,7 @@ class DataRoomClient:
                     "tags": image['tags'],
                     "coca_embedding": image['coca_embedding'],
                     "related_images": image['related_images'],
+                    "datasets": image['datasets'],
                 })
                 for image in images
             ],
@@ -1064,6 +1124,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
         search_args = {
             'image_id': image_id, 'image_file': image_file, 'image_vector': image_vector, 'image_text': image_text,
@@ -1118,6 +1183,11 @@ class DataRoomClient:
             "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
             "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
             "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+            "datasets": ",".join(datasets) if datasets else None,
+            "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+            "datasets__all": ",".join(datasets__all) if datasets__all else None,
+            "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+            "datasets__empty": datasets__empty,
         })
 
         if image_file:
@@ -1312,6 +1382,63 @@ class DataRoomClient:
             },
         )
 
+    # -------------------- Dataset API methods --------------------
+
+    async def get_datasets(self, slug: str = None, limit: int = 1000):
+        return await self._make_paginated_request(
+            url=f"datasets/",
+            params=self._dict_filter_none({
+                "slug": slug,
+            }),
+            limit=limit,
+        )
+
+    async def get_dataset(self, slug_version: str):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/",
+        )
+
+    async def create_dataset(self, name: str, slug: str, description: str = None):
+        return await self._make_request(
+            url=f"datasets/",
+            method="POST",
+            json={
+                "name": name,
+                "slug": slug,
+                "description": description if description else "",
+            },
+        )
+    
+    async def freeze_dataset(self, slug_version: str):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/freeze/",
+            method="POST",
+        )
+    
+    async def unfreeze_dataset(self, slug_version: str):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/unfreeze/",
+            method="POST",
+        )
+
+    async def dataset_add_images(self, slug_version: str, image_ids: List[str]):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/images/",
+            method="POST",
+            json={
+                "image_ids": image_ids,
+            },
+        )
+
+    async def dataset_remove_images(self, slug_version: str, image_ids: List[str]):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/images/",
+            method="DELETE",
+            json={
+                "image_ids": image_ids,
+            },
+        )
+
 
 class DataRoomClientSync:
     """
@@ -1392,6 +1519,9 @@ class DataRoomClientSync:
     def get_image_similarity(self, *args, **kwargs):
         return self._run_sync(self._async_client.get_image_similarity(*args, **kwargs))
 
+    def get_related_images(self, *args, **kwargs):
+        return self._run_sync(self._async_client.get_related_images(*args, **kwargs))
+
     def get_similar_images(self, *args, **kwargs):
         return self._run_sync(self._async_client.get_similar_images(*args, **kwargs))
 
@@ -1436,6 +1566,29 @@ class DataRoomClientSync:
     def tag_images(self, *args, **kwargs):
         return self._run_sync(self._async_client.tag_images(*args, **kwargs))
 
+    # -------------------- Dataset API methods --------------------
+
+    def get_datasets(self, *args, **kwargs):
+        return self._run_sync(self._async_client.get_datasets(*args, **kwargs))
+
+    def get_dataset(self, *args, **kwargs):
+        return self._run_sync(self._async_client.get_dataset(*args, **kwargs))
+
+    def create_dataset(self, *args, **kwargs):
+        return self._run_sync(self._async_client.create_dataset(*args, **kwargs))
+    
+    def freeze_dataset(self, *args, **kwargs):
+        return self._run_sync(self._async_client.freeze_dataset(*args, **kwargs))
+    
+    def unfreeze_dataset(self, *args, **kwargs):
+        return self._run_sync(self._async_client.unfreeze_dataset(*args, **kwargs))
+
+    def dataset_add_images(self, *args, **kwargs):
+        return self._run_sync(self._async_client.dataset_add_images(*args, **kwargs))
+
+    def dataset_remove_images(self, *args, **kwargs):
+        return self._run_sync(self._async_client.dataset_remove_images(*args, **kwargs))
+
 
 for method_name in dir(DataRoomClient):
     if not method_name.startswith("_"):

{dataroom_client-1.0.1.post13.dev0 → dataroom_client-1.0.1.post49.dev0}/pyproject.toml

@@ -6,7 +6,7 @@ authors = [
 ]
 readme = "README.md"
 dynamic = []
-version = "1.0.1.post13.dev0"
+version = "1.0.1.post49.dev0"
 
 [tool.poetry]