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

label_studio_sdk/predictions/client.py

@@ -4,7 +4,7 @@ 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 ..core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ..core.api_error import ApiError
 from ..core.jsonable_encoder import jsonable_encoder
@@ -21,28 +21,21 @@ class PredictionsClient:
     def list(
         self,
         *,
-        task: typing.Optional[int] = None,
         project: typing.Optional[int] = None,
+        task: typing.Optional[int] = None,
         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>
-
-        Predictions can be [imported directly into Label Studio](https://labelstud.io/guide/predictions) or [generated by a connected ML backend](https://labelstud.io/guide/ml.html#Pre-annotations-predictions).
-
-        To import predictions via the API, see [Create prediction](create).
+        List all predictions and their IDs.
 
         Parameters
         ----------
-        task : typing.Optional[int]
-            Filter predictions by task ID
-
         project : typing.Optional[int]
             Filter predictions by project ID
 
+        task : typing.Optional[int]
+            Filter predictions by task ID
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -64,8 +57,8 @@ class PredictionsClient:
             "api/predictions/",
             method="GET",
             params={
-                "task": task,
                 "project": project,
+                "task": task,
             },
             request_options=request_options,
         )
@@ -73,7 +66,7 @@ class PredictionsClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[Prediction],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[Prediction],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -93,17 +86,7 @@ class PredictionsClient:
         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.
-
-        For more information, see [the JSON format reference in the Label Studio documentation](https://labelstud.io/guide/predictions#JSON-format-for-pre-annotations)
+        Create a prediction for a specific task.
 
         Parameters
         ----------
@@ -176,7 +159,7 @@ class PredictionsClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Prediction,
-                    parse_obj_as(
+                    construct_type(
                         type_=Prediction,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -188,10 +171,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).
+        Get details about a specific prediction by its ID.
 
         Parameters
         ----------
@@ -226,7 +206,7 @@ class PredictionsClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Prediction,
-                    parse_obj_as(
+                    construct_type(
                         type_=Prediction,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -238,8 +218,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).
+        Delete a prediction by prediction ID.
 
         Parameters
         ----------
@@ -288,10 +267,7 @@ class PredictionsClient:
         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).
+        Update prediction data by prediction ID.
 
         Parameters
         ----------
@@ -368,7 +344,7 @@ class PredictionsClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Prediction,
-                    parse_obj_as(
+                    construct_type(
                         type_=Prediction,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -386,28 +362,21 @@ class AsyncPredictionsClient:
     async def list(
         self,
         *,
-        task: typing.Optional[int] = None,
         project: typing.Optional[int] = None,
+        task: typing.Optional[int] = None,
         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>
-
-        Predictions can be [imported directly into Label Studio](https://labelstud.io/guide/predictions) or [generated by a connected ML backend](https://labelstud.io/guide/ml.html#Pre-annotations-predictions).
-
-        To import predictions via the API, see [Create prediction](create).
+        List all predictions and their IDs.
 
         Parameters
         ----------
-        task : typing.Optional[int]
-            Filter predictions by task ID
-
         project : typing.Optional[int]
             Filter predictions by project ID
 
+        task : typing.Optional[int]
+            Filter predictions by task ID
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -437,8 +406,8 @@ class AsyncPredictionsClient:
             "api/predictions/",
             method="GET",
             params={
-                "task": task,
                 "project": project,
+                "task": task,
             },
             request_options=request_options,
         )
@@ -446,7 +415,7 @@ class AsyncPredictionsClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[Prediction],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[Prediction],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -466,17 +435,7 @@ class AsyncPredictionsClient:
         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.
-
-        For more information, see [the JSON format reference in the Label Studio documentation](https://labelstud.io/guide/predictions#JSON-format-for-pre-annotations)
+        Create a prediction for a specific task.
 
         Parameters
         ----------
@@ -557,7 +516,7 @@ class AsyncPredictionsClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Prediction,
-                    parse_obj_as(
+                    construct_type(
                         type_=Prediction,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -569,10 +528,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).
+        Get details about a specific prediction by its ID.
 
         Parameters
         ----------
@@ -615,7 +571,7 @@ class AsyncPredictionsClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Prediction,
-                    parse_obj_as(
+                    construct_type(
                         type_=Prediction,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -627,8 +583,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).
+        Delete a prediction by prediction ID.
 
         Parameters
         ----------
@@ -685,10 +640,7 @@ class AsyncPredictionsClient:
         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).
+        Update prediction data by prediction ID.
 
         Parameters
         ----------
@@ -773,7 +725,7 @@ class AsyncPredictionsClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Prediction,
-                    parse_obj_as(
+                    construct_type(
                         type_=Prediction,  # type: ignore
                         object_=_response.json(),
                     ),

label_studio_sdk/projects/__init__.py

@@ -1,23 +1,32 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .types import (
-    ProjectsCreateResponse,
+    LseProjectCreateRequestSampling,
+    LseProjectCreateRequestSkipQueue,
+    PatchedLseProjectUpdateRequestSampling,
+    PatchedLseProjectUpdateRequestSkipQueue,
+    ProjectsDuplicateResponse,
     ProjectsImportTasksResponse,
     ProjectsListRequestFilter,
-    ProjectsListResponse,
-    ProjectsUpdateResponse,
 )
-from . import exports, pauses
-from .exports import ExportsConvertResponse, ExportsListFormatsResponseItem
+from . import exports, pauses, stats
+from .exports import ExportsConvertResponse
+from .stats import StatsIaaResponse, StatsIaaResponseCommonTasks, StatsIaaResponseIaa, StatsIaaResponseStd
 
 __all__ = [
     "ExportsConvertResponse",
-    "ExportsListFormatsResponseItem",
-    "ProjectsCreateResponse",
+    "LseProjectCreateRequestSampling",
+    "LseProjectCreateRequestSkipQueue",
+    "PatchedLseProjectUpdateRequestSampling",
+    "PatchedLseProjectUpdateRequestSkipQueue",
+    "ProjectsDuplicateResponse",
     "ProjectsImportTasksResponse",
     "ProjectsListRequestFilter",
-    "ProjectsListResponse",
-    "ProjectsUpdateResponse",
+    "StatsIaaResponse",
+    "StatsIaaResponseCommonTasks",
+    "StatsIaaResponseIaa",
+    "StatsIaaResponseStd",
     "exports",
     "pauses",
+    "stats",
 ]