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

label_studio_sdk/import_storage/redis/client.py

@@ -66,13 +66,15 @@ class RedisClient:
     def create(
         self,
         *,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: 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,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisCreateResponse:
         """
@@ -84,6 +86,18 @@ class RedisClient:
 
         Parameters
         ----------
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -99,12 +113,6 @@ class RedisClient:
         password : typing.Optional[str]
             Server Password (optional)
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -126,13 +134,15 @@ class RedisClient:
             "api/storages/redis/",
             method="POST",
             json={
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "title": title,
+                "description": description,
                 "project": project,
                 "path": path,
                 "host": host,
                 "port": port,
                 "password": password,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
             },
             request_options=request_options,
             omit=OMIT,
@@ -145,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) -> RedisImportStorage:
+    def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: 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 import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
         ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        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
         -------
-        RedisImportStorage
-
+        None
 
         Examples
         --------
@@ -169,10 +222,25 @@ class RedisClient:
         client.import_storage.redis.validate()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/redis/validate", method="POST", request_options=request_options
+            "api/storages/redis/validate",
+            method="POST",
+            json={
+                "id": id,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "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(RedisImportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -266,13 +334,15 @@ class RedisClient:
         self,
         id: int,
         *,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: 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,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisUpdateResponse:
         """
@@ -285,6 +355,18 @@ class RedisClient:
         id : int
             A unique integer value identifying this redis import storage.
 
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -300,12 +382,6 @@ class RedisClient:
         password : typing.Optional[str]
             Server Password (optional)
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -329,13 +405,15 @@ class RedisClient:
             f"api/storages/redis/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "title": title,
+                "description": description,
                 "project": project,
                 "path": path,
                 "host": host,
                 "port": port,
                 "password": password,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
             },
             request_options=request_options,
             omit=OMIT,
@@ -442,13 +520,15 @@ class AsyncRedisClient:
     async def create(
         self,
         *,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: 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,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisCreateResponse:
         """
@@ -460,6 +540,18 @@ class AsyncRedisClient:
 
         Parameters
         ----------
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -475,12 +567,6 @@ class AsyncRedisClient:
         password : typing.Optional[str]
             Server Password (optional)
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -502,13 +588,15 @@ class AsyncRedisClient:
             "api/storages/redis/",
             method="POST",
             json={
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "title": title,
+                "description": description,
                 "project": project,
                 "path": path,
                 "host": host,
                 "port": port,
                 "password": password,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
             },
             request_options=request_options,
             omit=OMIT,
@@ -521,19 +609,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) -> RedisImportStorage:
+    async def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: 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 import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
         ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        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
         -------
-        RedisImportStorage
-
+        None
 
         Examples
         --------
@@ -545,10 +676,25 @@ class AsyncRedisClient:
         await client.import_storage.redis.validate()
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/redis/validate", method="POST", request_options=request_options
+            "api/storages/redis/validate",
+            method="POST",
+            json={
+                "id": id,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "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(RedisImportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -642,13 +788,15 @@ class AsyncRedisClient:
         self,
         id: int,
         *,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: 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,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RedisUpdateResponse:
         """
@@ -661,6 +809,18 @@ class AsyncRedisClient:
         id : int
             A unique integer value identifying this redis import storage.
 
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -676,12 +836,6 @@ class AsyncRedisClient:
         password : typing.Optional[str]
             Server Password (optional)
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -705,13 +859,15 @@ class AsyncRedisClient:
             f"api/storages/redis/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "title": title,
+                "description": description,
                 "project": project,
                 "path": path,
                 "host": host,
                 "port": port,
                 "password": password,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
             },
             request_options=request_options,
             omit=OMIT,

label_studio_sdk/import_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):
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+    """
+
+    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,16 +53,6 @@ class RedisCreateResponse(pydantic_v1.BaseModel):
     Server Password (optional)
     """
 
-    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
-    """
-    Cloud storage regex for filtering objects
-    """
-
-    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
-    """
-    Interpret objects as BLOBs and generate URLs
-    """
-
     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/import_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):
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+    """
+
+    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,16 +53,6 @@ class RedisUpdateResponse(pydantic_v1.BaseModel):
     Server Password (optional)
     """
 
-    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
-    """
-    Cloud storage regex for filtering objects
-    """
-
-    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
-    """
-    Interpret objects as BLOBs and generate URLs
-    """
-
     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)