label-studio-sdk 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

label_studio_sdk/__init__.py

@@ -4,14 +4,22 @@ from .types import (
     Annotation,
     AnnotationFilterOptions,
     AnnotationLastAction,
+    AnnotationsDmField,
+    AnnotationsDmFieldLastAction,
     AzureBlobExportStorage,
     AzureBlobExportStorageStatus,
     AzureBlobImportStorage,
     AzureBlobImportStorageStatus,
     BaseTask,
+    BaseTaskFileUpload,
+    BaseTaskUpdatedBy,
     BaseUser,
     ConvertedFormat,
     ConvertedFormatStatus,
+    DataManagerTaskSerializer,
+    DataManagerTaskSerializerAnnotatorsItem,
+    DataManagerTaskSerializerDraftsItem,
+    DataManagerTaskSerializerPredictionsItem,
     Export,
     ExportConvert,
     ExportCreate,
@@ -49,6 +57,7 @@ from .types import (
     SerializationOption,
     SerializationOptions,
     Task,
+    TaskAnnotatorsItem,
     TaskFilterOptions,
     UserSimple,
     View,
@@ -79,6 +88,7 @@ from .actions import (
     ActionsCreateRequestFiltersItemsItem,
     ActionsCreateRequestFiltersItemsItemFilter,
     ActionsCreateRequestFiltersItemsItemOperator,
+    ActionsCreateRequestFiltersItemsItemValue,
     ActionsCreateRequestId,
     ActionsCreateRequestOrderingItem,
     ActionsCreateRequestSelectedItems,
@@ -96,7 +106,7 @@ from .ml import (
     MlUpdateResponse,
     MlUpdateResponseAuthMethod,
 )
-from .projects import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse
+from .projects import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse, ProjectsUpdateResponse
 from .tasks import TasksListRequestFields, TasksListResponse
 from .users import UsersGetTokenResponse, UsersResetTokenResponse
 from .version import __version__
@@ -107,6 +117,7 @@ from .views import (
     ViewsCreateRequestDataFiltersItemsItem,
     ViewsCreateRequestDataFiltersItemsItemFilter,
     ViewsCreateRequestDataFiltersItemsItemOperator,
+    ViewsCreateRequestDataFiltersItemsItemValue,
     ViewsCreateRequestDataOrderingItem,
     ViewsUpdateRequestData,
     ViewsUpdateRequestDataFilters,
@@ -114,6 +125,7 @@ from .views import (
     ViewsUpdateRequestDataFiltersItemsItem,
     ViewsUpdateRequestDataFiltersItemsItemFilter,
     ViewsUpdateRequestDataFiltersItemsItemOperator,
+    ViewsUpdateRequestDataFiltersItemsItemValue,
     ViewsUpdateRequestDataOrderingItem,
 )
 from .webhooks import WebhooksUpdateRequestActionsItem
@@ -124,6 +136,7 @@ __all__ = [
     "ActionsCreateRequestFiltersItemsItem",
     "ActionsCreateRequestFiltersItemsItemFilter",
     "ActionsCreateRequestFiltersItemsItemOperator",
+    "ActionsCreateRequestFiltersItemsItemValue",
     "ActionsCreateRequestId",
     "ActionsCreateRequestOrderingItem",
     "ActionsCreateRequestSelectedItems",
@@ -132,16 +145,24 @@ __all__ = [
     "Annotation",
     "AnnotationFilterOptions",
     "AnnotationLastAction",
+    "AnnotationsDmField",
+    "AnnotationsDmFieldLastAction",
     "AzureBlobExportStorage",
     "AzureBlobExportStorageStatus",
     "AzureBlobImportStorage",
     "AzureBlobImportStorageStatus",
     "BadRequestError",
     "BaseTask",
+    "BaseTaskFileUpload",
+    "BaseTaskUpdatedBy",
     "BaseUser",
     "Client",
     "ConvertedFormat",
     "ConvertedFormatStatus",
+    "DataManagerTaskSerializer",
+    "DataManagerTaskSerializerAnnotatorsItem",
+    "DataManagerTaskSerializerDraftsItem",
+    "DataManagerTaskSerializerPredictionsItem",
     "Export",
     "ExportConvert",
     "ExportCreate",
@@ -181,6 +202,7 @@ __all__ = [
     "ProjectsCreateResponse",
     "ProjectsImportTasksResponse",
     "ProjectsListResponse",
+    "ProjectsUpdateResponse",
     "RedisExportStorage",
     "RedisExportStorageStatus",
     "RedisImportStorage",
@@ -192,6 +214,7 @@ __all__ = [
     "SerializationOption",
     "SerializationOptions",
     "Task",
+    "TaskAnnotatorsItem",
     "TaskFilterOptions",
     "TasksListRequestFields",
     "TasksListResponse",
@@ -205,6 +228,7 @@ __all__ = [
     "ViewsCreateRequestDataFiltersItemsItem",
     "ViewsCreateRequestDataFiltersItemsItemFilter",
     "ViewsCreateRequestDataFiltersItemsItemOperator",
+    "ViewsCreateRequestDataFiltersItemsItemValue",
     "ViewsCreateRequestDataOrderingItem",
     "ViewsUpdateRequestData",
     "ViewsUpdateRequestDataFilters",
@@ -212,6 +236,7 @@ __all__ = [
     "ViewsUpdateRequestDataFiltersItemsItem",
     "ViewsUpdateRequestDataFiltersItemsItemFilter",
     "ViewsUpdateRequestDataFiltersItemsItemOperator",
+    "ViewsUpdateRequestDataFiltersItemsItemValue",
     "ViewsUpdateRequestDataOrderingItem",
     "Webhook",
     "WebhookActionsItem",

label_studio_sdk/actions/__init__.py

@@ -6,6 +6,7 @@ from .types import (
     ActionsCreateRequestFiltersItemsItem,
     ActionsCreateRequestFiltersItemsItemFilter,
     ActionsCreateRequestFiltersItemsItemOperator,
+    ActionsCreateRequestFiltersItemsItemValue,
     ActionsCreateRequestId,
     ActionsCreateRequestOrderingItem,
     ActionsCreateRequestSelectedItems,
@@ -19,6 +20,7 @@ __all__ = [
     "ActionsCreateRequestFiltersItemsItem",
     "ActionsCreateRequestFiltersItemsItemFilter",
     "ActionsCreateRequestFiltersItemsItemOperator",
+    "ActionsCreateRequestFiltersItemsItemValue",
     "ActionsCreateRequestId",
     "ActionsCreateRequestOrderingItem",
     "ActionsCreateRequestSelectedItems",

label_studio_sdk/actions/client.py

@@ -55,8 +55,8 @@ class ActionsClient:
     def create(
         self,
         *,
-        id: typing.Optional[ActionsCreateRequestId] = None,
-        project: typing.Optional[int] = None,
+        id: ActionsCreateRequestId,
+        project: int,
         view: typing.Optional[int] = None,
         filters: typing.Optional[ActionsCreateRequestFilters] = OMIT,
         selected_items: typing.Optional[ActionsCreateRequestSelectedItems] = OMIT,
@@ -64,14 +64,14 @@ class ActionsClient:
         request_options: typing.Optional[RequestOptions] = None
     ) -> None:
         """
-        Perform a Data Manager action with the selected tasks and filters.
+        Perform a Data Manager action with the selected tasks and filters. Note: More complex actions require additional parameters in the request body. Call `GET api/actions?project=<id>` to explore them. <br>Example: `GET api/actions?id=delete_tasks&project=1`
 
         Parameters
         ----------
-        id : typing.Optional[ActionsCreateRequestId]
-            Action name ID, the full list of actions can be retrieved with a GET request
+        id : ActionsCreateRequestId
+            Action name ID, see the full list of actions in the `GET api/actions` request
 
-        project : typing.Optional[int]
+        project : int
             Project ID
 
         view : typing.Optional[int]
@@ -95,12 +95,36 @@ class ActionsClient:
 
         Examples
         --------
+        from label_studio_sdk import (
+            ActionsCreateRequestFilters,
+            ActionsCreateRequestFiltersItemsItem,
+            ActionsCreateRequestSelectedItemsExcluded,
+        )
         from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.actions.create()
+        client.actions.create(
+            id="retrieve_tasks_predictions",
+            project=1,
+            filters=ActionsCreateRequestFilters(
+                conjunction="or",
+                items=[
+                    ActionsCreateRequestFiltersItemsItem(
+                        filter="filter:tasks:id",
+                        operator="greater",
+                        type="Number",
+                        value=123,
+                    )
+                ],
+            ),
+            selected_items=ActionsCreateRequestSelectedItemsExcluded(
+                all_=True,
+                excluded=[124, 125, 126],
+            ),
+            ordering=["tasks:total_annotations"],
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "api/dm/actions/",
@@ -159,8 +183,8 @@ class AsyncActionsClient:
     async def create(
         self,
         *,
-        id: typing.Optional[ActionsCreateRequestId] = None,
-        project: typing.Optional[int] = None,
+        id: ActionsCreateRequestId,
+        project: int,
         view: typing.Optional[int] = None,
         filters: typing.Optional[ActionsCreateRequestFilters] = OMIT,
         selected_items: typing.Optional[ActionsCreateRequestSelectedItems] = OMIT,
@@ -168,14 +192,14 @@ class AsyncActionsClient:
         request_options: typing.Optional[RequestOptions] = None
     ) -> None:
         """
-        Perform a Data Manager action with the selected tasks and filters.
+        Perform a Data Manager action with the selected tasks and filters. Note: More complex actions require additional parameters in the request body. Call `GET api/actions?project=<id>` to explore them. <br>Example: `GET api/actions?id=delete_tasks&project=1`
 
         Parameters
         ----------
-        id : typing.Optional[ActionsCreateRequestId]
-            Action name ID, the full list of actions can be retrieved with a GET request
+        id : ActionsCreateRequestId
+            Action name ID, see the full list of actions in the `GET api/actions` request
 
-        project : typing.Optional[int]
+        project : int
             Project ID
 
         view : typing.Optional[int]
@@ -199,12 +223,36 @@ class AsyncActionsClient:
 
         Examples
         --------
+        from label_studio_sdk import (
+            ActionsCreateRequestFilters,
+            ActionsCreateRequestFiltersItemsItem,
+            ActionsCreateRequestSelectedItemsExcluded,
+        )
         from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.actions.create()
+        await client.actions.create(
+            id="retrieve_tasks_predictions",
+            project=1,
+            filters=ActionsCreateRequestFilters(
+                conjunction="or",
+                items=[
+                    ActionsCreateRequestFiltersItemsItem(
+                        filter="filter:tasks:id",
+                        operator="greater",
+                        type="Number",
+                        value=123,
+                    )
+                ],
+            ),
+            selected_items=ActionsCreateRequestSelectedItemsExcluded(
+                all_=True,
+                excluded=[124, 125, 126],
+            ),
+            ordering=["tasks:total_annotations"],
+        )
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/dm/actions/",

label_studio_sdk/actions/types/__init__.py

@@ -5,6 +5,7 @@ from .actions_create_request_filters_conjunction import ActionsCreateRequestFilt
 from .actions_create_request_filters_items_item import ActionsCreateRequestFiltersItemsItem
 from .actions_create_request_filters_items_item_filter import ActionsCreateRequestFiltersItemsItemFilter
 from .actions_create_request_filters_items_item_operator import ActionsCreateRequestFiltersItemsItemOperator
+from .actions_create_request_filters_items_item_value import ActionsCreateRequestFiltersItemsItemValue
 from .actions_create_request_id import ActionsCreateRequestId
 from .actions_create_request_ordering_item import ActionsCreateRequestOrderingItem
 from .actions_create_request_selected_items import ActionsCreateRequestSelectedItems
@@ -17,6 +18,7 @@ __all__ = [
     "ActionsCreateRequestFiltersItemsItem",
     "ActionsCreateRequestFiltersItemsItemFilter",
     "ActionsCreateRequestFiltersItemsItemOperator",
+    "ActionsCreateRequestFiltersItemsItemValue",
     "ActionsCreateRequestId",
     "ActionsCreateRequestOrderingItem",
     "ActionsCreateRequestSelectedItems",

label_studio_sdk/actions/types/actions_create_request_filters_items_item.py

@@ -7,12 +7,13 @@ from ...core.datetime_utils import serialize_datetime
 from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 from .actions_create_request_filters_items_item_filter import ActionsCreateRequestFiltersItemsItemFilter
 from .actions_create_request_filters_items_item_operator import ActionsCreateRequestFiltersItemsItemOperator
+from .actions_create_request_filters_items_item_value import ActionsCreateRequestFiltersItemsItemValue
 
 
 class ActionsCreateRequestFiltersItemsItem(pydantic_v1.BaseModel):
     filter: ActionsCreateRequestFiltersItemsItemFilter = pydantic_v1.Field()
     """
-    Filter identifier, it should start with `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. For `task.data` fields it may look like `filter:tasks:data.field_name`. Possible values:<br><li>`filter:tasks:agreement`<br> (Number) Agreement for annotation results for a specific task (Enterprise only)</li><br><li>`filter:tasks:annotations_results`<br> (String) Annotation results for the tasks</li><br><li>`filter:tasks:annotators`<br> (List) Annotators that completed the task (Community). Can include assigned annotators (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer</li><br><li>`filter:tasks:cancelled_annotations`<br> (Number) Number of cancelled or skipped annotations for the task</li><br><li>`filter:tasks:comments`<br> (Number) Number of comments in a task</li><br><li>`filter:tasks:completed_at`<br> (Datetime) Time when a task was fully annotated</li><br><li>`filter:tasks:created_at`<br> (Datetime) Time the task was created at</li><br><li>`filter:tasks:file_upload`<br> (String) Name of the file uploaded to create the tasks</li><br><li>`filter:tasks:ground_truth`<br> (Boolean) Ground truth status of the tasks</li><br><li>`filter:tasks:id`<br> (Number) Task ID</li><br><li>`filter:tasks:inner_id`<br> (Number) Task Inner ID, it starts from 1 for all projects</li><br><li>`filter:tasks:predictions_model_versions`<br> (String) Model version used for the predictions</li><br><li>`filter:tasks:predictions_results`<br> (String) Prediction results for the tasks</li><br><li>`filter:tasks:predictions_score`<br> (Number) Prediction score for the task</li><br><li>`filter:tasks:reviewed`<br> (Boolean) Whether the tasks have been reviewed (Enterprise only)</li><br><li>`filter:tasks:reviewers`<br> (String) Reviewers that reviewed the task, or assigned reviewers (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer</li><br><li>`filter:tasks:reviews_accepted`<br> (Number) Number of annotations accepted for a task in review (Enterprise only)</li><br><li>`filter:tasks:reviews_rejected`<br> (Number) Number of annotations rejected for a task in review (Enterprise only)</li><br><li>`filter:tasks:total_annotations`<br> (Number) Total number of annotations on a task</li><br><li>`filter:tasks:total_predictions`<br> (Number) Total number of predictions for the task</li><br><li>`filter:tasks:unresolved_comment_count`<br> (Number) Number of unresolved comments in a task</li><br><li>`filter:tasks:updated_at`<br> (Datetime) Time the task was updated at (e.g. new annotation was created, review added, etc)</li>
+    Filter identifier, it should start with `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. For `task.data` fields it may look like `filter:tasks:data.field_name`. If you need more info about columns, check the [Get data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) API endpoint. Possible values:<br><li>`filter:tasks:agreement`<br> (Number) Agreement for annotation results for a specific task (Enterprise only)</li><br><li>`filter:tasks:annotations_results`<br> (String) Annotation results for the tasks</li><br><li>`filter:tasks:annotators`<br> (List) Annotators that completed the task (Community). Can include assigned annotators (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer</li><br><li>`filter:tasks:cancelled_annotations`<br> (Number) Number of cancelled or skipped annotations for the task</li><br><li>`filter:tasks:comments`<br> (Number) Number of comments in a task</li><br><li>`filter:tasks:completed_at`<br> (Datetime) Time when a task was fully annotated</li><br><li>`filter:tasks:created_at`<br> (Datetime) Time the task was created at</li><br><li>`filter:tasks:file_upload`<br> (String) Name of the file uploaded to create the tasks</li><br><li>`filter:tasks:ground_truth`<br> (Boolean) Ground truth status of the tasks</li><br><li>`filter:tasks:id`<br> (Number) Task ID</li><br><li>`filter:tasks:inner_id`<br> (Number) Task Inner ID, it starts from 1 for all projects</li><br><li>`filter:tasks:predictions_model_versions`<br> (String) Model version used for the predictions</li><br><li>`filter:tasks:predictions_results`<br> (String) Prediction results for the tasks</li><br><li>`filter:tasks:predictions_score`<br> (Number) Prediction score for the task</li><br><li>`filter:tasks:reviewed`<br> (Boolean) Whether the tasks have been reviewed (Enterprise only)</li><br><li>`filter:tasks:reviewers`<br> (String) Reviewers that reviewed the task, or assigned reviewers (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer</li><br><li>`filter:tasks:reviews_accepted`<br> (Number) Number of annotations accepted for a task in review (Enterprise only)</li><br><li>`filter:tasks:reviews_rejected`<br> (Number) Number of annotations rejected for a task in review (Enterprise only)</li><br><li>`filter:tasks:total_annotations`<br> (Number) Total number of annotations on a task</li><br><li>`filter:tasks:total_predictions`<br> (Number) Total number of predictions for the task</li><br><li>`filter:tasks:unresolved_comment_count`<br> (Number) Number of unresolved comments in a task</li><br><li>`filter:tasks:updated_at`<br> (Datetime) Time the task was updated at (e.g. new annotation was created, review added, etc)</li>
     """
 
     operator: ActionsCreateRequestFiltersItemsItemOperator = pydantic_v1.Field()
@@ -25,7 +26,7 @@ class ActionsCreateRequestFiltersItemsItem(pydantic_v1.BaseModel):
     Type of the filter value. Possible values:<br><li>`Boolean`<br> Boolean</li><br><li>`Datetime`<br> Datetime string in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format</li><br><li>`List`<br> List of items</li><br><li>`Number`<br> Float or Integer</li><br><li>`String`<br> String</li><br><li>`Unknown`<br> Unknown is explicitly converted to string format</li>
     """
 
-    value: str = pydantic_v1.Field()
+    value: ActionsCreateRequestFiltersItemsItemValue = pydantic_v1.Field()
     """
     Value to filter by
     """

label_studio_sdk/actions/types/actions_create_request_filters_items_item_value.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ActionsCreateRequestFiltersItemsItemValue = typing.Union[str, int, float, bool, typing.Dict[str, typing.Any]]

label_studio_sdk/core/client_wrapper.py

@@ -17,7 +17,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "label-studio-sdk",
-            "X-Fern-SDK-Version": "0.0.121",
+            "X-Fern-SDK-Version": "1.0.3",
         }
         headers["Authorization"] = f"Token  {self.api_key}"
         return headers

label_studio_sdk/errors/bad_request_error.py

@@ -1,8 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import typing
+
 from ..core.api_error import ApiError
 
 
 class BadRequestError(ApiError):
-    def __init__(self, body: str):
+    def __init__(self, body: typing.Any):
         super().__init__(status_code=400, body=body)

label_studio_sdk/label_interface/interface.py

@@ -29,7 +29,7 @@ from .control_tags import (
 )
 from .object_tags import ObjectTag
 from .label_tags import LabelTag
-from label_studio_sdk._legacy.objects import AnnotationValue, TaskValue, PredictionValue
+from .objects import AnnotationValue, TaskValue, PredictionValue
 
 
 dir_path = os.path.dirname(os.path.realpath(__file__))

label_studio_sdk/{_legacy → label_interface}/objects.py

@@ -1,11 +1,10 @@
 from typing import Type, Dict, Optional, List, Tuple, Any, Union
-from pydantic import BaseModel, Field, confloat
+from pydantic import BaseModel, Field, confloat, field_serializer
 
-from label_studio_sdk.label_interface.region import Region
+from .region import Region
 
 
 def serialize_regions(result):
-    """ """
     res = []
     relations = []
     for r in result:
@@ -25,19 +24,13 @@ class PredictionValue(BaseModel):
     model_version: Optional[Any] = None
     score: Optional[float] = 0.00
     result: Optional[List[Union[Dict[str, Any], Region]]]
-    # cluster: Optional[Any] = None
-    # neighbors: Optional[Any] = None
 
     class Config:
         allow_population_by_field_name = True
 
-    def serialize(self):
-        """ """
-        return {
-            "model_version": self.model_version,
-            "score": self.score,
-            "result": serialize_regions(self.result),
-        }
+    @field_serializer('result')
+    def serialize_result(self, result):
+        return serialize_regions(result)
 
 
 class AnnotationValue(BaseModel):
@@ -54,16 +47,9 @@ class AnnotationValue(BaseModel):
     class Config:
         allow_population_by_field_name = True
 
-    def serialize(self):
-        """ """
-        return {
-            "was_cancelled": self.was_cancelled,
-            "ground_truth": self.ground_truth,
-            "lead_time": self.lead_time,
-            "result_count": self.result_count,
-            "completed_by": self.completed_by,
-            "result": serialize_regions(self.result),
-        }
+    @field_serializer('result')
+    def serialize_result(self, result):
+        return serialize_regions(result)
 
 
 class TaskValue(BaseModel):

label_studio_sdk/projects/__init__.py

@@ -1,6 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse
+from .types import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse, ProjectsUpdateResponse
 from . import exports
 
-__all__ = ["ProjectsCreateResponse", "ProjectsImportTasksResponse", "ProjectsListResponse", "exports"]
+__all__ = [
+    "ProjectsCreateResponse",
+    "ProjectsImportTasksResponse",
+    "ProjectsListResponse",
+    "ProjectsUpdateResponse",
+    "exports",
+]