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

label_studio_sdk/predictions/client.py

@@ -1,14 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+from ..core.client_wrapper import SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.prediction import Prediction
+from ..core.pydantic_utilities import parse_obj_as
 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.prediction import Prediction
+from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -26,6 +26,7 @@ class PredictionsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Prediction]:
         """
+
         Get a list of all predictions. You can optionally filter these by task or by project. If you want to filter, you will need the project ID and/or task ID. Both of these can be found in the Label Studio URL when viewing a task, or you can use [List all projects](../projects/list) and [Get tasks list](../tasks/list).
 
         <Note>The terms "predictions" and pre-annotations" are used interchangeably.</Note>
@@ -52,7 +53,7 @@ class PredictionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -60,11 +61,23 @@ class PredictionsClient:
         client.predictions.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/predictions/", method="GET", params={"task": task, "project": project}, request_options=request_options
+            "api/predictions/",
+            method="GET",
+            params={
+                "task": task,
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Prediction], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Prediction],
+                    parse_obj_as(
+                        type_=typing.List[Prediction],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -74,22 +87,21 @@ class PredictionsClient:
         self,
         *,
         task: typing.Optional[int] = OMIT,
-        result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] = OMIT,
+        result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]] = OMIT,
         score: typing.Optional[float] = OMIT,
         model_version: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Prediction:
         """
+
         If you have predictions generated for your dataset from a model, either as pre-annotated tasks or pre-labeled tasks, you can import the predictions with your dataset into Label Studio for review and correction.
 
         To import predicted labels into Label Studio, you must use the [Basic Label Studio JSON format](https://labelstud.io/guide/tasks#Basic-Label-Studio-JSON-format) and set up your tasks with the predictions JSON key. The Label Studio ML backend also outputs tasks in this format.
 
         #### JSON format for predictions
-
         Label Studio JSON format for pre-annotations must contain two sections:
-
-        - A data object which references the source of the data that the pre-annotations apply to. This can be a URL to an audio file, a pre-signed cloud storage link to an image, plain text, a reference to a CSV file stored in Label Studio, or something else.
-        - A predictions array that contains the pre-annotation results for the different types of labeling. See how to add results to the predictions array.
+        * A data object which references the source of the data that the pre-annotations apply to. This can be a URL to an audio file, a pre-signed cloud storage link to an image, plain text, a reference to a CSV file stored in Label Studio, or something else.
+        * A predictions array that contains the pre-annotation results for the different types of labeling. See how to add results to the predictions array.
 
         For more information, see [the JSON format reference in the Label Studio documentation](https://labelstud.io/guide/predictions#JSON-format-for-pre-annotations)
 
@@ -98,7 +110,7 @@ class PredictionsClient:
         task : typing.Optional[int]
             Task ID for which the prediction is created
 
-        result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]]
+        result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]]
             Prediction result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/predictions)
 
         score : typing.Optional[float]
@@ -117,7 +129,7 @@ class PredictionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -148,13 +160,27 @@ class PredictionsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/predictions/",
             method="POST",
-            json={"task": task, "result": result, "score": score, "model_version": model_version},
+            json={
+                "task": task,
+                "result": result,
+                "score": score,
+                "model_version": model_version,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Prediction, _response.json())  # type: ignore
+                return typing.cast(
+                    Prediction,
+                    parse_obj_as(
+                        type_=Prediction,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -162,6 +188,7 @@ class PredictionsClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Prediction:
         """
+
         Get details about a specific prediction by its ID. To find the prediction ID, use [List predictions](list).
 
         For information about the prediction format, see [the JSON format reference in the Label Studio documentation](https://labelstud.io/guide/predictions#JSON-format-for-pre-annotations).
@@ -181,7 +208,7 @@ class PredictionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -191,11 +218,19 @@ class PredictionsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/predictions/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+            f"api/predictions/{jsonable_encoder(id)}/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Prediction, _response.json())  # type: ignore
+                return typing.cast(
+                    Prediction,
+                    parse_obj_as(
+                        type_=Prediction,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -203,6 +238,7 @@ class PredictionsClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a prediction. To find the prediction ID, use [List predictions](list).
 
         Parameters
@@ -219,7 +255,7 @@ class PredictionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -229,7 +265,9 @@ class PredictionsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/predictions/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+            f"api/predictions/{jsonable_encoder(id)}/",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -244,12 +282,13 @@ class PredictionsClient:
         id: int,
         *,
         task: typing.Optional[int] = OMIT,
-        result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] = OMIT,
+        result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]] = OMIT,
         score: typing.Optional[float] = OMIT,
         model_version: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Prediction:
         """
+
         Update a prediction. To find the prediction ID, use [List predictions](list).
 
         For information about the prediction format, see [the JSON format reference in the Label Studio documentation](https://labelstud.io/guide/predictions#JSON-format-for-pre-annotations).
@@ -262,7 +301,7 @@ class PredictionsClient:
         task : typing.Optional[int]
             Task ID for which the prediction is created
 
-        result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]]
+        result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]]
             Prediction result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/predictions)
 
         score : typing.Optional[float]
