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

label_studio_sdk/tasks/client.py

@@ -289,21 +289,21 @@ class TasksClient:
     def create(
         self,
         *,
+        cancelled_annotations: typing.Optional[int] = OMIT,
+        comment_authors: typing.Optional[typing.Sequence[int]] = OMIT,
+        comment_count: typing.Optional[int] = OMIT,
         data: typing.Optional[typing.Any] = OMIT,
-        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        file_upload: typing.Optional[int] = OMIT,
+        inner_id: typing.Optional[int] = OMIT,
         is_labeled: typing.Optional[bool] = OMIT,
+        last_comment_updated_at: typing.Optional[dt.datetime] = OMIT,
+        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
         overlap: typing.Optional[int] = OMIT,
-        inner_id: typing.Optional[int] = OMIT,
+        project: typing.Optional[int] = OMIT,
         total_annotations: typing.Optional[int] = OMIT,
-        cancelled_annotations: typing.Optional[int] = OMIT,
         total_predictions: typing.Optional[int] = OMIT,
-        comment_count: typing.Optional[int] = OMIT,
         unresolved_comment_count: typing.Optional[int] = OMIT,
-        last_comment_updated_at: typing.Optional[dt.datetime] = OMIT,
-        project: typing.Optional[int] = OMIT,
         updated_by: typing.Optional[int] = OMIT,
-        file_upload: typing.Optional[int] = OMIT,
-        comment_authors: typing.Optional[typing.Sequence[int]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LseTask:
         """
@@ -311,49 +311,49 @@ class TasksClient:
 
         Parameters
         ----------
+        cancelled_annotations : typing.Optional[int]
+            Number of total cancelled annotations for the current task
+
+        comment_authors : typing.Optional[typing.Sequence[int]]
+            Users who wrote comments
+
+        comment_count : typing.Optional[int]
+            Number of comments in the task including all annotations
+
         data : typing.Optional[typing.Any]
 
-        meta : typing.Optional[typing.Optional[typing.Any]]
+        file_upload : typing.Optional[int]
+            Uploaded file used as data source for this task
+
+        inner_id : typing.Optional[int]
+            Internal task ID in the project, starts with 1
 
         is_labeled : typing.Optional[bool]
             True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
 
+        last_comment_updated_at : typing.Optional[dt.datetime]
+            When the last comment was updated
+
+        meta : typing.Optional[typing.Optional[typing.Any]]
+
         overlap : typing.Optional[int]
             Number of distinct annotators that processed the current task
 
-        inner_id : typing.Optional[int]
-            Internal task ID in the project, starts with 1
+        project : typing.Optional[int]
+            Project ID for this task
 
         total_annotations : typing.Optional[int]
             Number of total annotations for the current task except cancelled annotations
 
-        cancelled_annotations : typing.Optional[int]
-            Number of total cancelled annotations for the current task
-
         total_predictions : typing.Optional[int]
             Number of total predictions for the current task
 
-        comment_count : typing.Optional[int]
-            Number of comments in the task including all annotations
-
         unresolved_comment_count : typing.Optional[int]
             Number of unresolved comments in the task including all annotations
 
-        last_comment_updated_at : typing.Optional[dt.datetime]
-            When the last comment was updated
-
-        project : typing.Optional[int]
-            Project ID for this task
-
         updated_by : typing.Optional[int]
             Last annotator or reviewer who updated this task
 
-        file_upload : typing.Optional[int]
-            Uploaded file used as data source for this task
-
-        comment_authors : typing.Optional[typing.Sequence[int]]
-            Users who wrote comments
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -377,21 +377,21 @@ class TasksClient:
             "api/tasks/",
             method="POST",
             json={
+                "cancelled_annotations": cancelled_annotations,
+                "comment_authors": comment_authors,
+                "comment_count": comment_count,
                 "data": data,
-                "meta": meta,
+                "file_upload": file_upload,
+                "inner_id": inner_id,
                 "is_labeled": is_labeled,
+                "last_comment_updated_at": last_comment_updated_at,
+                "meta": meta,
                 "overlap": overlap,
-                "inner_id": inner_id,
+                "project": project,
                 "total_annotations": total_annotations,
-                "cancelled_annotations": cancelled_annotations,
                 "total_predictions": total_predictions,
-                "comment_count": comment_count,
                 "unresolved_comment_count": unresolved_comment_count,
-                "last_comment_updated_at": last_comment_updated_at,
-                "project": project,
                 "updated_by": updated_by,
-                "file_upload": file_upload,
-                "comment_authors": comment_authors,
             },
             headers={
                 "content-type": "application/json",
@@ -504,26 +504,26 @@ class TasksClient:
         self,
         id: str,
         *,
-        inner_id: typing.Optional[int] = OMIT,
+        avg_lead_time: typing.Optional[float] = OMIT,
         cancelled_annotations: typing.Optional[int] = OMIT,
-        total_annotations: typing.Optional[int] = OMIT,
-        total_predictions: typing.Optional[int] = OMIT,
+        comment_count: typing.Optional[int] = OMIT,
         completed_at: typing.Optional[dt.datetime] = OMIT,
-        predictions_score: typing.Optional[float] = OMIT,
-        avg_lead_time: typing.Optional[float] = OMIT,
+        data: typing.Optional[typing.Optional[typing.Any]] = OMIT,
         draft_exists: typing.Optional[bool] = OMIT,
-        reviewed: typing.Optional[bool] = OMIT,
-        reviews_accepted: typing.Optional[int] = OMIT,
-        reviews_rejected: typing.Optional[int] = OMIT,
         ground_truth: typing.Optional[bool] = OMIT,
-        data: typing.Optional[typing.Optional[typing.Any]] = OMIT,
-        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        inner_id: typing.Optional[int] = OMIT,
         is_labeled: typing.Optional[bool] = OMIT,
-        overlap: typing.Optional[int] = OMIT,
-        comment_count: typing.Optional[int] = OMIT,
-        unresolved_comment_count: typing.Optional[int] = OMIT,
         last_comment_updated_at: typing.Optional[dt.datetime] = OMIT,
+        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        overlap: typing.Optional[int] = OMIT,
+        predictions_score: typing.Optional[float] = OMIT,
         project: typing.Optional[int] = OMIT,
+        reviewed: typing.Optional[bool] = OMIT,
+        reviews_accepted: typing.Optional[int] = OMIT,
+        reviews_rejected: typing.Optional[int] = OMIT,
+        total_annotations: typing.Optional[int] = OMIT,
+        total_predictions: typing.Optional[int] = OMIT,
+        unresolved_comment_count: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RoleBasedTask:
         """
@@ -534,52 +534,52 @@ class TasksClient:
         id : str
             Task ID
 
-        inner_id : typing.Optional[int]
+        avg_lead_time : typing.Optional[float]
 
         cancelled_annotations : typing.Optional[int]
 
-        total_annotations : typing.Optional[int]
-
-        total_predictions : typing.Optional[int]
+        comment_count : typing.Optional[int]
+            Number of comments in the task including all annotations
 
         completed_at : typing.Optional[dt.datetime]
 
-        predictions_score : typing.Optional[float]
-
-        avg_lead_time : typing.Optional[float]
+        data : typing.Optional[typing.Optional[typing.Any]]
 
         draft_exists : typing.Optional[bool]
 
-        reviewed : typing.Optional[bool]
-
-        reviews_accepted : typing.Optional[int]
-
-        reviews_rejected : typing.Optional[int]
-
         ground_truth : typing.Optional[bool]
 
-        data : typing.Optional[typing.Optional[typing.Any]]
-
-        meta : typing.Optional[typing.Optional[typing.Any]]
+        inner_id : typing.Optional[int]
 
         is_labeled : typing.Optional[bool]
             True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
 
-        overlap : typing.Optional[int]
-            Number of distinct annotators that processed the current task
+        last_comment_updated_at : typing.Optional[dt.datetime]
+            When the last comment was updated
 
-        comment_count : typing.Optional[int]
-            Number of comments in the task including all annotations
+        meta : typing.Optional[typing.Optional[typing.Any]]
 
-        unresolved_comment_count : typing.Optional[int]
-            Number of unresolved comments in the task including all annotations
+        overlap : typing.Optional[int]
+            Number of distinct annotators that processed the current task
 
-        last_comment_updated_at : typing.Optional[dt.datetime]
-            When the last comment was updated
+        predictions_score : typing.Optional[float]
 
         project : typing.Optional[int]
             Project ID for this task
 
+        reviewed : typing.Optional[bool]
+
+        reviews_accepted : typing.Optional[int]
+
+        reviews_rejected : typing.Optional[int]
+
+        total_annotations : typing.Optional[int]
+
+        total_predictions : typing.Optional[int]
+
+        unresolved_comment_count : typing.Optional[int]
+            Number of unresolved comments in the task including all annotations
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -603,26 +603,26 @@ class TasksClient:
             f"api/tasks/{jsonable_encoder(id)}/",
             method="PATCH",
             json={
-                "inner_id": inner_id,
+                "avg_lead_time": avg_lead_time,
                 "cancelled_annotations": cancelled_annotations,
-                "total_annotations": total_annotations,
-                "total_predictions": total_predictions,
+                "comment_count": comment_count,
                 "completed_at": completed_at,
-                "predictions_score": predictions_score,
-                "avg_lead_time": avg_lead_time,
+                "data": data,
                 "draft_exists": draft_exists,
-                "reviewed": reviewed,
-                "reviews_accepted": reviews_accepted,
-                "reviews_rejected": reviews_rejected,
                 "ground_truth": ground_truth,
-                "data": data,
-                "meta": meta,
+                "inner_id": inner_id,
                 "is_labeled": is_labeled,
-                "overlap": overlap,
-                "comment_count": comment_count,
-                "unresolved_comment_count": unresolved_comment_count,
                 "last_comment_updated_at": last_comment_updated_at,
+                "meta": meta,
+                "overlap": overlap,
+                "predictions_score": predictions_score,
                 "project": project,
+                "reviewed": reviewed,
+                "reviews_accepted": reviews_accepted,
+                "reviews_rejected": reviews_rejected,
+                "total_annotations": total_annotations,
+                "total_predictions": total_predictions,
+                "unresolved_comment_count": unresolved_comment_count,
             },
             headers={
                 "content-type": "application/json",
@@ -934,21 +934,21 @@ class AsyncTasksClient:
     async def create(
         self,
         *,
+        cancelled_annotations: typing.Optional[int] = OMIT,
+        comment_authors: typing.Optional[typing.Sequence[int]] = OMIT,
+        comment_count: typing.Optional[int] = OMIT,
         data: typing.Optional[typing.Any] = OMIT,
-        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        file_upload: typing.Optional[int] = OMIT,
+        inner_id: typing.Optional[int] = OMIT,
         is_labeled: typing.Optional[bool] = OMIT,
+        last_comment_updated_at: typing.Optional[dt.datetime] = OMIT,
+        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
         overlap: typing.Optional[int] = OMIT,
-        inner_id: typing.Optional[int] = OMIT,
+        project: typing.Optional[int] = OMIT,
         total_annotations: typing.Optional[int] = OMIT,
-        cancelled_annotations: typing.Optional[int] = OMIT,
         total_predictions: typing.Optional[int] = OMIT,
-        comment_count: typing.Optional[int] = OMIT,
         unresolved_comment_count: typing.Optional[int] = OMIT,
-        last_comment_updated_at: typing.Optional[dt.datetime] = OMIT,
-        project: typing.Optional[int] = OMIT,
         updated_by: typing.Optional[int] = OMIT,
-        file_upload: typing.Optional[int] = OMIT,
-        comment_authors: typing.Optional[typing.Sequence[int]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LseTask:
         """
@@ -956,49 +956,49 @@ class AsyncTasksClient:
 
         Parameters
         ----------
+        cancelled_annotations : typing.Optional[int]
+            Number of total cancelled annotations for the current task
+
+        comment_authors : typing.Optional[typing.Sequence[int]]
+            Users who wrote comments
+
+        comment_count : typing.Optional[int]
+            Number of comments in the task including all annotations
+
         data : typing.Optional[typing.Any]
 
-        meta : typing.Optional[typing.Optional[typing.Any]]
+        file_upload : typing.Optional[int]
+            Uploaded file used as data source for this task
+
+        inner_id : typing.Optional[int]
+            Internal task ID in the project, starts with 1
 
         is_labeled : typing.Optional[bool]
             True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
 
+        last_comment_updated_at : typing.Optional[dt.datetime]
+            When the last comment was updated
+
+        meta : typing.Optional[typing.Optional[typing.Any]]
+
         overlap : typing.Optional[int]
             Number of distinct annotators that processed the current task
 
-        inner_id : typing.Optional[int]
-            Internal task ID in the project, starts with 1
+        project : typing.Optional[int]
+            Project ID for this task
 
         total_annotations : typing.Optional[int]
             Number of total annotations for the current task except cancelled annotations
 
-        cancelled_annotations : typing.Optional[int]
-            Number of total cancelled annotations for the current task
-
         total_predictions : typing.Optional[int]
             Number of total predictions for the current task
 
-        comment_count : typing.Optional[int]
-            Number of comments in the task including all annotations
-
         unresolved_comment_count : typing.Optional[int]
             Number of unresolved comments in the task including all annotations
 
-        last_comment_updated_at : typing.Optional[dt.datetime]
-            When the last comment was updated
-
-        project : typing.Optional[int]
-            Project ID for this task
-
         updated_by : typing.Optional[int]
             Last annotator or reviewer who updated this task
 
-        file_upload : typing.Optional[int]
-            Uploaded file used as data source for this task
-
-        comment_authors : typing.Optional[typing.Sequence[int]]
-            Users who wrote comments
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1030,21 +1030,21 @@ class AsyncTasksClient:
             "api/tasks/",
             method="POST",
             json={
+                "cancelled_annotations": cancelled_annotations,
+                "comment_authors": comment_authors,
+                "comment_count": comment_count,
                 "data": data,
-                "meta": meta,
+                "file_upload": file_upload,
+                "inner_id": inner_id,
                 "is_labeled": is_labeled,
+                "last_comment_updated_at": last_comment_updated_at,
+                "meta": meta,
                 "overlap": overlap,
-                "inner_id": inner_id,
+                "project": project,
                 "total_annotations": total_annotations,
-                "cancelled_annotations": cancelled_annotations,
                 "total_predictions": total_predictions,
-                "comment_count": comment_count,
                 "unresolved_comment_count": unresolved_comment_count,
-                "last_comment_updated_at": last_comment_updated_at,
-                "project": project,
                 "updated_by": updated_by,
-                "file_upload": file_upload,
-                "comment_authors": comment_authors,
             },
             headers={
                 "content-type": "application/json",
@@ -1173,26 +1173,26 @@ class AsyncTasksClient:
         self,
         id: str,
         *,
-        inner_id: typing.Optional[int] = OMIT,
+        avg_lead_time: typing.Optional[float] = OMIT,
         cancelled_annotations: typing.Optional[int] = OMIT,
-        total_annotations: typing.Optional[int] = OMIT,
-        total_predictions: typing.Optional[int] = OMIT,
+        comment_count: typing.Optional[int] = OMIT,
         completed_at: typing.Optional[dt.datetime] = OMIT,
-        predictions_score: typing.Optional[float] = OMIT,
-        avg_lead_time: typing.Optional[float] = OMIT,
+        data: typing.Optional[typing.Optional[typing.Any]] = OMIT,
         draft_exists: typing.Optional[bool] = OMIT,
-        reviewed: typing.Optional[bool] = OMIT,
-        reviews_accepted: typing.Optional[int] = OMIT,
-        reviews_rejected: typing.Optional[int] = OMIT,
         ground_truth: typing.Optional[bool] = OMIT,
-        data: typing.Optional[typing.Optional[typing.Any]] = OMIT,
-        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        inner_id: typing.Optional[int] = OMIT,
         is_labeled: typing.Optional[bool] = OMIT,
-        overlap: typing.Optional[int] = OMIT,
-        comment_count: typing.Optional[int] = OMIT,
-        unresolved_comment_count: typing.Optional[int] = OMIT,
         last_comment_updated_at: typing.Optional[dt.datetime] = OMIT,
+        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        overlap: typing.Optional[int] = OMIT,
+        predictions_score: typing.Optional[float] = OMIT,
         project: typing.Optional[int] = OMIT,
+        reviewed: typing.Optional[bool] = OMIT,
+        reviews_accepted: typing.Optional[int] = OMIT,
+        reviews_rejected: typing.Optional[int] = OMIT,
+        total_annotations: typing.Optional[int] = OMIT,
+        total_predictions: typing.Optional[int] = OMIT,
+        unresolved_comment_count: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RoleBasedTask:
         """
@@ -1203,52 +1203,52 @@ class AsyncTasksClient:
         id : str
             Task ID
 
-        inner_id : typing.Optional[int]
+        avg_lead_time : typing.Optional[float]
 
         cancelled_annotations : typing.Optional[int]
 
-        total_annotations : typing.Optional[int]
-
-        total_predictions : typing.Optional[int]
+        comment_count : typing.Optional[int]
+            Number of comments in the task including all annotations
 
         completed_at : typing.Optional[dt.datetime]
 
-        predictions_score : typing.Optional[float]
-
-        avg_lead_time : typing.Optional[float]
+        data : typing.Optional[typing.Optional[typing.Any]]
 
         draft_exists : typing.Optional[bool]
 
-        reviewed : typing.Optional[bool]
-
-        reviews_accepted : typing.Optional[int]
-
-        reviews_rejected : typing.Optional[int]
-
         ground_truth : typing.Optional[bool]
 
-        data : typing.Optional[typing.Optional[typing.Any]]
-
-        meta : typing.Optional[typing.Optional[typing.Any]]
+        inner_id : typing.Optional[int]
 
         is_labeled : typing.Optional[bool]
             True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
 
-        overlap : typing.Optional[int]
-            Number of distinct annotators that processed the current task
+        last_comment_updated_at : typing.Optional[dt.datetime]
+            When the last comment was updated
 
-        comment_count : typing.Optional[int]
-            Number of comments in the task including all annotations
+        meta : typing.Optional[typing.Optional[typing.Any]]
 
-        unresolved_comment_count : typing.Optional[int]
-            Number of unresolved comments in the task including all annotations
+        overlap : typing.Optional[int]
+            Number of distinct annotators that processed the current task
 
-        last_comment_updated_at : typing.Optional[dt.datetime]
-            When the last comment was updated
+        predictions_score : typing.Optional[float]
 
         project : typing.Optional[int]
             Project ID for this task
 
+        reviewed : typing.Optional[bool]
+
+        reviews_accepted : typing.Optional[int]
+
+        reviews_rejected : typing.Optional[int]
+
+        total_annotations : typing.Optional[int]
+
+        total_predictions : typing.Optional[int]
+
+        unresolved_comment_count : typing.Optional[int]
+            Number of unresolved comments in the task including all annotations
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1280,26 +1280,26 @@ class AsyncTasksClient:
             f"api/tasks/{jsonable_encoder(id)}/",
             method="PATCH",
             json={
-                "inner_id": inner_id,
+                "avg_lead_time": avg_lead_time,
                 "cancelled_annotations": cancelled_annotations,
-                "total_annotations": total_annotations,
-                "total_predictions": total_predictions,
+                "comment_count": comment_count,
                 "completed_at": completed_at,
-                "predictions_score": predictions_score,
-                "avg_lead_time": avg_lead_time,
+                "data": data,
                 "draft_exists": draft_exists,
-                "reviewed": reviewed,
-                "reviews_accepted": reviews_accepted,
-                "reviews_rejected": reviews_rejected,
                 "ground_truth": ground_truth,
-                "data": data,
-                "meta": meta,
+                "inner_id": inner_id,
                 "is_labeled": is_labeled,
-                "overlap": overlap,
-                "comment_count": comment_count,
-                "unresolved_comment_count": unresolved_comment_count,
                 "last_comment_updated_at": last_comment_updated_at,
+                "meta": meta,
+                "overlap": overlap,
+                "predictions_score": predictions_score,
                 "project": project,
+                "reviewed": reviewed,
+                "reviews_accepted": reviews_accepted,
+                "reviews_rejected": reviews_rejected,
+                "total_annotations": total_annotations,
+                "total_predictions": total_predictions,
+                "unresolved_comment_count": unresolved_comment_count,
             },
             headers={
                 "content-type": "application/json",