label-studio-sdk 1.0.7__py3-none-any.whl → 1.0.10__py3-none-any.whl

label_studio_sdk/projects/exports/client.py

@@ -1,23 +1,26 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
 import typing
+from ...core.client_wrapper import SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...core.jsonable_encoder import jsonable_encoder
 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.request_options import RequestOptions
-from ...types.annotation_filter_options import AnnotationFilterOptions
-from ...types.converted_format import ConvertedFormat
+from .types.exports_list_formats_response_item import ExportsListFormatsResponseItem
+from ...core.pydantic_utilities import parse_obj_as
 from ...types.export import Export
-from ...types.export_convert import ExportConvert
-from ...types.export_create import ExportCreate
-from ...types.export_create_status import ExportCreateStatus
-from ...types.serialization_options import SerializationOptions
-from ...types.task_filter_options import TaskFilterOptions
 from ...types.user_simple import UserSimple
+import datetime as dt
+from ...types.export_snapshot_status import ExportSnapshotStatus
+from ...types.converted_format import ConvertedFormat
+from ...types.task_filter_options import TaskFilterOptions
+from ...types.annotation_filter_options import AnnotationFilterOptions
+from ...types.serialization_options import SerializationOptions
+from ...types.export_snapshot import ExportSnapshot
+from ...core.serialization import convert_and_respect_annotation_metadata
+from ...types.export_format import ExportFormat
+from .types.exports_convert_response import ExportsConvertResponse
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -27,34 +30,30 @@ class ExportsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def create_export(
+    def download_sync(
         self,
         id: int,
         *,
         export_type: typing.Optional[str] = None,
-        download_all_tasks: typing.Optional[str] = None,
+        download_all_tasks: typing.Optional[bool] = None,
         download_resources: typing.Optional[bool] = None,
         ids: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Iterator[bytes]:
         """
+
         <Note>If you have a large project it's recommended to use export snapshots, this easy export endpoint might have timeouts.</Note>
         Export annotated tasks as a file in a specific format.
         For example, to export JSON annotations for a project to a file called `annotations.json`,
         run the following from the command line:
-
         ```bash
         curl -X GET https://localhost:8080/api/projects/{id}/export?exportType=JSON -H 'Authorization: Token abc123' --output 'annotations.json'
         ```
-
         To export all tasks, including skipped tasks and others without annotations, run the following from the command line:
-
         ```bash
         curl -X GET https://localhost:8080/api/projects/{id}/export?exportType=JSON&download_all_tasks=true -H 'Authorization: Token abc123' --output 'annotations.json'
         ```
-
         To export specific tasks with IDs of 123 and 345, run the following from the command line:
-
         ```bash
         curl -X GET https://localhost:8080/api/projects/{id}/export?ids[]=123\&ids[]=345 -H 'Authorization: Token abc123' --output 'annotations.json'
         ```
@@ -69,37 +68,25 @@ class ExportsClient:
         export_type : typing.Optional[str]
             Selected export format (JSON by default)
 
-        download_all_tasks : typing.Optional[str]
+        download_all_tasks : typing.Optional[bool]
+
             If true, download all tasks regardless of status. If false, download only annotated tasks.
 
         download_resources : typing.Optional[bool]
+
             If true, download all resource files such as images, audio, and others relevant to the tasks.
 
         ids : typing.Optional[typing.Union[int, typing.Sequence[int]]]
+
             Specify a list of task IDs to retrieve only the details for those tasks.
 
         request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
 
         Yields
         ------
         typing.Iterator[bytes]
-            Exported data
-
-        Examples
-        --------
-        from label_studio_sdk.client import LabelStudio
-
-        client = LabelStudio(
-            api_key="YOUR_API_KEY",
-        )
-        client.projects.exports.create_export(
-            id=1,
-            export_type="string",
-            download_all_tasks="string",
-            download_resources=True,
-            ids=1,
-        )
+            Exported data in binary format
         """
         with self._client_wrapper.httpx_client.stream(
             f"api/projects/{jsonable_encoder(id)}/export",
@@ -114,7 +101,8 @@ class ExportsClient:
         ) as _response:
             try:
                 if 200 <= _response.status_code < 300:
-                    for _chunk in _response.iter_bytes():
+                    _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
+                    for _chunk in _response.iter_bytes(chunk_size=_chunk_size):
                         yield _chunk
                     return
                 _response.read()
@@ -123,8 +111,11 @@ class ExportsClient:
                 raise ApiError(status_code=_response.status_code, body=_response.text)
             raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def list_formats(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[str]:
+    def list_formats(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[ExportsListFormatsResponseItem]:
         """
+
         Before exporting annotations, you can check with formats are supported by the specified project. For more information about export formats, see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
 
         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).
@@ -139,12 +130,12 @@ class ExportsClient:
 
         Returns
         -------
-        typing.List[str]
+        typing.List[ExportsListFormatsResponseItem]
             Export formats
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -154,25 +145,34 @@ class ExportsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/export/formats", method="GET", request_options=request_options
+            f"api/projects/{jsonable_encoder(id)}/export/formats",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[str], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[ExportsListFormatsResponseItem],
+                    parse_obj_as(
+                        type_=typing.List[ExportsListFormatsResponseItem],  # 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 list(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Export]:
+    def list(self, project_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Export]:
         """
+
         Returns a list of export file (snapshots) for a specific project by 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).
 
         Included in the response is information about each snapshot, such as who created it and what format it is in.
 
         Parameters
         ----------
-        id : int
+        project_id : int
             A unique integer value identifying this project.
 
         request_options : typing.Optional[RequestOptions]
@@ -185,21 +185,29 @@ class ExportsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.projects.exports.list(
-            id=1,
+            project_id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/", method="GET", request_options=request_options
+            f"api/projects/{jsonable_encoder(project_id)}/exports",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Export], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Export],
+                    parse_obj_as(
+                        type_=typing.List[Export],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -207,23 +215,24 @@ class ExportsClient:
 
     def create(
         self,
-        id_: int,
+        project_id: int,
         *,
         title: typing.Optional[str] = OMIT,
         id: typing.Optional[int] = OMIT,
         created_by: typing.Optional[UserSimple] = OMIT,
         created_at: typing.Optional[dt.datetime] = OMIT,
         finished_at: typing.Optional[dt.datetime] = OMIT,
-        status: typing.Optional[ExportCreateStatus] = OMIT,
+        status: typing.Optional[ExportSnapshotStatus] = OMIT,
         md5: typing.Optional[str] = OMIT,
-        counters: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        counters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         converted_formats: typing.Optional[typing.Sequence[ConvertedFormat]] = OMIT,
         task_filter_options: typing.Optional[TaskFilterOptions] = OMIT,
         annotation_filter_options: typing.Optional[AnnotationFilterOptions] = OMIT,
         serialization_options: typing.Optional[SerializationOptions] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ExportCreate:
+    ) -> ExportSnapshot:
         """
+
         Create a new export request to start a background task and generate an export file (snapshot) for a specific project by 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).
 
         A snapshot is a static export of your project's data and annotations at a specific point in time. It captures the current state of your tasks, annotations, and other relevant data, allowing you to download and review them later. Snapshots are particularly useful for large projects as they help avoid timeouts during export operations by processing the data asynchronously.
@@ -232,7 +241,7 @@ class ExportsClient:
 
         Parameters
         ----------
-        id_ : int
+        project_id : int
             A unique integer value identifying this project.
 
         title : typing.Optional[str]
@@ -247,11 +256,11 @@ class ExportsClient:
         finished_at : typing.Optional[dt.datetime]
             Complete or fail time
 
-        status : typing.Optional[ExportCreateStatus]
+        status : typing.Optional[ExportSnapshotStatus]
 
         md5 : typing.Optional[str]
 
-        counters : typing.Optional[typing.Dict[str, typing.Any]]
+        counters : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
 
         converted_formats : typing.Optional[typing.Sequence[ConvertedFormat]]
 
@@ -266,106 +275,133 @@ class ExportsClient:
 
         Returns
         -------
-        ExportCreate
+        ExportSnapshot
 
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.projects.exports.create(
-            id_=1,
+            project_id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id_)}/exports/",
+            f"api/projects/{jsonable_encoder(project_id)}/exports",
             method="POST",
             json={
                 "title": title,
                 "id": id,
-                "created_by": created_by,
+                "created_by": convert_and_respect_annotation_metadata(
+                    object_=created_by, annotation=UserSimple, direction="write"
+                ),
                 "created_at": created_at,
                 "finished_at": finished_at,
                 "status": status,
                 "md5": md5,
                 "counters": counters,
-                "converted_formats": converted_formats,
-                "task_filter_options": task_filter_options,
-                "annotation_filter_options": annotation_filter_options,
-                "serialization_options": serialization_options,
+                "converted_formats": convert_and_respect_annotation_metadata(
+                    object_=converted_formats, annotation=typing.Sequence[ConvertedFormat], direction="write"
+                ),
+                "task_filter_options": convert_and_respect_annotation_metadata(
+                    object_=task_filter_options, annotation=TaskFilterOptions, direction="write"
+                ),
+                "annotation_filter_options": convert_and_respect_annotation_metadata(
+                    object_=annotation_filter_options, annotation=AnnotationFilterOptions, direction="write"
+                ),
+                "serialization_options": convert_and_respect_annotation_metadata(
+                    object_=serialization_options, annotation=SerializationOptions, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(ExportCreate, _response.json())  # type: ignore
+                return typing.cast(
+                    ExportSnapshot,
+                    parse_obj_as(
+                        type_=ExportSnapshot,  # 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 get(self, id: int, export_pk: str, *, request_options: typing.Optional[RequestOptions] = None) -> Export:
+    def download(
+        self,
+        project_id: int,
+        export_pk: str,
+        *,
+        export_type: typing.Optional[ExportFormat] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Iterator[bytes]:
         """
-        Retrieve information about a specific export file (snapshot).
 
-        You will need the export ID. You can find this in the response when you [create the snapshot via the API](create) or using [List all export snapshots](list).
+        Download an export snapshot as a file in a specified format. To see what formats are supported, you can use [Get export formats](list-formats) or see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
 
-        You will also need the project ID. This 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).
+        You will need to provide the project ID and export ID (`export_pk`). The export ID is returned when you create the export or you can use [List all export snapshots](list).
+
+        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
+        project_id : int
             A unique integer value identifying this project.
 
         export_pk : str
             Primary key identifying the export file.
 
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        Export
-
+        export_type : typing.Optional[ExportFormat]
+            Selected export format. JSON is available by default. For other formats, you need to convert the export first.
 
-        Examples
-        --------
-        from label_studio_sdk.client import LabelStudio
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
 
-        client = LabelStudio(
-            api_key="YOUR_API_KEY",
-        )
-        client.projects.exports.get(
-            id=1,
-            export_pk="export_pk",
-        )
+        Yields
+        ------
+        typing.Iterator[bytes]
+            Exported data in binary format
         """
-        _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}",
+        with self._client_wrapper.httpx_client.stream(
+            f"api/projects/{jsonable_encoder(project_id)}/exports/{jsonable_encoder(export_pk)}/download",
             method="GET",
+            params={
+                "exportType": export_type,
+            },
             request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Export, _response.json())  # type: ignore
-            _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)
+        ) as _response:
+            try:
+                if 200 <= _response.status_code < 300:
+                    _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
+                    for _chunk in _response.iter_bytes(chunk_size=_chunk_size):
+                        yield _chunk
+                    return
+                _response.read()
+                _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 delete(self, id: int, export_pk: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    def get(
+        self, project_id: int, export_pk: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Export:
         """
-        Delete an export file by specified export ID.
+
+        Retrieve information about a specific export file (snapshot).
 
         You will need the export ID. You can find this in the response when you [create the snapshot via the API](create) or using [List all export snapshots](list).
 
+        You will also need the project ID. This 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
+        project_id : int
             A unique integer value identifying this project.
 
         export_pk : str
@@ -376,102 +412,103 @@ class ExportsClient:
 
         Returns
         -------
-        None
+        Export
+
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.projects.exports.delete(
-            id=1,
+        client.projects.exports.get(
+            project_id=1,
             export_pk="export_pk",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}",
-            method="DELETE",
+            f"api/projects/{jsonable_encoder(project_id)}/exports/{jsonable_encoder(export_pk)}",
+            method="GET",
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    Export,
+                    parse_obj_as(
+                        type_=Export,  # 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 convert(
-        self, id: int, export_pk: str, *, export_type: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> ExportConvert:
+    def delete(
+        self, project_id: int, export_pk: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
         """
-        You can use this to convert an export snapshot into the selected format.
-
-        To see what formats are supported, you can use [Get export formats](list-formats) or see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
 
-        You will need to provide the project ID and export ID (`export_pk`). The export ID is returned when you create the export or you can use [List all export snapshots](list).
+        Delete an export file by specified export 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).
+        You will need the export ID. You can find this in the response when you [create the snapshot via the API](create) or using [List all export snapshots](list).
 
         Parameters
         ----------
-        id : int
+        project_id : int
             A unique integer value identifying this project.
 
         export_pk : str
             Primary key identifying the export file.
 
-        export_type : str
-            Export file format.
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        ExportConvert
-
+        None
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.projects.exports.convert(
-            id=1,
+        client.projects.exports.delete(
+            project_id=1,
             export_pk="export_pk",
-            export_type="export_type",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}/convert",
-            method="POST",
-            json={"export_type": export_type},
+            f"api/projects/{jsonable_encoder(project_id)}/exports/{jsonable_encoder(export_pk)}",
+            method="DELETE",
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(ExportConvert, _response.json())  # type: ignore
+                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 download(
+    def convert(
         self,
-        id: int,
+        project_id: int,
         export_pk: str,
         *,
-        export_type: typing.Optional[str] = None,
+        export_type: typing.Optional[ExportFormat] = OMIT,
+        download_resources: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> None:
+    ) -> ExportsConvertResponse:
         """
-        Download an export snapshot as a file in a specified format. To see what formats are supported, you can use [Get export formats](list-formats) or see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
+
+        You can use this to convert an export snapshot into the selected format.
+
+        To see what formats are supported, you can use [Get export formats](list-formats) or see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
 
         You will need to provide the project ID and export ID (`export_pk`). The export ID is returned when you create the export or you can use [List all export snapshots](list).
 
@@ -479,43 +516,59 @@ class ExportsClient:
 
         Parameters
         ----------
-        id : int
+        project_id : int
             A unique integer value identifying this project.
 
         export_pk : str
             Primary key identifying the export file.
 
-        export_type : typing.Optional[str]
-            Selected export format
+        export_type : typing.Optional[ExportFormat]
+
+        download_resources : typing.Optional[bool]
+            If true, download all resource files such as images, audio, and others relevant to the tasks.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        ExportsConvertResponse
+
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.projects.exports.download(
-            id=1,
+        client.projects.exports.convert(
+            project_id=1,
             export_pk="export_pk",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}/download",
-            method="GET",
-            params={"exportType": export_type},
+            f"api/projects/{jsonable_encoder(project_id)}/exports/{jsonable_encoder(export_pk)}/convert",
+            method="POST",
+            json={
+                "export_type": export_type,
+                "download_resources": download_resources,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    ExportsConvertResponse,
+                    parse_obj_as(
+                        type_=ExportsConvertResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -526,34 +579,30 @@ class AsyncExportsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def create_export(
+    async def download_sync(
         self,
         id: int,
         *,
         export_type: typing.Optional[str] = None,
-        download_all_tasks: typing.Optional[str] = None,
+        download_all_tasks: typing.Optional[bool] = None,
         download_resources: typing.Optional[bool] = None,
         ids: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.AsyncIterator[bytes]:
         """
+
         <Note>If you have a large project it's recommended to use export snapshots, this easy export endpoint might have timeouts.</Note>
         Export annotated tasks as a file in a specific format.
         For example, to export JSON annotations for a project to a file called `annotations.json`,
         run the following from the command line:
-
         ```bash
         curl -X GET https://localhost:8080/api/projects/{id}/export?exportType=JSON -H 'Authorization: Token abc123' --output 'annotations.json'
         ```
-
         To export all tasks, including skipped tasks and others without annotations, run the following from the command line:
-
         ```bash
         curl -X GET https://localhost:8080/api/projects/{id}/export?exportType=JSON&download_all_tasks=true -H 'Authorization: Token abc123' --output 'annotations.json'
         ```
-
         To export specific tasks with IDs of 123 and 345, run the following from the command line:
-
         ```bash
         curl -X GET https://localhost:8080/api/projects/{id}/export?ids[]=123\&ids[]=345 -H 'Authorization: Token abc123' --output 'annotations.json'
         ```
@@ -568,37 +617,25 @@ class AsyncExportsClient:
         export_type : typing.Optional[str]
             Selected export format (JSON by default)
 
-        download_all_tasks : typing.Optional[str]
+        download_all_tasks : typing.Optional[bool]
+
             If true, download all tasks regardless of status. If false, download only annotated tasks.
 
         download_resources : typing.Optional[bool]
+
             If true, download all resource files such as images, audio, and others relevant to the tasks.
 
         ids : typing.Optional[typing.Union[int, typing.Sequence[int]]]
+
             Specify a list of task IDs to retrieve only the details for those tasks.
 
         request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
 
         Yields
         ------
         typing.AsyncIterator[bytes]
-            Exported data
-
-        Examples
-        --------
-        from label_studio_sdk.client import AsyncLabelStudio
-
-        client = AsyncLabelStudio(
-            api_key="YOUR_API_KEY",
-        )
-        await client.projects.exports.create_export(
-            id=1,
-            export_type="string",
-            download_all_tasks="string",
-            download_resources=True,
-            ids=1,
-        )
+            Exported data in binary format
         """
         async with self._client_wrapper.httpx_client.stream(
             f"api/projects/{jsonable_encoder(id)}/export",
@@ -613,7 +650,8 @@ class AsyncExportsClient:
         ) as _response:
             try:
                 if 200 <= _response.status_code < 300:
-                    async for _chunk in _response.aiter_bytes():
+                    _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
+                    async for _chunk in _response.aiter_bytes(chunk_size=_chunk_size):
                         yield _chunk
                     return
                 await _response.aread()
@@ -624,8 +662,9 @@ class AsyncExportsClient:
 
     async def list_formats(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[str]:
+    ) -> typing.List[ExportsListFormatsResponseItem]:
         """
+
         Before exporting annotations, you can check with formats are supported by the specified project. For more information about export formats, see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
 
         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).
@@ -640,40 +679,59 @@ class AsyncExportsClient:
 
         Returns
         -------
-        typing.List[str]
+        typing.List[ExportsListFormatsResponseItem]
             Export formats
 
         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.projects.exports.list_formats(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.projects.exports.list_formats(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/export/formats", method="GET", request_options=request_options
+            f"api/projects/{jsonable_encoder(id)}/export/formats",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[str], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[ExportsListFormatsResponseItem],
+                    parse_obj_as(
+                        type_=typing.List[ExportsListFormatsResponseItem],  # 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 list(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Export]:
+    async def list(
+        self, project_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[Export]:
         """
+
         Returns a list of export file (snapshots) for a specific project by 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).
 
         Included in the response is information about each snapshot, such as who created it and what format it is in.
 
         Parameters
         ----------
-        id : int
+        project_id : int
             A unique integer value identifying this project.
 
         request_options : typing.Optional[RequestOptions]
@@ -686,21 +744,37 @@ class AsyncExportsClient:
 
         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.projects.exports.list(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.projects.exports.list(
+                project_id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/", method="GET", request_options=request_options
+            f"api/projects/{jsonable_encoder(project_id)}/exports",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Export], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Export],
+                    parse_obj_as(
+                        type_=typing.List[Export],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -708,23 +782,24 @@ class AsyncExportsClient:
 
     async def create(
         self,
-        id_: int,
+        project_id: int,
         *,
         title: typing.Optional[str] = OMIT,
         id: typing.Optional[int] = OMIT,
         created_by: typing.Optional[UserSimple] = OMIT,
         created_at: typing.Optional[dt.datetime] = OMIT,
         finished_at: typing.Optional[dt.datetime] = OMIT,
-        status: typing.Optional[ExportCreateStatus] = OMIT,
+        status: typing.Optional[ExportSnapshotStatus] = OMIT,
         md5: typing.Optional[str] = OMIT,
-        counters: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        counters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         converted_formats: typing.Optional[typing.Sequence[ConvertedFormat]] = OMIT,
         task_filter_options: typing.Optional[TaskFilterOptions] = OMIT,
         annotation_filter_options: typing.Optional[AnnotationFilterOptions] = OMIT,
         serialization_options: typing.Optional[SerializationOptions] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ExportCreate:
+    ) -> ExportSnapshot:
         """
+
         Create a new export request to start a background task and generate an export file (snapshot) for a specific project by 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).
 
         A snapshot is a static export of your project's data and annotations at a specific point in time. It captures the current state of your tasks, annotations, and other relevant data, allowing you to download and review them later. Snapshots are particularly useful for large projects as they help avoid timeouts during export operations by processing the data asynchronously.
@@ -733,7 +808,7 @@ class AsyncExportsClient:
 
         Parameters
         ----------
-        id_ : int
+        project_id : int
             A unique integer value identifying this project.
 
         title : typing.Optional[str]
@@ -748,11 +823,11 @@ class AsyncExportsClient:
         finished_at : typing.Optional[dt.datetime]
             Complete or fail time
 
-        status : typing.Optional[ExportCreateStatus]
+        status : typing.Optional[ExportSnapshotStatus]
 
         md5 : typing.Optional[str]
 
-        counters : typing.Optional[typing.Dict[str, typing.Any]]
+        counters : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
 
         converted_formats : typing.Optional[typing.Sequence[ConvertedFormat]]
 
@@ -767,106 +842,141 @@ class AsyncExportsClient:
 
         Returns
         -------
-        ExportCreate
+        ExportSnapshot
 
 
         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.projects.exports.create(
-            id_=1,
-        )
+
+
+        async def main() -> None:
+            await client.projects.exports.create(
+                project_id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id_)}/exports/",
+            f"api/projects/{jsonable_encoder(project_id)}/exports",
             method="POST",
             json={
                 "title": title,
                 "id": id,
-                "created_by": created_by,
+                "created_by": convert_and_respect_annotation_metadata(
+                    object_=created_by, annotation=UserSimple, direction="write"
+                ),
                 "created_at": created_at,
                 "finished_at": finished_at,
                 "status": status,
                 "md5": md5,
                 "counters": counters,
-                "converted_formats": converted_formats,
-                "task_filter_options": task_filter_options,
-                "annotation_filter_options": annotation_filter_options,
-                "serialization_options": serialization_options,
+                "converted_formats": convert_and_respect_annotation_metadata(
+                    object_=converted_formats, annotation=typing.Sequence[ConvertedFormat], direction="write"
+                ),
+                "task_filter_options": convert_and_respect_annotation_metadata(
+                    object_=task_filter_options, annotation=TaskFilterOptions, direction="write"
+                ),
+                "annotation_filter_options": convert_and_respect_annotation_metadata(
+                    object_=annotation_filter_options, annotation=AnnotationFilterOptions, direction="write"
+                ),
+                "serialization_options": convert_and_respect_annotation_metadata(
+                    object_=serialization_options, annotation=SerializationOptions, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(ExportCreate, _response.json())  # type: ignore
+                return typing.cast(
+                    ExportSnapshot,
+                    parse_obj_as(
+                        type_=ExportSnapshot,  # 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 get(self, id: int, export_pk: str, *, request_options: typing.Optional[RequestOptions] = None) -> Export:
+    async def download(
+        self,
+        project_id: int,
+        export_pk: str,
+        *,
+        export_type: typing.Optional[ExportFormat] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.AsyncIterator[bytes]:
         """
-        Retrieve information about a specific export file (snapshot).
 
-        You will need the export ID. You can find this in the response when you [create the snapshot via the API](create) or using [List all export snapshots](list).
+        Download an export snapshot as a file in a specified format. To see what formats are supported, you can use [Get export formats](list-formats) or see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
 
-        You will also need the project ID. This 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).
+        You will need to provide the project ID and export ID (`export_pk`). The export ID is returned when you create the export or you can use [List all export snapshots](list).
+
+        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
+        project_id : int
             A unique integer value identifying this project.
 
         export_pk : str
             Primary key identifying the export file.
 
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        Export
-
+        export_type : typing.Optional[ExportFormat]
+            Selected export format. JSON is available by default. For other formats, you need to convert the export first.
 
-        Examples
-        --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
 
-        client = AsyncLabelStudio(
-            api_key="YOUR_API_KEY",
-        )
-        await client.projects.exports.get(
-            id=1,
-            export_pk="export_pk",
-        )
+        Yields
+        ------
+        typing.AsyncIterator[bytes]
+            Exported data in binary format
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}",
+        async with self._client_wrapper.httpx_client.stream(
+            f"api/projects/{jsonable_encoder(project_id)}/exports/{jsonable_encoder(export_pk)}/download",
             method="GET",
+            params={
+                "exportType": export_type,
+            },
             request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Export, _response.json())  # type: ignore
-            _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)
+        ) as _response:
+            try:
+                if 200 <= _response.status_code < 300:
+                    _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
+                    async for _chunk in _response.aiter_bytes(chunk_size=_chunk_size):
+                        yield _chunk
+                    return
+                await _response.aread()
+                _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 delete(self, id: int, export_pk: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    async def get(
+        self, project_id: int, export_pk: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Export:
         """
-        Delete an export file by specified export ID.
+
+        Retrieve information about a specific export file (snapshot).
 
         You will need the export ID. You can find this in the response when you [create the snapshot via the API](create) or using [List all export snapshots](list).
 
+        You will also need the project ID. This 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
+        project_id : int
             A unique integer value identifying this project.
 
         export_pk : str
@@ -877,102 +987,119 @@ class AsyncExportsClient:
 
         Returns
         -------
-        None
+        Export
+
 
         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.projects.exports.delete(
-            id=1,
-            export_pk="export_pk",
-        )
+
+
+        async def main() -> None:
+            await client.projects.exports.get(
+                project_id=1,
+                export_pk="export_pk",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}",
-            method="DELETE",
+            f"api/projects/{jsonable_encoder(project_id)}/exports/{jsonable_encoder(export_pk)}",
+            method="GET",
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    Export,
+                    parse_obj_as(
+                        type_=Export,  # 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 convert(
-        self, id: int, export_pk: str, *, export_type: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> ExportConvert:
+    async def delete(
+        self, project_id: int, export_pk: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
         """
-        You can use this to convert an export snapshot into the selected format.
-
-        To see what formats are supported, you can use [Get export formats](list-formats) or see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
 
-        You will need to provide the project ID and export ID (`export_pk`). The export ID is returned when you create the export or you can use [List all export snapshots](list).
+        Delete an export file by specified export 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).
+        You will need the export ID. You can find this in the response when you [create the snapshot via the API](create) or using [List all export snapshots](list).
 
         Parameters
         ----------
-        id : int
+        project_id : int
             A unique integer value identifying this project.
 
         export_pk : str
             Primary key identifying the export file.
 
-        export_type : str
-            Export file format.
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        ExportConvert
-
+        None
 
         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.projects.exports.convert(
-            id=1,
-            export_pk="export_pk",
-            export_type="export_type",
-        )
+
+
+        async def main() -> None:
+            await client.projects.exports.delete(
+                project_id=1,
+                export_pk="export_pk",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}/convert",
-            method="POST",
-            json={"export_type": export_type},
+            f"api/projects/{jsonable_encoder(project_id)}/exports/{jsonable_encoder(export_pk)}",
+            method="DELETE",
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(ExportConvert, _response.json())  # type: ignore
+                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 download(
+    async def convert(
         self,
-        id: int,
+        project_id: int,
         export_pk: str,
         *,
-        export_type: typing.Optional[str] = None,
+        export_type: typing.Optional[ExportFormat] = OMIT,
+        download_resources: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> None:
+    ) -> ExportsConvertResponse:
         """
-        Download an export snapshot as a file in a specified format. To see what formats are supported, you can use [Get export formats](list-formats) or see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
+
+        You can use this to convert an export snapshot into the selected format.
+
+        To see what formats are supported, you can use [Get export formats](list-formats) or see [Export formats supported by Label Studio](https://labelstud.io/guide/export#Export-formats-supported-by-Label-Studio).
 
         You will need to provide the project ID and export ID (`export_pk`). The export ID is returned when you create the export or you can use [List all export snapshots](list).
 
@@ -980,43 +1107,67 @@ class AsyncExportsClient:
 
         Parameters
         ----------
-        id : int
+        project_id : int
             A unique integer value identifying this project.
 
         export_pk : str
             Primary key identifying the export file.
 
-        export_type : typing.Optional[str]
-            Selected export format
+        export_type : typing.Optional[ExportFormat]
+
+        download_resources : typing.Optional[bool]
+            If true, download all resource files such as images, audio, and others relevant to the tasks.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        ExportsConvertResponse
+
 
         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.projects.exports.download(
-            id=1,
-            export_pk="export_pk",
-        )
+
+
+        async def main() -> None:
+            await client.projects.exports.convert(
+                project_id=1,
+                export_pk="export_pk",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}/download",
-            method="GET",
-            params={"exportType": export_type},
+            f"api/projects/{jsonable_encoder(project_id)}/exports/{jsonable_encoder(export_pk)}/convert",
+            method="POST",
+            json={
+                "export_type": export_type,
+                "download_resources": download_resources,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
+            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    ExportsConvertResponse,
+                    parse_obj_as(
+                        type_=ExportsConvertResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)