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

label_studio_sdk/actions/client.py

@@ -3,6 +3,8 @@
 import typing
 from ..core.client_wrapper import SyncClientWrapper
 from ..core.request_options import RequestOptions
+from .types.actions_list_response_item import ActionsListResponseItem
+from ..core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ..core.api_error import ApiError
 from .types.actions_create_request_id import ActionsCreateRequestId
@@ -20,18 +22,24 @@ class ActionsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    def list(
+        self, *, project: int, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[ActionsListResponseItem]:
         """
         Retrieve all the registered actions with descriptions that data manager can use.
 
         Parameters
         ----------
+        project : int
+            Project ID
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        typing.List[ActionsListResponseItem]
+            Actions retrieved successfully
 
         Examples
         --------
@@ -40,16 +48,27 @@ class ActionsClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.actions.list()
+        client.actions.list(
+            project=1,
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "api/dm/actions/",
             method="GET",
+            params={
+                "project": project,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    typing.List[ActionsListResponseItem],
+                    construct_type(
+                        type_=typing.List[ActionsListResponseItem],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -109,7 +128,7 @@ class ActionsClient:
             api_key="YOUR_API_KEY",
         )
         client.actions.create(
-            id="retrieve_tasks_predictions",
+            id="delete_annotators",
             project=1,
             filters=ActionsCreateRequestFilters(
                 conjunction="or",
@@ -165,18 +184,24 @@ class AsyncActionsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    async def list(
+        self, *, project: int, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[ActionsListResponseItem]:
         """
         Retrieve all the registered actions with descriptions that data manager can use.
 
         Parameters
         ----------
+        project : int
+            Project ID
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        typing.List[ActionsListResponseItem]
+            Actions retrieved successfully
 
         Examples
         --------
@@ -190,7 +215,9 @@ class AsyncActionsClient:
 
 
         async def main() -> None:
-            await client.actions.list()
+            await client.actions.list(
+                project=1,
+            )
 
 
         asyncio.run(main())
@@ -198,11 +225,20 @@ class AsyncActionsClient:
         _response = await self._client_wrapper.httpx_client.request(
             "api/dm/actions/",
             method="GET",
+            params={
+                "project": project,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    typing.List[ActionsListResponseItem],
+                    construct_type(
+                        type_=typing.List[ActionsListResponseItem],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -267,7 +303,7 @@ class AsyncActionsClient:
 
         async def main() -> None:
             await client.actions.create(
-                id="retrieve_tasks_predictions",
+                id="delete_annotators",
                 project=1,
                 filters=ActionsCreateRequestFilters(
                     conjunction="or",

label_studio_sdk/actions/types/__init__.py

@@ -11,6 +11,8 @@ from .actions_create_request_ordering_item import ActionsCreateRequestOrderingIt
 from .actions_create_request_selected_items import ActionsCreateRequestSelectedItems
 from .actions_create_request_selected_items_excluded import ActionsCreateRequestSelectedItemsExcluded
 from .actions_create_request_selected_items_included import ActionsCreateRequestSelectedItemsIncluded
+from .actions_list_response_item import ActionsListResponseItem
+from .actions_list_response_item_dialog import ActionsListResponseItemDialog
 
 __all__ = [
     "ActionsCreateRequestFilters",
@@ -24,4 +26,6 @@ __all__ = [
     "ActionsCreateRequestSelectedItems",
     "ActionsCreateRequestSelectedItemsExcluded",
     "ActionsCreateRequestSelectedItemsIncluded",
+    "ActionsListResponseItem",
+    "ActionsListResponseItemDialog",
 ]

label_studio_sdk/actions/types/actions_create_request_filters.py

@@ -1,6 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.unchecked_base_model import UncheckedBaseModel
 from .actions_create_request_filters_conjunction import ActionsCreateRequestFiltersConjunction
 import pydantic
 import typing
@@ -8,7 +8,7 @@ from .actions_create_request_filters_items_item import ActionsCreateRequestFilte
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ActionsCreateRequestFilters(UniversalBaseModel):
+class ActionsCreateRequestFilters(UncheckedBaseModel):
     """
     Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.<br>Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`
     """

label_studio_sdk/actions/types/actions_create_request_filters_items_item.py

@@ -1,6 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.unchecked_base_model import UncheckedBaseModel
 from .actions_create_request_filters_items_item_filter import ActionsCreateRequestFiltersItemsItemFilter
 import pydantic
 from .actions_create_request_filters_items_item_operator import ActionsCreateRequestFiltersItemsItemOperator
@@ -9,7 +9,7 @@ from ...core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
 
 
-class ActionsCreateRequestFiltersItemsItem(UniversalBaseModel):
+class ActionsCreateRequestFiltersItemsItem(UncheckedBaseModel):
     filter: ActionsCreateRequestFiltersItemsItemFilter = pydantic.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`. 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>

label_studio_sdk/actions/types/actions_create_request_id.py

@@ -4,16 +4,16 @@ import typing
 
 ActionsCreateRequestId = typing.Union[
     typing.Literal[
-        "retrieve_tasks_predictions",
-        "predictions_to_annotations",
-        "remove_duplicates",
-        "delete_tasks",
+        "delete_annotators",
         "delete_ground_truths",
+        "delete_reviewers",
+        "delete_tasks",
         "delete_tasks_annotations",
-        "delete_tasks_reviews",
         "delete_tasks_predictions",
-        "delete_reviewers",
-        "delete_annotators",
+        "delete_tasks_reviews",
+        "predictions_to_annotations",
+        "remove_duplicates",
+        "retrieve_tasks_predictions",
     ],
     typing.Any,
 ]

label_studio_sdk/actions/types/actions_create_request_selected_items_excluded.py

@@ -1,6 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.unchecked_base_model import UncheckedBaseModel
 import typing_extensions
 from ...core.serialization import FieldMetadata
 import pydantic
@@ -8,7 +8,7 @@ import typing
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ActionsCreateRequestSelectedItemsExcluded(UniversalBaseModel):
+class ActionsCreateRequestSelectedItemsExcluded(UncheckedBaseModel):
     all_: typing_extensions.Annotated[bool, FieldMetadata(alias="all")] = pydantic.Field()
     """
     All tasks are selected

label_studio_sdk/actions/types/actions_create_request_selected_items_included.py

@@ -1,6 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.unchecked_base_model import UncheckedBaseModel
 import typing_extensions
 from ...core.serialization import FieldMetadata
 import pydantic
@@ -8,7 +8,7 @@ import typing
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ActionsCreateRequestSelectedItemsIncluded(UniversalBaseModel):
+class ActionsCreateRequestSelectedItemsIncluded(UncheckedBaseModel):
     all_: typing_extensions.Annotated[bool, FieldMetadata(alias="all")] = pydantic.Field()
     """
     No tasks are selected

label_studio_sdk/actions/types/actions_list_response_item.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .actions_list_response_item_dialog import ActionsListResponseItemDialog
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ActionsListResponseItem(UncheckedBaseModel):
+    id: typing.Optional[str] = None
+    title: typing.Optional[str] = None
+    order: typing.Optional[int] = None
+    permission: typing.Optional[str] = None
+    experimental: typing.Optional[bool] = None
+    dialog: typing.Optional[ActionsListResponseItemDialog] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/actions/types/actions_list_response_item_dialog.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.unchecked_base_model import UncheckedBaseModel
+import typing
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ActionsListResponseItemDialog(UncheckedBaseModel):
+    title: typing.Optional[str] = None
+    text: typing.Optional[str] = None
+    type: typing.Optional[str] = None
+    form: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/annotations/__init__.py

@@ -1,5 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import AnnotationsCreateBulkRequestSelectedItems, AnnotationsCreateBulkResponseItem
+from .types import AnnotationBulkSerializerWithSelectedItemsRequestLastAction, AnnotationsCreateBulkResponseItem
 
-__all__ = ["AnnotationsCreateBulkRequestSelectedItems", "AnnotationsCreateBulkResponseItem"]
+__all__ = ["AnnotationBulkSerializerWithSelectedItemsRequestLastAction", "AnnotationsCreateBulkResponseItem"]