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

label_studio_sdk/predictions/client.py

@@ -79,10 +79,10 @@ class PredictionsClient:
     def create(
         self,
         *,
-        task: typing.Optional[int] = OMIT,
+        model_version: typing.Optional[str] = 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,
+        task: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Prediction:
         """
@@ -90,8 +90,8 @@ class PredictionsClient:
 
         Parameters
         ----------
-        task : typing.Optional[int]
-            Task ID for which the prediction is created
+        model_version : typing.Optional[str]
+            Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
 
         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)
@@ -99,8 +99,8 @@ class PredictionsClient:
         score : typing.Optional[float]
             Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first.
 
-        model_version : typing.Optional[str]
-            Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
+        task : typing.Optional[int]
+            Task ID for which the prediction is created
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -118,36 +118,36 @@ class PredictionsClient:
             api_key="YOUR_API_KEY",
         )
         client.predictions.create(
+            model_version="yolo-v8",
             result=[
                 {
-                    "original_width": 1920,
-                    "original_height": 1080,
-                    "image_rotation": 0,
                     "from_name": "bboxes",
+                    "image_rotation": 0,
+                    "original_height": 1080,
+                    "original_width": 1920,
                     "to_name": "image",
                     "type": "rectanglelabels",
                     "value": {
-                        "x": 20,
-                        "y": 30,
-                        "width": 50,
                         "height": 60,
                         "rotation": 0,
                         "values": {"rectanglelabels": ["Person"]},
+                        "width": 50,
+                        "x": 20,
+                        "y": 30,
                     },
                 }
             ],
             score=0.95,
-            model_version="yolo-v8",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             "api/predictions/",
             method="POST",
             json={
-                "task": task,
+                "model_version": model_version,
                 "result": result,
                 "score": score,
-                "model_version": model_version,
+                "task": task,
             },
             headers={
                 "content-type": "application/json",
@@ -260,10 +260,10 @@ class PredictionsClient:
         self,
         id: int,
         *,
-        task: typing.Optional[int] = OMIT,
+        model_version: typing.Optional[str] = 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,
+        task: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Prediction:
         """
@@ -274,8 +274,8 @@ class PredictionsClient:
         id : int
             Prediction ID
 
-        task : typing.Optional[int]
-            Task ID for which the prediction is created
+        model_version : typing.Optional[str]
+            Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
 
         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)
@@ -283,8 +283,8 @@ class PredictionsClient:
         score : typing.Optional[float]
             Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first.
 
