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

label_studio_sdk/export_storage/types/export_storage_list_types_response_item.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.unchecked_base_model import UncheckedBaseModel
 import typing
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
 import pydantic
 
 
-class ExportStorageListTypesResponseItem(UniversalBaseModel):
+class ExportStorageListTypesResponseItem(UncheckedBaseModel):
     name: typing.Optional[str] = None
     title: typing.Optional[str] = None
 

label_studio_sdk/files/client.py

@@ -5,9 +5,10 @@ from ..core.client_wrapper import SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.file_upload import FileUpload
 from ..core.jsonable_encoder import jsonable_encoder
-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 .. import core
 from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -20,12 +21,11 @@ class FilesClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> FileUpload:
         """
-        Retrieve details about a specific uploaded file. To get the file upload ID, use [Get files list](list).
+        Retrieve details about a specific uploaded file.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this file upload.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -55,7 +55,7 @@ class FilesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     FileUpload,
-                    parse_obj_as(
+                    construct_type(
                         type_=FileUpload,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -67,12 +67,11 @@ class FilesClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Delete a specific uploaded file. To get the file upload ID, use [Get files list](list).
+        Delete a specific uploaded file.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this file upload.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -107,29 +106,20 @@ class FilesClient:
 
     def update(
         self,
-        id_: int,
+        id: int,
         *,
-        id: typing.Optional[int] = OMIT,
-        file: typing.Optional[str] = OMIT,
+        file: typing.Optional[core.File] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FileUpload:
         """
-
-        Update a specific uploaded file. To get the file upload ID, use [Get files list](list).
-
-        You will need to include the file data in the request body. For example:
-        ```bash
-        curl -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/import/file-upload/245' -F 'file=@path/to/my_file.csv'
-        ```
+        Update a specific uploaded file.
 
         Parameters
         ----------
-        id_ : int
-            A unique integer value identifying this file upload.
-
-        id : typing.Optional[int]
+        id : int
 
