label-studio-sdk 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

label_studio_sdk/export_storage/redis/client.py

@@ -66,12 +66,15 @@ class RedisClient:
     def create(
         self,
         *,
+        db: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
         host: typing.Optional[str] = OMIT,
         port: typing.Optional[str] = OMIT,
         password: typing.Optional[str] = OMIT,
-        db: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisCreateResponse:
         """
@@ -83,6 +86,18 @@ class RedisClient:
 
         Parameters
         ----------
+        db : typing.Optional[int]
+            Database ID of database to use
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -98,9 +113,6 @@ class RedisClient:
         password : typing.Optional[str]
             Server Password (optional)
 
-        db : typing.Optional[int]
-            Database ID of database to use
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -121,7 +133,17 @@ class RedisClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/storages/export/redis",
             method="POST",
-            json={"project": project, "path": path, "host": host, "port": port, "password": password, "db": db},
+            json={
+                "db": db,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "host": host,
+                "port": port,
+                "password": password,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -133,19 +155,62 @@ class RedisClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def validate(self, *, request_options: typing.Optional[RequestOptions] = None) -> RedisExportStorage:
+    def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        db: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        path: typing.Optional[str] = OMIT,
+        host: typing.Optional[str] = OMIT,
+        port: typing.Optional[str] = OMIT,
+        password: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific Redis export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
         ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        db : typing.Optional[int]
+            Database ID of database to use
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        path : typing.Optional[str]
+            Storage prefix (optional)
+
+        host : typing.Optional[str]
+            Server Host IP (optional)
+
+        port : typing.Optional[str]
+            Server Port (optional)
+
+        password : typing.Optional[str]
+            Server Password (optional)
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        RedisExportStorage
-
+        None
 
         Examples
         --------
@@ -157,10 +222,25 @@ class RedisClient:
         client.export_storage.redis.validate()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/redis/validate", method="POST", request_options=request_options
+            "api/storages/export/redis/validate",
+            method="POST",
+            json={
+                "id": id,
+                "db": db,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "host": host,
+                "port": port,
+                "password": password,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(RedisExportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -252,12 +332,15 @@ class RedisClient:
         self,
         id: int,
         *,
+        db: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
         host: typing.Optional[str] = OMIT,
         port: typing.Optional[str] = OMIT,
         password: typing.Optional[str] = OMIT,
-        db: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisUpdateResponse:
         """
@@ -270,6 +353,18 @@ class RedisClient:
         id : int
             A unique integer value identifying this redis export storage.
 
+        db : typing.Optional[int]
+            Database ID of database to use
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -285,9 +380,6 @@ class RedisClient:
         password : typing.Optional[str]
             Server Password (optional)
 
-        db : typing.Optional[int]
-            Database ID of database to use
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -310,7 +402,17 @@ class RedisClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/storages/export/redis/{jsonable_encoder(id)}",
             method="PATCH",
-            json={"project": project, "path": path, "host": host, "port": port, "password": password, "db": db},
+            json={
+                "db": db,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "host": host,
+                "port": port,
+                "password": password,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -415,12 +517,15 @@ class AsyncRedisClient:
     async def create(
         self,
         *,
+        db: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
         host: typing.Optional[str] = OMIT,
         port: typing.Optional[str] = OMIT,
         password: typing.Optional[str] = OMIT,
-        db: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisCreateResponse:
         """
@@ -432,6 +537,18 @@ class AsyncRedisClient:
 
         Parameters
         ----------
+        db : typing.Optional[int]
+            Database ID of database to use
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -447,9 +564,6 @@ class AsyncRedisClient:
         password : typing.Optional[str]
             Server Password (optional)
 
-        db : typing.Optional[int]
-            Database ID of database to use
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -470,7 +584,17 @@ class AsyncRedisClient:
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/redis",
             method="POST",
-            json={"project": project, "path": path, "host": host, "port": port, "password": password, "db": db},
+            json={
+                "db": db,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "host": host,
+                "port": port,
+                "password": password,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -482,19 +606,62 @@ class AsyncRedisClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def validate(self, *, request_options: typing.Optional[RequestOptions] = None) -> RedisExportStorage:
+    async def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        db: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        path: typing.Optional[str] = OMIT,
+        host: typing.Optional[str] = OMIT,
+        port: typing.Optional[str] = OMIT,
+        password: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific Redis export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.
 
         Parameters
         ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        db : typing.Optional[int]
+            Database ID of database to use
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        path : typing.Optional[str]
+            Storage prefix (optional)
+
+        host : typing.Optional[str]
+            Server Host IP (optional)
+
+        port : typing.Optional[str]
+            Server Port (optional)
+
+        password : typing.Optional[str]
+            Server Password (optional)
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        RedisExportStorage
-
+        None
 
         Examples
         --------
@@ -506,10 +673,25 @@ class AsyncRedisClient:
         await client.export_storage.redis.validate()
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/redis/validate", method="POST", request_options=request_options
+            "api/storages/export/redis/validate",
+            method="POST",
+            json={
+                "id": id,
+                "db": db,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "host": host,
+                "port": port,
+                "password": password,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(RedisExportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -601,12 +783,15 @@ class AsyncRedisClient:
         self,
         id: int,
         *,
+        db: typing.Optional[int] = OMIT,
+        can_delete_objects: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
         host: typing.Optional[str] = OMIT,
         port: typing.Optional[str] = OMIT,
         password: typing.Optional[str] = OMIT,
-        db: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisUpdateResponse:
         """
@@ -619,6 +804,18 @@ class AsyncRedisClient:
         id : int
             A unique integer value identifying this redis export storage.
 
+        db : typing.Optional[int]
+            Database ID of database to use
+
+        can_delete_objects : typing.Optional[bool]
+            Deletion from storage enabled.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -634,9 +831,6 @@ class AsyncRedisClient:
         password : typing.Optional[str]
             Server Password (optional)
 
-        db : typing.Optional[int]
-            Database ID of database to use
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -659,7 +853,17 @@ class AsyncRedisClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/export/redis/{jsonable_encoder(id)}",
             method="PATCH",
-            json={"project": project, "path": path, "host": host, "port": port, "password": password, "db": db},
+            json={
+                "db": db,
+                "can_delete_objects": can_delete_objects,
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "host": host,
+                "port": port,
+                "password": password,
+            },
             request_options=request_options,
             omit=OMIT,
         )

label_studio_sdk/export_storage/redis/types/redis_create_response.py

@@ -8,6 +8,26 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class RedisCreateResponse(pydantic_v1.BaseModel):
+    db: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Database ID of database to use
+    """
+
+    can_delete_objects: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Deletion from storage enabled.
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage description
+    """
+
     project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
     Project ID
@@ -33,11 +53,6 @@ class RedisCreateResponse(pydantic_v1.BaseModel):
     Server Password (optional)
     """
 
-    db: typing.Optional[int] = pydantic_v1.Field(default=None)
-    """
-    Database ID of database to use
-    """
-
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
         return super().json(**kwargs_with_defaults)

label_studio_sdk/export_storage/redis/types/redis_update_response.py

@@ -8,6 +8,26 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class RedisUpdateResponse(pydantic_v1.BaseModel):
+    db: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Database ID of database to use
+    """
+
+    can_delete_objects: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Deletion from storage enabled.
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage description
+    """
+
     project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
     Project ID
@@ -33,11 +53,6 @@ class RedisUpdateResponse(pydantic_v1.BaseModel):
     Server Password (optional)
     """
 
-    db: typing.Optional[int] = pydantic_v1.Field(default=None)
-    """
-    Database ID of database to use
-    """
-
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
         return super().json(**kwargs_with_defaults)