label-studio-sdk 2.0.8__py3-none-any.whl → 2.0.10__py3-none-any.whl

label_studio_sdk/prompts/client.py

@@ -11,6 +11,10 @@ from ..core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ..core.api_error import ApiError
 from ..types.batch_predictions import BatchPredictions
+from ..types.paginated_project_subset_tasks_response_list import PaginatedProjectSubsetTasksResponseList
+from ..core.jsonable_encoder import jsonable_encoder
+from ..errors.bad_request_error import BadRequestError
+from ..types.project_subset_item import ProjectSubsetItem
 from ..types.model_interface_serializer_get import ModelInterfaceSerializerGet
 from ..types.user_simple_request import UserSimpleRequest
 from ..types.skill_name_enum import SkillNameEnum
@@ -18,7 +22,6 @@ from ..types.model_interface import ModelInterface
 from ..core.serialization import convert_and_respect_annotation_metadata
 from .types.prompts_compatible_projects_request_project_type import PromptsCompatibleProjectsRequestProjectType
 from ..types.paginated_all_roles_project_list_list import PaginatedAllRolesProjectListList
-from ..core.jsonable_encoder import jsonable_encoder
 from ..core.client_wrapper import AsyncClientWrapper
 from .indicators.client import AsyncIndicatorsClient
 from .versions.client import AsyncVersionsClient
@@ -183,6 +186,166 @@ class PromptsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def subset_tasks(
+        self,
+        project_pk: int,
+        *,
+        include_total: typing.Optional[bool] = None,
+        model_run: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        page_size: typing.Optional[int] = None,
+        parent_model: typing.Optional[int] = None,
+        project_subset: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaginatedProjectSubsetTasksResponseList:
+        """
+
+                Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.
+
+
+        Parameters
+        ----------
+        project_pk : int
+
+        include_total : typing.Optional[bool]
+            If true (default), includes task_count in response; if false, omits it.
+
+        model_run : typing.Optional[int]
+            A unique ID of a ModelRun
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        page : typing.Optional[int]
+            A page number within the paginated result set.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        parent_model : typing.Optional[int]
+            The ID of the parent model (ModelInterface) for this Inference Run
+
+        project_subset : typing.Optional[str]
+            The project subset to retrieve tasks for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedProjectSubsetTasksResponseList
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.subset_tasks(
+            project_pk=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/subset-tasks",
+            method="GET",
+            params={
+                "include_total": include_total,
+                "model_run": model_run,
+                "ordering": ordering,
+                "page": page,
+                "page_size": page_size,
+                "parent_model": parent_model,
+                "project_subset": project_subset,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PaginatedProjectSubsetTasksResponseList,
+                    construct_type(
+                        type_=PaginatedProjectSubsetTasksResponseList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def subsets(
+        self,
+        project_pk: int,
+        *,
+        ordering: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[ProjectSubsetItem]:
+        """
+
+                Provides list of available subsets for a project along with count of tasks in each subset
+
+
+        Parameters
+        ----------
+        project_pk : int
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[ProjectSubsetItem]
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.subsets(
+            project_pk=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/subsets",
+            method="GET",
+            params={
+                "ordering": ordering,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[ProjectSubsetItem],
+                    construct_type(
+                        type_=typing.List[ProjectSubsetItem],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
     def list(
         self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[ModelInterfaceSerializerGet]:
@@ -740,6 +903,182 @@ class AsyncPromptsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    async def subset_tasks(
+        self,
+        project_pk: int,
+        *,
+        include_total: typing.Optional[bool] = None,
+        model_run: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        page_size: typing.Optional[int] = None,
+        parent_model: typing.Optional[int] = None,
+        project_subset: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaginatedProjectSubsetTasksResponseList:
+        """
+
+                Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.
+
+
+        Parameters
+        ----------
+        project_pk : int
+
+        include_total : typing.Optional[bool]
+            If true (default), includes task_count in response; if false, omits it.
+
+        model_run : typing.Optional[int]
+            A unique ID of a ModelRun
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        page : typing.Optional[int]
+            A page number within the paginated result set.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        parent_model : typing.Optional[int]
+            The ID of the parent model (ModelInterface) for this Inference Run
+
+        project_subset : typing.Optional[str]
+            The project subset to retrieve tasks for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedProjectSubsetTasksResponseList
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.prompts.subset_tasks(
+                project_pk=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/subset-tasks",
+            method="GET",
+            params={
+                "include_total": include_total,
+                "model_run": model_run,
+                "ordering": ordering,
+                "page": page,
+                "page_size": page_size,
+                "parent_model": parent_model,
+                "project_subset": project_subset,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PaginatedProjectSubsetTasksResponseList,
+                    construct_type(
+                        type_=PaginatedProjectSubsetTasksResponseList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def subsets(
+        self,
+        project_pk: int,
+        *,
+        ordering: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[ProjectSubsetItem]:
+        """
+
+                Provides list of available subsets for a project along with count of tasks in each subset
+
+
+        Parameters
+        ----------
+        project_pk : int
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[ProjectSubsetItem]
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.prompts.subsets(
+                project_pk=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(project_pk)}/subsets",
+            method="GET",
+            params={
+                "ordering": ordering,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[ProjectSubsetItem],
+                    construct_type(
+                        type_=typing.List[ProjectSubsetItem],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
     async def list(
         self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[ModelInterfaceSerializerGet]:

label_studio_sdk/prompts/runs/client.py

@@ -11,6 +11,7 @@ from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
 import datetime as dt
 from ...types.project_subset_enum import ProjectSubsetEnum
+from ...types.cancel_model_run_response import CancelModelRunResponse
 from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -193,6 +194,65 @@ class RunsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def cancel(
+        self,
+        inference_run_id: int,
+        prompt_id: int,
+        version_id: int,
+        *,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CancelModelRunResponse:
+        """
+        Cancel the inference run for the given api
+
+        Parameters
+        ----------
+        inference_run_id : int
+
+        prompt_id : int
+
+        version_id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CancelModelRunResponse
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.runs.cancel(
+            inference_run_id=1,
+            prompt_id=1,
+            version_id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/inference-runs/{jsonable_encoder(inference_run_id)}/cancel",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    CancelModelRunResponse,
+                    construct_type(
+                        type_=CancelModelRunResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
 
 class AsyncRunsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -385,3 +445,70 @@ class AsyncRunsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def cancel(
+        self,
+        inference_run_id: int,
+        prompt_id: int,
+        version_id: int,
+        *,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CancelModelRunResponse:
+        """
+        Cancel the inference run for the given api
+
+        Parameters
+        ----------
+        inference_run_id : int
+
+        prompt_id : int
+
+        version_id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CancelModelRunResponse
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.prompts.runs.cancel(
+                inference_run_id=1,
+                prompt_id=1,
+                version_id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/inference-runs/{jsonable_encoder(inference_run_id)}/cancel",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    CancelModelRunResponse,
+                    construct_type(
+                        type_=CancelModelRunResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

label_studio_sdk/tasks/client.py

@@ -372,7 +372,8 @@ class TasksClient:
             api_key="YOUR_API_KEY",
         )
         client.tasks.create(
-            data={"key": "value"},
+            data={"image": "https://example.com/image.jpg", "text": "Hello, world!"},
+            project=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -1203,7 +1204,11 @@ class AsyncTasksClient:
 
         async def main() -> None:
             await client.tasks.create(
-                data={"key": "value"},
+                data={
+                    "image": "https://example.com/image.jpg",
+                    "text": "Hello, world!",
+                },
+                project=1,
             )