@@ -281,7 +320,7 @@ class PredictionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -313,13 +352,27 @@ class PredictionsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/predictions/{jsonable_encoder(id)}/",
             method="PATCH",
-            json={"task": task, "result": result, "score": score, "model_version": model_version},
+            json={
+                "task": task,
+                "result": result,
+                "score": score,
+                "model_version": model_version,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Prediction, _response.json())  # type: ignore
+                return typing.cast(
+                    Prediction,
+                    parse_obj_as(
+                        type_=Prediction,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -338,6 +391,7 @@ class AsyncPredictionsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Prediction]:
         """
+
         Get a list of all predictions. You can optionally filter these by task or by project. If you want to filter, you will need the project ID and/or task ID. Both of these can be found in the Label Studio URL when viewing a task, or you can use [List all projects](../projects/list) and [Get tasks list](../tasks/list).
 
         <Note>The terms "predictions" and pre-annotations" are used interchangeably.</Note>
@@ -364,19 +418,39 @@ class AsyncPredictionsClient:
 
         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.predictions.list()
+
+
+        async def main() -> None:
+            await client.predictions.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/predictions/", method="GET", params={"task": task, "project": project}, request_options=request_options
+            "api/predictions/",
+            method="GET",
+            params={
+                "task": task,
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Prediction], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Prediction],
+                    parse_obj_as(
+                        type_=typing.List[Prediction],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -386,22 +460,21 @@ class AsyncPredictionsClient:
         self,
         *,
         task: typing.Optional[int] = OMIT,
-        result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] = OMIT,
+        result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]] = OMIT,
         score: typing.Optional[float] = OMIT,
         model_version: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Prediction:
         """
+
         If you have predictions generated for your dataset from a model, either as pre-annotated tasks or pre-labeled tasks, you can import the predictions with your dataset into Label Studio for review and correction.
 
         To import predicted labels into Label Studio, you must use the [Basic Label Studio JSON format](https://labelstud.io/guide/tasks#Basic-Label-Studio-JSON-format) and set up your tasks with the predictions JSON key. The Label Studio ML backend also outputs tasks in this format.
 
         #### JSON format for predictions
-
         Label Studio JSON format for pre-annotations must contain two sections:
-
-        - A data object which references the source of the data that the pre-annotations apply to. This can be a URL to an audio file, a pre-signed cloud storage link to an image, plain text, a reference to a CSV file stored in Label Studio, or something else.
-        - A predictions array that contains the pre-annotation results for the different types of labeling. See how to add results to the predictions array.
+        * A data object which references the source of the data that the pre-annotations apply to. This can be a URL to an audio file, a pre-signed cloud storage link to an image, plain text, a reference to a CSV file stored in Label Studio, or something else.
+        * A predictions array that contains the pre-annotation results for the different types of labeling. See how to add results to the predictions array.
 
         For more information, see [the JSON format reference in the Label Studio documentation](https://labelstud.io/guide/predictions#JSON-format-for-pre-annotations)
 
@@ -410,7 +483,7 @@ class AsyncPredictionsClient:
         task : typing.Optional[int]
             Task ID for which the prediction is created
 
-        result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]]
+        result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]]
             Prediction result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/predictions)
 
         score : typing.Optional[float]
