label-studio-sdk 1.0.8__py3-none-any.whl → 1.0.11__py3-none-any.whl

label_studio_sdk/export_storage/redis/client.py

@@ -1,16 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from json.decoder import JSONDecodeError
-
-from ...core.api_error import ApiError
-from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ...core.jsonable_encoder import jsonable_encoder
-from ...core.pydantic_utilities import pydantic_v1
+from ...core.client_wrapper import SyncClientWrapper
 from ...core.request_options import RequestOptions
 from ...types.redis_export_storage import RedisExportStorage
+from ...core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
 from .types.redis_create_response import RedisCreateResponse
+from ...core.jsonable_encoder import jsonable_encoder
 from .types.redis_update_response import RedisUpdateResponse
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -24,6 +24,7 @@ class RedisClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[RedisExportStorage]:
         """
+
         You can connect your Redis database to Label Studio as a source storage or target storage. Use this API request to get a list of all Redis export (target) storage connections for a specific project.
 
         The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list).
@@ -45,7 +46,7 @@ class RedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -53,11 +54,22 @@ class RedisClient:
         client.export_storage.redis.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/redis", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/redis",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[RedisExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[RedisExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[RedisExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -78,6 +90,7 @@ class RedisClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisCreateResponse:
         """
+
         Create a new target storage connection to Redis.
 
         For information about the required fields and prerequisites, see [Redis database](https://labelstud.io/guide/storage#Redis-database) in the Label Studio documentation.
@@ -123,7 +136,7 @@ class RedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -144,12 +157,21 @@ class RedisClient:
                 "port": port,
                 "password": password,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RedisCreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    RedisCreateResponse,
+                    parse_obj_as(
+                        type_=RedisCreateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -171,6 +193,7 @@ class RedisClient:
         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
@@ -214,7 +237,7 @@ class RedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -236,6 +259,9 @@ class RedisClient:
                 "port": port,
                 "password": password,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -249,6 +275,7 @@ class RedisClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> RedisExportStorage:
         """
+
         Get a specific Redis export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -268,7 +295,7 @@ class RedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -278,11 +305,19 @@ class RedisClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/redis/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/redis/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RedisExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    RedisExportStorage,
+                    parse_obj_as(
+                        type_=RedisExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -290,6 +325,7 @@ class RedisClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific Redis export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         Deleting an export/target storage connection does not affect tasks with synced data in Label Studio. If you want to remove the tasks that were synced from the external storage, you will need to delete them manually from within the Label Studio UI or use the [Delete tasks](../../tasks/delete-all-tasks) API.
@@ -308,7 +344,7 @@ class RedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -318,7 +354,9 @@ class RedisClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/redis/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/redis/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -344,6 +382,7 @@ class RedisClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisUpdateResponse:
         """
+
         Update a specific Redis export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -390,7 +429,7 @@ class RedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -413,19 +452,29 @@ class RedisClient:
                 "port": port,
                 "password": password,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RedisUpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    RedisUpdateResponse,
+                    parse_obj_as(
+                        type_=RedisUpdateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def sync(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> RedisExportStorage:
+    def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> RedisExportStorage:
         """
+
         Sync tasks to an Redis export/target storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         Sync operations with external databases only go one way. They either create tasks from objects in the database (source/import storage) or push annotations to the output database (export/target storage). Changing something on the database side doesn’t guarantee consistency in results.
@@ -434,7 +483,7 @@ class RedisClient:
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -446,21 +495,29 @@ class RedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.export_storage.redis.sync(
-            id="id",
+            id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/export/redis/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/export/redis/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RedisExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    RedisExportStorage,
+                    parse_obj_as(
+                        type_=RedisExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -475,6 +532,7 @@ class AsyncRedisClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[RedisExportStorage]:
         """
+
         You can connect your Redis database to Label Studio as a source storage or target storage. Use this API request to get a list of all Redis export (target) storage connections for a specific project.
 
         The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list).
@@ -496,19 +554,38 @@ class AsyncRedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.export_storage.redis.list()
+
+
+        async def main() -> None:
+            await client.export_storage.redis.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/redis", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/export/redis",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[RedisExportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[RedisExportStorage],
+                    parse_obj_as(
+                        type_=typing.List[RedisExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -529,6 +606,7 @@ class AsyncRedisClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisCreateResponse:
         """
+
         Create a new target storage connection to Redis.
 
         For information about the required fields and prerequisites, see [Redis database](https://labelstud.io/guide/storage#Redis-database) in the Label Studio documentation.
@@ -574,12 +652,20 @@ class AsyncRedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.export_storage.redis.create()
+
+
+        async def main() -> None:
+            await client.export_storage.redis.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/redis",
@@ -595,12 +681,21 @@ class AsyncRedisClient:
                 "port": port,
                 "password": password,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RedisCreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    RedisCreateResponse,
+                    parse_obj_as(
+                        type_=RedisCreateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -622,6 +717,7 @@ class AsyncRedisClient:
         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
@@ -665,12 +761,20 @@ class AsyncRedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.export_storage.redis.validate()
+
+
+        async def main() -> None:
+            await client.export_storage.redis.validate()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/redis/validate",
@@ -687,6 +791,9 @@ class AsyncRedisClient:
                 "port": port,
                 "password": password,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -700,6 +807,7 @@ class AsyncRedisClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> RedisExportStorage:
         """
+
         Get a specific Redis export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -719,21 +827,37 @@ class AsyncRedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.export_storage.redis.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.redis.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/redis/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/export/redis/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RedisExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    RedisExportStorage,
+                    parse_obj_as(
+                        type_=RedisExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -741,6 +865,7 @@ class AsyncRedisClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific Redis export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         Deleting an export/target storage connection does not affect tasks with synced data in Label Studio. If you want to remove the tasks that were synced from the external storage, you will need to delete them manually from within the Label Studio UI or use the [Delete tasks](../../tasks/delete-all-tasks) API.
@@ -759,17 +884,27 @@ class AsyncRedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.export_storage.redis.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.redis.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/redis/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/export/redis/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -795,6 +930,7 @@ class AsyncRedisClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisUpdateResponse:
         """
+
         Update a specific Redis export storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -841,14 +977,22 @@ class AsyncRedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.export_storage.redis.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.redis.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/export/redis/{jsonable_encoder(id)}",
@@ -864,19 +1008,29 @@ class AsyncRedisClient:
                 "port": port,
                 "password": password,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RedisUpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    RedisUpdateResponse,
+                    parse_obj_as(
+                        type_=RedisUpdateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def sync(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> RedisExportStorage:
+    async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> RedisExportStorage:
         """
+
         Sync tasks to an Redis export/target storage connection. You will need to provide the export storage ID. You can find this using [List export storages](list).
 
         Sync operations with external databases only go one way. They either create tasks from objects in the database (source/import storage) or push annotations to the output database (export/target storage). Changing something on the database side doesn’t guarantee consistency in results.
@@ -885,7 +1039,7 @@ class AsyncRedisClient:
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -897,21 +1051,37 @@ class AsyncRedisClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.export_storage.redis.sync(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.export_storage.redis.sync(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/export/redis/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/export/redis/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RedisExportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    RedisExportStorage,
+                    parse_obj_as(
+                        type_=RedisExportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)