-        file : typing.Optional[str]
+        file : typing.Optional[core.File]
+            See core.File for more documentation
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -147,14 +137,14 @@ class FilesClient:
             api_key="YOUR_API_KEY",
         )
         client.files.update(
-            id_=1,
+            id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/import/file-upload/{jsonable_encoder(id_)}",
+            f"api/import/file-upload/{jsonable_encoder(id)}",
             method="PATCH",
-            json={
-                "id": id,
+            data={},
+            files={
                 "file": file,
             },
             request_options=request_options,
@@ -164,7 +154,7 @@ class FilesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     FileUpload,
-                    parse_obj_as(
+                    construct_type(
                         type_=FileUpload,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -179,26 +169,28 @@ class FilesClient:
         id: int,
         *,
         all_: typing.Optional[bool] = None,
-        ids: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
+        ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        ordering: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[FileUpload]:
         """
 
-        Retrieve the list of uploaded files used to create labeling tasks for a specific project. These are files that have been uploaded directly to Label Studio.
+                Retrieve the list of uploaded files used to create labeling tasks for a specific project.
 
-        You must provide a project ID. 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](../list).
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this file upload.
 
         all_ : typing.Optional[bool]
             Set to "true" if you want to retrieve all file uploads
 
-        ids : typing.Optional[typing.Union[int, typing.Sequence[int]]]
+        ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
             Specify the list of file upload IDs to retrieve, e.g. ids=[1,2,3]
 
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -224,6 +216,7 @@ class FilesClient:
             params={
                 "all": all_,
                 "ids": ids,
+                "ordering": ordering,
             },
             request_options=request_options,
         )
@@ -231,7 +224,7 @@ class FilesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[FileUpload],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[FileUpload],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -244,14 +237,12 @@ class FilesClient:
     def delete_many(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
 
-        Delete uploaded files for a specific project. These are files that have been uploaded directly to Label Studio.
+                Delete uploaded files for a specific project.
 
-        You must provide a project ID. 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](../list).
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this file upload.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -286,7 +277,7 @@ class FilesClient:
 
     def download(self, filename: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Download a specific uploaded file. If you aren't sure of the file name, try [Get files list](list) first.
+        Download a specific uploaded file.
 
         Parameters
         ----------
@@ -330,12 +321,11 @@ class AsyncFilesClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> FileUpload:
         """
-        Retrieve details about a specific uploaded file. To get the file upload ID, use [Get files list](list).
+        Retrieve details about a specific uploaded file.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this file upload.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -373,7 +363,7 @@ class AsyncFilesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     FileUpload,
-                    parse_obj_as(
+                    construct_type(
                         type_=FileUpload,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -385,12 +375,11 @@ class AsyncFilesClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Delete a specific uploaded file. To get the file upload ID, use [Get files list](list).
+        Delete a specific uploaded file.
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this file upload.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -433,29 +422,20 @@ class AsyncFilesClient:
 
     async def update(
         self,
-        id_: int,
+        id: int,
         *,
-        id: typing.Optional[int] = OMIT,
-        file: typing.Optional[str] = OMIT,
+        file: typing.Optional[core.File] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FileUpload:
         """
-
-        Update a specific uploaded file. To get the file upload ID, use [Get files list](list).
-
-        You will need to include the file data in the request body. For example:
-        ```bash
-        curl -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/import/file-upload/245' -F 'file=@path/to/my_file.csv'
-        ```
+        Update a specific uploaded file.
 
         Parameters
         ----------
-        id_ : int
-            A unique integer value identifying this file upload.
-
-        id : typing.Optional[int]
+        id : int
 
-        file : typing.Optional[str]
+        file : typing.Optional[core.File]
+            See core.File for more documentation
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -478,17 +458,17 @@ class AsyncFilesClient:
 
         async def main() -> None:
             await client.files.update(
-                id_=1,
+                id=1,
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/import/file-upload/{jsonable_encoder(id_)}",
+            f"api/import/file-upload/{jsonable_encoder(id)}",
             method="PATCH",
-            json={
-                "id": id,
+            data={},
+            files={
                 "file": file,
             },
             request_options=request_options,
@@ -498,7 +478,7 @@ class AsyncFilesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     FileUpload,
-                    parse_obj_as(
+                    construct_type(
                         type_=FileUpload,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -513,26 +493,28 @@ class AsyncFilesClient:
         id: int,
         *,
         all_: typing.Optional[bool] = None,
-        ids: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
+        ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        ordering: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[FileUpload]:
         """
 
-        Retrieve the list of uploaded files used to create labeling tasks for a specific project. These are files that have been uploaded directly to Label Studio.
+                Retrieve the list of uploaded files used to create labeling tasks for a specific project.
 
-        You must provide a project ID. 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](../list).
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this file upload.
 
         all_ : typing.Optional[bool]
             Set to "true" if you want to retrieve all file uploads
 
-        ids : typing.Optional[typing.Union[int, typing.Sequence[int]]]
+        ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
             Specify the list of file upload IDs to retrieve, e.g. ids=[1,2,3]
 
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -566,6 +548,7 @@ class AsyncFilesClient:
             params={
                 "all": all_,
                 "ids": ids,
+                "ordering": ordering,
             },
             request_options=request_options,
         )
@@ -573,7 +556,7 @@ class AsyncFilesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[FileUpload],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[FileUpload],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -586,14 +569,12 @@ class AsyncFilesClient:
     async def delete_many(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
 
-        Delete uploaded files for a specific project. These are files that have been uploaded directly to Label Studio.
+                Delete uploaded files for a specific project.
 
-        You must provide a project ID. 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](../list).
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this file upload.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -636,7 +617,7 @@ class AsyncFilesClient:
 
     async def download(self, filename: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Download a specific uploaded file. If you aren't sure of the file name, try [Get files list](list) first.
+        Download a specific uploaded file.
 
         Parameters
         ----------

label_studio_sdk/import_storage/__init__.py

@@ -2,28 +2,5 @@
 
 from .types import ImportStorageListTypesResponseItem
 from . import azure, gcs, local, redis, s3, s3s
-from .azure import AzureCreateResponse, AzureUpdateResponse
-from .gcs import GcsCreateResponse, GcsUpdateResponse
-from .local import LocalCreateResponse, LocalUpdateResponse
-from .redis import RedisCreateResponse, RedisUpdateResponse
-from .s3 import S3CreateResponse, S3UpdateResponse
 
-__all__ = [
-    "AzureCreateResponse",
-    "AzureUpdateResponse",
-    "GcsCreateResponse",
-    "GcsUpdateResponse",
-    "ImportStorageListTypesResponseItem",
-    "LocalCreateResponse",
-    "LocalUpdateResponse",
-    "RedisCreateResponse",
-    "RedisUpdateResponse",
-    "S3CreateResponse",
-    "S3UpdateResponse",
-    "azure",
-    "gcs",
-    "local",
-    "redis",
-    "s3",
-    "s3s",
-]
+__all__ = ["ImportStorageListTypesResponseItem", "azure", "gcs", "local", "redis", "s3", "s3s"]

label_studio_sdk/import_storage/azure/__init__.py

@@ -1,5 +1,2 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import AzureCreateResponse, AzureUpdateResponse
-
-__all__ = ["AzureCreateResponse", "AzureUpdateResponse"]