dataroom-client 1.0.6.post149.dev0__tar.gz → 1.0.6.post200.dev0__tar.gz

{dataroom_client-1.0.6.post149.dev0 → dataroom_client-1.0.6.post200.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataroom-client
-Version: 1.0.6.post149.dev0
+Version: 1.0.6.post200.dev0
 Summary: A python client to interface with the Dataroom backend API
 Author: Ales Kocjancic
 Author-email: hi@ales.io

{dataroom_client-1.0.6.post149.dev0 → dataroom_client-1.0.6.post200.dev0}/dataroom_client/client.py

@@ -353,6 +353,7 @@ class DataRoomClient:
         datasets__all: list = None,
         datasets__ne_all: list = None,
         datasets__empty: bool = None,
+        query: str = None,
         group_ids: list[str] = None,
         roles: list[str] = None,
         group_type: str = None,
@@ -440,6 +441,7 @@ class DataRoomClient:
                     "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,
+                    "query": query,
                     "group_ids": ",".join(group_ids) if group_ids else None,
                     "roles": ",".join(roles) if roles else None,
                     "group_type": group_type,
@@ -507,6 +509,7 @@ class DataRoomClient:
         datasets__all: list = None,
         datasets__ne_all: list = None,
         datasets__empty: bool = None,
+        query: str = None,
     ) -> AsyncIterable[dict]:
         """
         Retrieves an iterator of images, with optional filtering and field selection.
@@ -593,6 +596,7 @@ class DataRoomClient:
                     "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,
+                    "query": query,
                 }
             ),
             headers=headers,
@@ -658,6 +662,7 @@ class DataRoomClient:
         datasets__all: list = None,
         datasets__ne_all: list = None,
         datasets__empty: bool = None,
+        query: str = None,
     ) -> list[dict]:
         """
         Get a list of random images.
@@ -747,6 +752,7 @@ class DataRoomClient:
                     "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,
+                    "query": query,
                 }
             ),
             headers=headers,
@@ -803,6 +809,7 @@ class DataRoomClient:
         datasets__all: list = None,
         datasets__ne_all: list = None,
         datasets__empty: bool = None,
+        query: str = None,
     ) -> int:
         """
         Returns the total count of images based on the provided filters.
@@ -868,6 +875,7 @@ class DataRoomClient:
                     "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,
+                    "query": query,
                 }
             ),
         )
@@ -1324,6 +1332,7 @@ class DataRoomClient:
         datasets__all: list = None,
         datasets__ne_all: list = None,
         datasets__empty: bool = None,
+        query: str = None,
     ) -> list[dict]:
         """
         Finds images similar to a given image, vector, or text query.
@@ -1402,6 +1411,7 @@ class DataRoomClient:
             "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,
+            "query": query,
         })
 
         if image_file:
@@ -1999,6 +2009,77 @@ class DataRoomClient:
         """
         return await self._make_request(url=f"images/{image_id}/groups/", method="GET")
 
+    # -------------------- Query API methods --------------------
+
+    async def get_queries(self, limit: int = 1000) -> list[dict]:
+        """
+        Retrieves a list of queries.
+
+        @param limit: The maximum number of queries to return.
+        @return: A list of query dictionaries.
+        """
+        return await self._make_paginated_request(
+            url="queries/",
+            limit=limit,
+        )
+
+    async def get_query(self, slug: str) -> dict:
+        """
+        Retrieves a single query by its slug.
+
+        @param slug: The identifier for the query (e.g., "my-query").
+        @return: A dictionary representing the query.
+        """
+        return await self._make_request(
+            url=f"queries/{slug}/",
+        )
+
+    async def create_query(self, slug: str, name: str, filters: dict, description: str | None = None) -> dict:
+        """
+        Creates a new query.
+
+        @param slug: The identifier for the query (e.g., "my-query").
+        @param name: The display name of the query.
+        @param filters: The filters for the query.
+        @param description: An optional description for the query.
+        @return: A dictionary representing the newly created query.
+        """
+        return await self._make_request(
+            url="queries/",
+            method="POST",
+            json={
+                "slug": slug,
+                "name": name,
+                "description": description if description else "",
+                "filters": filters,
+            },
+        )
+
+    async def update_query(
+        self, slug: str, name: str | None = None, description: str | None = None, filters: dict | None = None
+    ) -> dict:
+        """
+        Updates a query.
+
+        @param slug: The identifier for the query (e.g., "my-query").
+        @param name: The display name of the query.
+        @param description: An optional description for the query.
+        @param filters: The filters for the query.
+        @return: A dictionary representing the updated query.
+        """
+        return await self._make_request(
+            url=f"queries/{slug}/",
+            method="PUT",
+            json=self._dict_filter_none(
+                {
+                    "slug": slug,
+                    "name": name,
+                    "description": description,
+                    "filters": filters,
+                }
+            ),
+        )
+
 
 class AsyncRunner:
     """

{dataroom_client-1.0.6.post149.dev0 → dataroom_client-1.0.6.post200.dev0}/pyproject.toml

@@ -6,7 +6,7 @@ authors = [
 ]
 readme = "README.md"
 dynamic = []
-version = "1.0.6.post149.dev0"
+version = "1.0.6.post200.dev0"
 
 [tool.poetry]