-        model_version : typing.Optional[str]
-            Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
+        task : typing.Optional[int]
+            Task ID for which the prediction is created
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -303,36 +303,36 @@ class PredictionsClient:
         )
         client.predictions.update(
             id=1,
+            model_version="yolo-v8",
             result=[
                 {
-                    "original_width": 1920,
-                    "original_height": 1080,
-                    "image_rotation": 0,
                     "from_name": "bboxes",
+                    "image_rotation": 0,
+                    "original_height": 1080,
+                    "original_width": 1920,
                     "to_name": "image",
                     "type": "rectanglelabels",
                     "value": {
-                        "x": 20,
-                        "y": 30,
-                        "width": 50,
                         "height": 60,
                         "rotation": 0,
                         "values": {"rectanglelabels": ["Person"]},
+                        "width": 50,
+                        "x": 20,
+                        "y": 30,
                     },
                 }
             ],
             score=0.95,
-            model_version="yolo-v8",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             f"api/predictions/{jsonable_encoder(id)}/",
             method="PATCH",
             json={
-                "task": task,
+                "model_version": model_version,
                 "result": result,
                 "score": score,
-                "model_version": model_version,
+                "task": task,
             },
             headers={
                 "content-type": "application/json",
@@ -428,10 +428,10 @@ class AsyncPredictionsClient:
     async def create(
         self,
         *,
-        task: typing.Optional[int] = OMIT,
+        model_version: typing.Optional[str] = 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,
+        task: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Prediction:
         """
@@ -439,8 +439,8 @@ class AsyncPredictionsClient:
 
         Parameters
         ----------
-        task : typing.Optional[int]
-            Task ID for which the prediction is created
+        model_version : typing.Optional[str]
+            Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
 
         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)
@@ -448,8 +448,8 @@ class AsyncPredictionsClient:
         score : typing.Optional[float]
             Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first.
 
-        model_version : typing.Optional[str]
-            Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
+        task : typing.Optional[int]
+            Task ID for which the prediction is created
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -472,26 +472,26 @@ class AsyncPredictionsClient:
 
         async def main() -> None:
             await client.predictions.create(
+                model_version="yolo-v8",
                 result=[
                     {
-                        "original_width": 1920,
-                        "original_height": 1080,
-                        "image_rotation": 0,
                         "from_name": "bboxes",
+                        "image_rotation": 0,
+                        "original_height": 1080,
+                        "original_width": 1920,
                         "to_name": "image",
                         "type": "rectanglelabels",
                         "value": {
-                            "x": 20,
-                            "y": 30,
-                            "width": 50,
                             "height": 60,
                             "rotation": 0,
                             "values": {"rectanglelabels": ["Person"]},
+                            "width": 50,
+                            "x": 20,
+                            "y": 30,
                         },
                     }
                 ],
                 score=0.95,
-                model_version="yolo-v8",
             )
 
 
@@ -501,10 +501,10 @@ class AsyncPredictionsClient:
             "api/predictions/",
             method="POST",
             json={
-                "task": task,
+                "model_version": model_version,
                 "result": result,
                 "score": score,
-                "model_version": model_version,
+                "task": task,
             },
             headers={
                 "content-type": "application/json",
@@ -633,10 +633,10 @@ class AsyncPredictionsClient:
         self,
         id: int,
         *,
-        task: typing.Optional[int] = OMIT,
+        model_version: typing.Optional[str] = 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,
+        task: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Prediction:
         """
@@ -647,8 +647,8 @@ class AsyncPredictionsClient:
         id : int
             Prediction ID
 
-        task : typing.Optional[int]
-            Task ID for which the prediction is created
+        model_version : typing.Optional[str]
+            Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
 
         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)
@@ -656,8 +656,8 @@ class AsyncPredictionsClient:
         score : typing.Optional[float]
             Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first.
 
-        model_version : typing.Optional[str]
-            Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
+        task : typing.Optional[int]
+            Task ID for which the prediction is created
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -681,26 +681,26 @@ class AsyncPredictionsClient:
         async def main() -> None:
             await client.predictions.update(
                 id=1,
+                model_version="yolo-v8",
                 result=[
                     {
-                        "original_width": 1920,
-                        "original_height": 1080,
-                        "image_rotation": 0,
                         "from_name": "bboxes",
+                        "image_rotation": 0,
+                        "original_height": 1080,
+                        "original_width": 1920,
                         "to_name": "image",
                         "type": "rectanglelabels",
                         "value": {
-                            "x": 20,
-                            "y": 30,
-                            "width": 50,
                             "height": 60,
                             "rotation": 0,
                             "values": {"rectanglelabels": ["Person"]},
+                            "width": 50,
+                            "x": 20,
+                            "y": 30,
                         },
                     }
                 ],
                 score=0.95,
-                model_version="yolo-v8",
             )
 
 
@@ -710,10 +710,10 @@ class AsyncPredictionsClient:
             f"api/predictions/{jsonable_encoder(id)}/",
             method="PATCH",
             json={
-                "task": task,
+                "model_version": model_version,
                 "result": result,
                 "score": score,
-                "model_version": model_version,
+                "task": task,
             },
             headers={
                 "content-type": "application/json",

label_studio_sdk/projects/__init__.py

@@ -9,11 +9,39 @@ from .types import (
     ProjectsImportTasksResponse,
     ProjectsListRequestFilter,
 )
-from . import exports, pauses, stats
+from . import assignments, exports, pauses, stats
+from .assignments import (
+    AssignmentsAssignRequestType,
+    AssignmentsBulkAssignRequestFilters,
+    AssignmentsBulkAssignRequestFiltersConjunction,
+    AssignmentsBulkAssignRequestFiltersItemsItem,
+    AssignmentsBulkAssignRequestFiltersItemsItemFilter,
+    AssignmentsBulkAssignRequestFiltersItemsItemOperator,
+    AssignmentsBulkAssignRequestFiltersItemsItemValue,
+    AssignmentsBulkAssignRequestSelectedItems,
+    AssignmentsBulkAssignRequestSelectedItemsExcluded,
+    AssignmentsBulkAssignRequestSelectedItemsIncluded,
+    AssignmentsBulkAssignRequestType,
+    AssignmentsBulkAssignResponse,
+    AssignmentsUpdateRequestType,
+)
 from .exports import ExportsConvertResponse
 from .stats import StatsIaaResponse, StatsIaaResponseCommonTasks, StatsIaaResponseIaa, StatsIaaResponseStd
 
 __all__ = [
+    "AssignmentsAssignRequestType",
+    "AssignmentsBulkAssignRequestFilters",
+    "AssignmentsBulkAssignRequestFiltersConjunction",
+    "AssignmentsBulkAssignRequestFiltersItemsItem",
+    "AssignmentsBulkAssignRequestFiltersItemsItemFilter",
+    "AssignmentsBulkAssignRequestFiltersItemsItemOperator",
+    "AssignmentsBulkAssignRequestFiltersItemsItemValue",
+    "AssignmentsBulkAssignRequestSelectedItems",
+    "AssignmentsBulkAssignRequestSelectedItemsExcluded",
+    "AssignmentsBulkAssignRequestSelectedItemsIncluded",
+    "AssignmentsBulkAssignRequestType",
+    "AssignmentsBulkAssignResponse",
+    "AssignmentsUpdateRequestType",
     "ExportsConvertResponse",
     "LseProjectCreateRequestSampling",
     "LseProjectCreateRequestSkipQueue",
@@ -26,6 +54,7 @@ __all__ = [
     "StatsIaaResponseCommonTasks",
     "StatsIaaResponseIaa",
     "StatsIaaResponseStd",
+    "assignments",
     "exports",
     "pauses",
     "stats",

label_studio_sdk/projects/assignments/__init__.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    AssignmentsAssignRequestType,
+    AssignmentsBulkAssignRequestFilters,
+    AssignmentsBulkAssignRequestFiltersConjunction,
+    AssignmentsBulkAssignRequestFiltersItemsItem,
+    AssignmentsBulkAssignRequestFiltersItemsItemFilter,
+    AssignmentsBulkAssignRequestFiltersItemsItemOperator,
+    AssignmentsBulkAssignRequestFiltersItemsItemValue,
+    AssignmentsBulkAssignRequestSelectedItems,
+    AssignmentsBulkAssignRequestSelectedItemsExcluded,
+    AssignmentsBulkAssignRequestSelectedItemsIncluded,
+    AssignmentsBulkAssignRequestType,
+    AssignmentsBulkAssignResponse,
+    AssignmentsUpdateRequestType,
+)
+
+__all__ = [
+    "AssignmentsAssignRequestType",
+    "AssignmentsBulkAssignRequestFilters",
+    "AssignmentsBulkAssignRequestFiltersConjunction",
+    "AssignmentsBulkAssignRequestFiltersItemsItem",
+    "AssignmentsBulkAssignRequestFiltersItemsItemFilter",
+    "AssignmentsBulkAssignRequestFiltersItemsItemOperator",
+    "AssignmentsBulkAssignRequestFiltersItemsItemValue",
+    "AssignmentsBulkAssignRequestSelectedItems",
+    "AssignmentsBulkAssignRequestSelectedItemsExcluded",
+    "AssignmentsBulkAssignRequestSelectedItemsIncluded",
+    "AssignmentsBulkAssignRequestType",
+    "AssignmentsBulkAssignResponse",
+    "AssignmentsUpdateRequestType",
+]