@@ -429,44 +502,66 @@ class AsyncPredictionsClient:
 
         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.predictions.create(
-            result=[
-                {
-                    "original_width": 1920,
-                    "original_height": 1080,
-                    "image_rotation": 0,
-                    "from_name": "bboxes",
-                    "to_name": "image",
-                    "type": "rectanglelabels",
-                    "value": {
-                        "x": 20,
-                        "y": 30,
-                        "width": 50,
-                        "height": 60,
-                        "rotation": 0,
-                        "values": {"rectanglelabels": ["Person"]},
-                    },
-                }
-            ],
-            score=0.95,
-            model_version="yolo-v8",
-        )
+
+
+        async def main() -> None:
+            await client.predictions.create(
+                result=[
+                    {
+                        "original_width": 1920,
+                        "original_height": 1080,
+                        "image_rotation": 0,
+                        "from_name": "bboxes",
+                        "to_name": "image",
+                        "type": "rectanglelabels",
+                        "value": {
+                            "x": 20,
+                            "y": 30,
+                            "width": 50,
+                            "height": 60,
+                            "rotation": 0,
+                            "values": {"rectanglelabels": ["Person"]},
+                        },
+                    }
+                ],
+                score=0.95,
+                model_version="yolo-v8",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/predictions/",
             method="POST",
-            json={"task": task, "result": result, "score": score, "model_version": model_version},
+            json={
+                "task": task,
+                "result": result,
+                "score": score,
+                "model_version": model_version,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Prediction, _response.json())  # type: ignore
+                return typing.cast(
+                    Prediction,
+                    parse_obj_as(
+                        type_=Prediction,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -474,6 +569,7 @@ class AsyncPredictionsClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Prediction:
         """
+
         Get details about a specific prediction by its ID. To find the prediction ID, use [List predictions](list).
 
         For information about the prediction format, see [the JSON format reference in the Label Studio documentation](https://labelstud.io/guide/predictions#JSON-format-for-pre-annotations).
@@ -493,21 +589,37 @@ class AsyncPredictionsClient:
 
         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.predictions.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.predictions.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/predictions/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+            f"api/predictions/{jsonable_encoder(id)}/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Prediction, _response.json())  # type: ignore
+                return typing.cast(
+                    Prediction,
+                    parse_obj_as(
+                        type_=Prediction,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -515,6 +627,7 @@ class AsyncPredictionsClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a prediction. To find the prediction ID, use [List predictions](list).
 
         Parameters
@@ -531,17 +644,27 @@ class AsyncPredictionsClient:
 
         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.predictions.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.predictions.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/predictions/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+            f"api/predictions/{jsonable_encoder(id)}/",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -556,12 +679,13 @@ class AsyncPredictionsClient:
         id: int,
         *,
         task: typing.Optional[int] = OMIT,
-        result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] = OMIT,
+        result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]] = OMIT,
         score: typing.Optional[float] = OMIT,
         model_version: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Prediction:
         """
+
         Update a prediction. To find the prediction ID, use [List predictions](list).
 
         For information about the prediction format, see [the JSON format reference in the Label Studio documentation](https://labelstud.io/guide/predictions#JSON-format-for-pre-annotations).
@@ -574,7 +698,7 @@ class AsyncPredictionsClient:
         task : typing.Optional[int]
             Task ID for which the prediction is created
 
-        result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]]
+        result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]]
             Prediction result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/predictions)
 
         score : typing.Optional[float]
@@ -593,45 +717,67 @@ class AsyncPredictionsClient:
 
         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.predictions.update(
-            id=1,
-            result=[
-                {
-                    "original_width": 1920,
-                    "original_height": 1080,
-                    "image_rotation": 0,
-                    "from_name": "bboxes",
-                    "to_name": "image",
-                    "type": "rectanglelabels",
-                    "value": {
-                        "x": 20,
-                        "y": 30,
-                        "width": 50,
-                        "height": 60,
-                        "rotation": 0,
-                        "values": {"rectanglelabels": ["Person"]},
-                    },
-                }
-            ],
-            score=0.95,
-            model_version="yolo-v8",
-        )
+
+
+        async def main() -> None:
+            await client.predictions.update(
+                id=1,
+                result=[
+                    {
+                        "original_width": 1920,
+                        "original_height": 1080,
+                        "image_rotation": 0,
+                        "from_name": "bboxes",
+                        "to_name": "image",
+                        "type": "rectanglelabels",
+                        "value": {
+                            "x": 20,
+                            "y": 30,
+                            "width": 50,
+                            "height": 60,
+                            "rotation": 0,
+                            "values": {"rectanglelabels": ["Person"]},
+                        },
+                    }
+                ],
+                score=0.95,
+                model_version="yolo-v8",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/predictions/{jsonable_encoder(id)}/",
             method="PATCH",
-            json={"task": task, "result": result, "score": score, "model_version": model_version},
+            json={
+                "task": task,
+                "result": result,
+                "score": score,
+                "model_version": model_version,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Prediction, _response.json())  # type: ignore
+                return typing.cast(
+                    Prediction,
+                    parse_obj_as(
+                        type_=Prediction,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)

label_studio_sdk/projects/__init__.py

@@ -2,8 +2,11 @@
 
 from .types import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse, ProjectsUpdateResponse
 from . import exports
+from .exports import ExportsConvertResponse, ExportsListFormatsResponseItem
 
 __all__ = [
+    "ExportsConvertResponse",
+    "ExportsListFormatsResponseItem",
     "ProjectsCreateResponse",
     "ProjectsImportTasksResponse",
     "ProjectsListResponse",