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

label_studio_sdk/export_storage/local/client.py

@@ -66,6 +66,8 @@ class LocalClient:
     def create(
         self,
         *,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
@@ -81,17 +83,23 @@ class LocalClient:
 
         Parameters
         ----------
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
         path : typing.Optional[str]
-            Local path
+            Path to local directory
 
         regex_filter : typing.Optional[str]
             Regex for filtering objects
 
         use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
+            Interpret objects as BLOBs and generate URLs. For example, if your directory 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.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -113,7 +121,14 @@ class LocalClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/storages/export/localfiles",
             method="POST",
-            json={"project": project, "path": path, "regex_filter": regex_filter, "use_blob_urls": use_blob_urls},
+            json={
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -125,19 +140,50 @@ class LocalClient:
             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) -> LocalFilesExportStorage:
+    def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        path: typing.Optional[str] = OMIT,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific local file 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
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        path : typing.Optional[str]
+            Path to local directory
+
+        regex_filter : typing.Optional[str]
+            Regex for filtering objects
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your directory 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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        LocalFilesExportStorage
-
+        None
 
         Examples
         --------
@@ -149,10 +195,22 @@ class LocalClient:
         client.export_storage.local.validate()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/localfiles/validate", method="POST", request_options=request_options
+            "api/storages/export/localfiles/validate",
+            method="POST",
+            json={
+                "id": id,
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(LocalFilesExportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -244,6 +302,8 @@ class LocalClient:
         self,
         id: int,
         *,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
@@ -260,17 +320,23 @@ class LocalClient:
         id : int
             A unique integer value identifying this local files export storage.
 
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
         path : typing.Optional[str]
-            Local path
+            Path to local directory
 
         regex_filter : typing.Optional[str]
             Regex for filtering objects
 
         use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
+            Interpret objects as BLOBs and generate URLs. For example, if your directory 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.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -294,7 +360,14 @@ class LocalClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/storages/export/localfiles/{jsonable_encoder(id)}",
             method="PATCH",
-            json={"project": project, "path": path, "regex_filter": regex_filter, "use_blob_urls": use_blob_urls},
+            json={
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -401,6 +474,8 @@ class AsyncLocalClient:
     async def create(
         self,
         *,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
@@ -416,17 +491,23 @@ class AsyncLocalClient:
 
         Parameters
         ----------
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
         path : typing.Optional[str]
-            Local path
+            Path to local directory
 
         regex_filter : typing.Optional[str]
             Regex for filtering objects
 
         use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
+            Interpret objects as BLOBs and generate URLs. For example, if your directory 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.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -448,7 +529,14 @@ class AsyncLocalClient:
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/localfiles",
             method="POST",
-            json={"project": project, "path": path, "regex_filter": regex_filter, "use_blob_urls": use_blob_urls},
+            json={
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -460,19 +548,50 @@ class AsyncLocalClient:
             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) -> LocalFilesExportStorage:
+    async def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        path: typing.Optional[str] = OMIT,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific local file 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
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        path : typing.Optional[str]
+            Path to local directory
+
+        regex_filter : typing.Optional[str]
+            Regex for filtering objects
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your directory 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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        LocalFilesExportStorage
-
+        None
 
         Examples
         --------
@@ -484,10 +603,22 @@ class AsyncLocalClient:
         await client.export_storage.local.validate()
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/localfiles/validate", method="POST", request_options=request_options
+            "api/storages/export/localfiles/validate",
+            method="POST",
+            json={
+                "id": id,
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(LocalFilesExportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -579,6 +710,8 @@ class AsyncLocalClient:
         self,
         id: int,
         *,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
@@ -595,17 +728,23 @@ class AsyncLocalClient:
         id : int
             A unique integer value identifying this local files export storage.
 
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
         path : typing.Optional[str]
-            Local path
+            Path to local directory
 
         regex_filter : typing.Optional[str]
             Regex for filtering objects
 
         use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
+            Interpret objects as BLOBs and generate URLs. For example, if your directory 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.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -629,7 +768,14 @@ class AsyncLocalClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/export/localfiles/{jsonable_encoder(id)}",
             method="PATCH",
-            json={"project": project, "path": path, "regex_filter": regex_filter, "use_blob_urls": use_blob_urls},
+            json={
+                "title": title,
+                "description": description,
+                "project": project,
+                "path": path,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+            },
             request_options=request_options,
             omit=OMIT,
         )

label_studio_sdk/export_storage/local/types/local_create_response.py

@@ -8,6 +8,16 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class LocalCreateResponse(pydantic_v1.BaseModel):
+    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
@@ -15,7 +25,7 @@ class LocalCreateResponse(pydantic_v1.BaseModel):
 
     path: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Local path
+    Path to local directory
     """
 
     regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
@@ -25,7 +35,7 @@ class LocalCreateResponse(pydantic_v1.BaseModel):
 
     use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Interpret objects as BLOBs and generate URLs. For example, if your directory 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.
     """
 
     def json(self, **kwargs: typing.Any) -> str:

label_studio_sdk/export_storage/local/types/local_update_response.py

@@ -8,6 +8,16 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class LocalUpdateResponse(pydantic_v1.BaseModel):
+    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
@@ -15,7 +25,7 @@ class LocalUpdateResponse(pydantic_v1.BaseModel):
 
     path: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Local path
+    Path to local directory
     """
 
     regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
@@ -25,7 +35,7 @@ class LocalUpdateResponse(pydantic_v1.BaseModel):
 
     use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Interpret objects as BLOBs and generate URLs. For example, if your directory 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.
     """
 
     def json(self, **kwargs: typing.Any) -> str: