label-studio-sdk 1.0.20__py3-none-any.whl → 2.0.0__py3-none-any.whl

label_studio_sdk/import_storage/local/client.py

@@ -4,12 +4,10 @@ import typing
 from ...core.client_wrapper import SyncClientWrapper
 from ...core.request_options import RequestOptions
 from ...types.local_files_import_storage import LocalFilesImportStorage
-from ...core.pydantic_utilities import parse_obj_as
+from ...core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
-from .types.local_create_response import LocalCreateResponse
 from ...core.jsonable_encoder import jsonable_encoder
-from .types.local_update_response import LocalUpdateResponse
 from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -21,18 +19,20 @@ class LocalClient:
         self._client_wrapper = client_wrapper
 
     def list(
-        self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
+        self,
+        *,
+        ordering: typing.Optional[str] = None,
+        project: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[LocalFilesImportStorage]:
         """
-
-        If you have local files that you want to add to Label Studio from a specific directory, you can set up a specific local directory on the machine where LS is running as source or target storage. Use this API request to get a list of all local file import (source) 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).
-
-        For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
+        Get a list of all local file import storage connections.
 
         Parameters
         ----------
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
         project : typing.Optional[int]
             Project ID
 
@@ -57,6 +57,7 @@ class LocalClient:
             "api/storages/localfiles/",
             method="GET",
             params={
+                "ordering": ordering,
                 "project": project,
             },
             request_options=request_options,
@@ -65,7 +66,7 @@ class LocalClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[LocalFilesImportStorage],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[LocalFilesImportStorage],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -85,14 +86,9 @@ class LocalClient:
         regex_filter: typing.Optional[str] = OMIT,
         use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> LocalCreateResponse:
+    ) -> LocalFilesImportStorage:
         """
-
-        Create a new source storage connection to a local file directory.
-
-        For information about the required fields and prerequisites, see [Local storage](https://labelstud.io/guide/storage#Local-storage) in the Label Studio documentation.
-
-        <Tip>After you add the storage, you should validate the connection before attempting to sync your data. Your data will not be imported until you [sync your connection](sync).</Tip>
+        Create a new local file import storage connection.
 
         Parameters
         ----------
@@ -119,7 +115,7 @@ class LocalClient:
 
         Returns
         -------
-        LocalCreateResponse
+        LocalFilesImportStorage
 
 
         Examples
@@ -151,9 +147,9 @@ class LocalClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    LocalCreateResponse,
-                    parse_obj_as(
-                        type_=LocalCreateResponse,  # type: ignore
+                    LocalFilesImportStorage,
+                    construct_type(
+                        type_=LocalFilesImportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -162,98 +158,13 @@ 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,
-        *,
-        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 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
-
-        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
-        -------
-        None
-
-        Examples
-        --------
-        from label_studio_sdk import LabelStudio
-
-        client = LabelStudio(
-            api_key="YOUR_API_KEY",
-        )
-        client.import_storage.local.validate()
-        """
-        _response = self._client_wrapper.httpx_client.request(
-            "api/storages/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,
-            },
-            headers={
-                "content-type": "application/json",
-            },
-            request_options=request_options,
-            omit=OMIT,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return
-            _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 get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LocalFilesImportStorage:
         """
-
-        Get a specific local file import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
-
-        For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
+        Get a specific local file import storage connection.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this local files import storage.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -283,7 +194,7 @@ class LocalClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     LocalFilesImportStorage,
-                    parse_obj_as(
+                    construct_type(
                         type_=LocalFilesImportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -295,17 +206,11 @@ class LocalClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-
-        Delete a specific local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
-
-        Deleting a source storage connection does not affect tasks with synced data in Label Studio. The sync process is designed to import new or updated tasks from the connected storage into the project, but it does not track deletions of files from the storage. Therefore, if you remove the external storage connection, the tasks that were created from that storage will remain in the project.
-
-        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.
+        Delete a specific local file import storage connection.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this local files import storage.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -349,17 +254,13 @@ class LocalClient:
         regex_filter: typing.Optional[str] = OMIT,
         use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> LocalUpdateResponse:
+    ) -> LocalFilesImportStorage:
         """
-
-        Update a specific local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
-
-        For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
+        Update a specific local file import storage connection.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this local files import storage.
 
         title : typing.Optional[str]
             Storage title
@@ -384,7 +285,7 @@ class LocalClient:
 
         Returns
         -------
-        LocalUpdateResponse
+        LocalFilesImportStorage
 
 
         Examples
@@ -418,9 +319,9 @@ class LocalClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    LocalUpdateResponse,
-                    parse_obj_as(
-                        type_=LocalUpdateResponse,  # type: ignore
+                    LocalFilesImportStorage,
+                    construct_type(
+                        type_=LocalFilesImportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -431,12 +332,7 @@ class LocalClient:
 
     def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LocalFilesImportStorage:
         """
-
-        Sync tasks from a local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
-
-        Sync operations with external sources only go one way. They either create tasks from objects in the source directory (source/import storage) or push annotations to the output directory (export/target storage). Changing something on the local file side doesn’t guarantee consistency in results.
-
-        <Note>Before proceeding, you should review [How sync operations work - Source storage](https://labelstud.io/guide/storage#Source-storage) to ensure that your data remains secure and private.</Note>
+        Sync tasks from a local file import storage connection.
 
         Parameters
         ----------
@@ -471,7 +367,7 @@ class LocalClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     LocalFilesImportStorage,
-                    parse_obj_as(
+                    construct_type(
                         type_=LocalFilesImportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -481,119 +377,115 @@ class LocalClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-
-class AsyncLocalClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
-
-    async def list(
-        self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[LocalFilesImportStorage]:
+    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 import storage connection.
 
-        If you have local files that you want to add to Label Studio from a specific directory, you can set up a specific local directory on the machine where LS is running as source or target storage. Use this API request to get a list of all local file import (source) storage connections for a specific project.
+        Parameters
+        ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
 
-        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).
+        title : typing.Optional[str]
+            Storage title
 
-        For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
+        description : typing.Optional[str]
+            Storage description
 
-        Parameters
-        ----------
         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
         -------
-        typing.List[LocalFilesImportStorage]
-
+        None
 
         Examples
         --------
-        import asyncio
-
-        from label_studio_sdk import AsyncLabelStudio
+        from label_studio_sdk import LabelStudio
 
-        client = AsyncLabelStudio(
+        client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-
-
-        async def main() -> None:
-            await client.import_storage.local.list()
-
-
-        asyncio.run(main())
+        client.import_storage.local.validate()
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/localfiles/",
-            method="GET",
-            params={
+        _response = self._client_wrapper.httpx_client.request(
+            "api/storages/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,
+            },
+            headers={
+                "content-type": "application/json",
             },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    typing.List[LocalFilesImportStorage],
-                    parse_obj_as(
-                        type_=typing.List[LocalFilesImportStorage],  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
+                return
             _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 create(
+
+class AsyncLocalClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
         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,
-        use_blob_urls: typing.Optional[bool] = OMIT,
+        ordering: typing.Optional[str] = None,
+        project: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> LocalCreateResponse:
+    ) -> typing.List[LocalFilesImportStorage]:
         """
-
-        Create a new source storage connection to a local file directory.
-
-        For information about the required fields and prerequisites, see [Local storage](https://labelstud.io/guide/storage#Local-storage) in the Label Studio documentation.
-
-        <Tip>After you add the storage, you should validate the connection before attempting to sync your data. Your data will not be imported until you [sync your connection](sync).</Tip>
+        Get a list of all local file import storage connections.
 
         Parameters
         ----------
-        title : typing.Optional[str]
-            Storage title
-
-        description : typing.Optional[str]
-            Storage description
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
         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
         -------
-        LocalCreateResponse
+        typing.List[LocalFilesImportStorage]
 
 
         Examples
@@ -608,34 +500,26 @@ class AsyncLocalClient:
 
 
         async def main() -> None:
-            await client.import_storage.local.create()
+            await client.import_storage.local.list()
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/localfiles/",
-            method="POST",
-            json={
-                "title": title,
-                "description": description,
+            method="GET",
+            params={
+                "ordering": ordering,
                 "project": project,
-                "path": path,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
-            },
-            headers={
-                "content-type": "application/json",
             },
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    LocalCreateResponse,
-                    parse_obj_as(
-                        type_=LocalCreateResponse,  # type: ignore
+                    typing.List[LocalFilesImportStorage],
+                    construct_type(
+                        type_=typing.List[LocalFilesImportStorage],  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -644,10 +528,9 @@ 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(
+    async def create(
         self,
         *,
-        id: typing.Optional[int] = OMIT,
         title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
@@ -655,16 +538,12 @@ class AsyncLocalClient:
         regex_filter: typing.Optional[str] = OMIT,
         use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> None:
+    ) -> LocalFilesImportStorage:
         """
-
-        Validate a specific local file import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
+        Create a new local file import storage connection.
 
         Parameters
         ----------
-        id : typing.Optional[int]
-            Storage ID. If set, storage with specified ID will be updated
-
         title : typing.Optional[str]
             Storage title
 
@@ -688,7 +567,8 @@ class AsyncLocalClient:
 
         Returns
         -------
-        None
+        LocalFilesImportStorage
+
 
         Examples
         --------
@@ -702,16 +582,15 @@ class AsyncLocalClient:
 
 
         async def main() -> None:
-            await client.import_storage.local.validate()
+            await client.import_storage.local.create()
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/localfiles/validate",
+            "api/storages/localfiles/",
             method="POST",
             json={
-                "id": id,
                 "title": title,
                 "description": description,
                 "project": project,
@@ -727,7 +606,13 @@ class AsyncLocalClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    LocalFilesImportStorage,
+                    construct_type(
+                        type_=LocalFilesImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -735,15 +620,11 @@ class AsyncLocalClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LocalFilesImportStorage:
         """
-
-        Get a specific local file import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
-
-        For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
+        Get a specific local file import storage connection.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this local files import storage.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -781,7 +662,7 @@ class AsyncLocalClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     LocalFilesImportStorage,
-                    parse_obj_as(
+                    construct_type(
                         type_=LocalFilesImportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -793,17 +674,11 @@ class AsyncLocalClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-
-        Delete a specific local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
-
-        Deleting a source storage connection does not affect tasks with synced data in Label Studio. The sync process is designed to import new or updated tasks from the connected storage into the project, but it does not track deletions of files from the storage. Therefore, if you remove the external storage connection, the tasks that were created from that storage will remain in the project.
-
-        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.
+        Delete a specific local file import storage connection.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this local files import storage.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -855,17 +730,13 @@ class AsyncLocalClient:
         regex_filter: typing.Optional[str] = OMIT,
         use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> LocalUpdateResponse:
+    ) -> LocalFilesImportStorage:
         """
-
-        Update a specific local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
-
-        For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
+        Update a specific local file import storage connection.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this local files import storage.
 
         title : typing.Optional[str]
             Storage title
@@ -890,7 +761,7 @@ class AsyncLocalClient:
 
         Returns
         -------
-        LocalUpdateResponse
+        LocalFilesImportStorage
 
 
         Examples
@@ -932,9 +803,9 @@ class AsyncLocalClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    LocalUpdateResponse,
-                    parse_obj_as(
-                        type_=LocalUpdateResponse,  # type: ignore
+                    LocalFilesImportStorage,
+                    construct_type(
+                        type_=LocalFilesImportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -947,12 +818,7 @@ class AsyncLocalClient:
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> LocalFilesImportStorage:
         """
-
-        Sync tasks from a local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
-
-        Sync operations with external sources only go one way. They either create tasks from objects in the source directory (source/import storage) or push annotations to the output directory (export/target storage). Changing something on the local file side doesn’t guarantee consistency in results.
-
-        <Note>Before proceeding, you should review [How sync operations work - Source storage](https://labelstud.io/guide/storage#Source-storage) to ensure that your data remains secure and private.</Note>
+        Sync tasks from a local file import storage connection.
 
         Parameters
         ----------
@@ -995,7 +861,7 @@ class AsyncLocalClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     LocalFilesImportStorage,
-                    parse_obj_as(
+                    construct_type(
                         type_=LocalFilesImportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -1004,3 +870,91 @@ class AsyncLocalClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    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 import storage connection.
+
+        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
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.import_storage.local.validate()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/storages/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,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _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)