label-studio-sdk 1.0.5__py3-none-any.whl → 1.0.8__py3-none-any.whl

label_studio_sdk/prompts/indicators/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+

label_studio_sdk/prompts/indicators/client.py

@@ -0,0 +1,194 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.pydantic_utilities import pydantic_v1
+from ...core.request_options import RequestOptions
+from ...types.key_indicator_value import KeyIndicatorValue
+from ...types.key_indicators import KeyIndicators
+
+
+class IndicatorsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(self, pk: int, *, request_options: typing.Optional[RequestOptions] = None) -> KeyIndicators:
+        """
+        Get key indicators for the Prompt dashboard.
+
+        Parameters
+        ----------
+        pk : int
+            Inference run ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        KeyIndicators
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.indicators.list(
+            pk=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/inference-runs/{jsonable_encoder(pk)}/indicators", method="GET", request_options=request_options
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(KeyIndicators, _response.json())  # type: ignore
+            _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 get(
+        self, indicator_key: str, pk: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> KeyIndicatorValue:
+        """
+        Get a specific key indicator for the Prompt dashboard.
+
+        Parameters
+        ----------
+        indicator_key : str
+            Key of the indicator
+
+        pk : int
+            Inference run ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        KeyIndicatorValue
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.indicators.get(
+            indicator_key="indicator_key",
+            pk=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/inference-runs/{jsonable_encoder(pk)}/indicators/{jsonable_encoder(indicator_key)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(KeyIndicatorValue, _response.json())  # type: ignore
+            _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 AsyncIndicatorsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(self, pk: int, *, request_options: typing.Optional[RequestOptions] = None) -> KeyIndicators:
+        """
+        Get key indicators for the Prompt dashboard.
+
+        Parameters
+        ----------
+        pk : int
+            Inference run ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        KeyIndicators
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.prompts.indicators.list(
+            pk=1,
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/inference-runs/{jsonable_encoder(pk)}/indicators", method="GET", request_options=request_options
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(KeyIndicators, _response.json())  # type: ignore
+            _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 get(
+        self, indicator_key: str, pk: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> KeyIndicatorValue:
+        """
+        Get a specific key indicator for the Prompt dashboard.
+
+        Parameters
+        ----------
+        indicator_key : str
+            Key of the indicator
+
+        pk : int
+            Inference run ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        KeyIndicatorValue
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.prompts.indicators.get(
+            indicator_key="indicator_key",
+            pk=1,
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/inference-runs/{jsonable_encoder(pk)}/indicators/{jsonable_encoder(indicator_key)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(KeyIndicatorValue, _response.json())  # type: ignore
+            _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/prompts/runs/__init__.py

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

label_studio_sdk/prompts/runs/client.py

@@ -0,0 +1,354 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.pydantic_utilities import pydantic_v1
+from ...core.request_options import RequestOptions
+from ...types.inference_run import InferenceRun
+from ...types.inference_run_created_by import InferenceRunCreatedBy
+from ...types.inference_run_organization import InferenceRunOrganization
+from ...types.inference_run_project_subset import InferenceRunProjectSubset
+from ...types.inference_run_status import InferenceRunStatus
+from .types.runs_list_request_project_subset import RunsListRequestProjectSubset
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RunsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        id: int,
+        version_id: int,
+        *,
+        project: int,
+        project_subset: RunsListRequestProjectSubset,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InferenceRun:
+        """
+        Get information (status, etadata, etc) about an existing inference run
+
+        Parameters
+        ----------
+        id : int
+            Prompt ID
+
+        version_id : int
+            Prompt Version ID
+
+        project : int
+            The ID of the project that this Interence Run makes predictions on
+
+        project_subset : RunsListRequestProjectSubset
+            Defines which tasks are operated on (e.g. HasGT will only operate on tasks with a ground truth annotation, but All will operate on all records)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InferenceRun
+            Success
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.runs.list(
+            id=1,
+            version_id=1,
+            project=1,
+            project_subset="All",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}/inference-runs",
+            method="GET",
+            params={"project": project, "project_subset": project_subset},
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(InferenceRun, _response.json())  # type: ignore
+            _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 create(
+        self,
+        id: int,
+        version_id: int,
+        *,
+        project: int,
+        project_subset: InferenceRunProjectSubset,
+        organization: typing.Optional[InferenceRunOrganization] = OMIT,
+        model_version: typing.Optional[str] = OMIT,
+        created_by: typing.Optional[InferenceRunCreatedBy] = OMIT,
+        status: typing.Optional[InferenceRunStatus] = OMIT,
+        job_id: typing.Optional[str] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        triggered_at: typing.Optional[dt.datetime] = OMIT,
+        predictions_updated_at: typing.Optional[dt.datetime] = OMIT,
+        completed_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InferenceRun:
+        """
+        Run a prompt inference.
+
+        Parameters
+        ----------
+        id : int
+            Prompt ID
+
+        version_id : int
+            Prompt Version ID
+
+        project : int
+
+        project_subset : InferenceRunProjectSubset
+
+        organization : typing.Optional[InferenceRunOrganization]
+
+        model_version : typing.Optional[str]
+
+        created_by : typing.Optional[InferenceRunCreatedBy]
+
+        status : typing.Optional[InferenceRunStatus]
+
+        job_id : typing.Optional[str]
+
+        created_at : typing.Optional[dt.datetime]
+
+        triggered_at : typing.Optional[dt.datetime]
+
+        predictions_updated_at : typing.Optional[dt.datetime]
+
+        completed_at : typing.Optional[dt.datetime]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InferenceRun
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.runs.create(
+            id=1,
+            version_id=1,
+            project=1,
+            project_subset="All",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}/inference-runs",
+            method="POST",
+            json={
+                "organization": organization,
+                "project": project,
+                "model_version": model_version,
+                "created_by": created_by,
+                "project_subset": project_subset,
+                "status": status,
+                "job_id": job_id,
+                "created_at": created_at,
+                "triggered_at": triggered_at,
+                "predictions_updated_at": predictions_updated_at,
+                "completed_at": completed_at,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(InferenceRun, _response.json())  # type: ignore
+            _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):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        id: int,
+        version_id: int,
+        *,
+        project: int,
+        project_subset: RunsListRequestProjectSubset,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InferenceRun:
+        """
+        Get information (status, etadata, etc) about an existing inference run
+
+        Parameters
+        ----------
+        id : int
+            Prompt ID
+
+        version_id : int
+            Prompt Version ID
+
+        project : int
+            The ID of the project that this Interence Run makes predictions on
+
+        project_subset : RunsListRequestProjectSubset
+            Defines which tasks are operated on (e.g. HasGT will only operate on tasks with a ground truth annotation, but All will operate on all records)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InferenceRun
+            Success
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.prompts.runs.list(
+            id=1,
+            version_id=1,
+            project=1,
+            project_subset="All",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}/inference-runs",
+            method="GET",
+            params={"project": project, "project_subset": project_subset},
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(InferenceRun, _response.json())  # type: ignore
+            _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 create(
+        self,
+        id: int,
+        version_id: int,
+        *,
+        project: int,
+        project_subset: InferenceRunProjectSubset,
+        organization: typing.Optional[InferenceRunOrganization] = OMIT,
+        model_version: typing.Optional[str] = OMIT,
+        created_by: typing.Optional[InferenceRunCreatedBy] = OMIT,
+        status: typing.Optional[InferenceRunStatus] = OMIT,
+        job_id: typing.Optional[str] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        triggered_at: typing.Optional[dt.datetime] = OMIT,
+        predictions_updated_at: typing.Optional[dt.datetime] = OMIT,
+        completed_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InferenceRun:
+        """
+        Run a prompt inference.
+
+        Parameters
+        ----------
+        id : int
+            Prompt ID
+
+        version_id : int
+            Prompt Version ID
+
+        project : int
+
+        project_subset : InferenceRunProjectSubset
+
+        organization : typing.Optional[InferenceRunOrganization]
+
+        model_version : typing.Optional[str]
+
+        created_by : typing.Optional[InferenceRunCreatedBy]
+
+        status : typing.Optional[InferenceRunStatus]
+
+        job_id : typing.Optional[str]
+
+        created_at : typing.Optional[dt.datetime]
+
+        triggered_at : typing.Optional[dt.datetime]
+
+        predictions_updated_at : typing.Optional[dt.datetime]
+
+        completed_at : typing.Optional[dt.datetime]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InferenceRun
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.prompts.runs.create(
+            id=1,
+            version_id=1,
+            project=1,
+            project_subset="All",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}/inference-runs",
+            method="POST",
+            json={
+                "organization": organization,
+                "project": project,
+                "model_version": model_version,
+                "created_by": created_by,
+                "project_subset": project_subset,
+                "status": status,
+                "job_id": job_id,
+                "created_at": created_at,
+                "triggered_at": triggered_at,
+                "predictions_updated_at": predictions_updated_at,
+                "completed_at": completed_at,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(InferenceRun, _response.json())  # type: ignore
+            _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/prompts/runs/types/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .runs_list_request_project_subset import RunsListRequestProjectSubset
+
+__all__ = ["RunsListRequestProjectSubset"]

label_studio_sdk/prompts/runs/types/runs_list_request_project_subset.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RunsListRequestProjectSubset = typing.Union[typing.Literal["All", "HasGT", "Sample"], typing.Any]

label_studio_sdk/prompts/types/__init__.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .prompts_batch_failed_predictions_request_failed_predictions_item import (
+    PromptsBatchFailedPredictionsRequestFailedPredictionsItem,
+)
+from .prompts_batch_failed_predictions_response import PromptsBatchFailedPredictionsResponse
+from .prompts_batch_predictions_request_results_item import PromptsBatchPredictionsRequestResultsItem
+from .prompts_batch_predictions_response import PromptsBatchPredictionsResponse
+
+__all__ = [
+    "PromptsBatchFailedPredictionsRequestFailedPredictionsItem",
+    "PromptsBatchFailedPredictionsResponse",
+    "PromptsBatchPredictionsRequestResultsItem",
+    "PromptsBatchPredictionsResponse",
+]

label_studio_sdk/prompts/types/prompts_batch_failed_predictions_request_failed_predictions_item.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...core.datetime_utils import serialize_datetime
+from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class PromptsBatchFailedPredictionsRequestFailedPredictionsItem(pydantic_v1.BaseModel):
+    task_id: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Task ID to associate the prediction with
+    """
+
+    error_type: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Type of error (e.g. "Timeout", "Rate Limit", etc)
+    """
+
+    message: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Error message details
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/prompts/types/prompts_batch_failed_predictions_response.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...core.datetime_utils import serialize_datetime
+from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class PromptsBatchFailedPredictionsResponse(pydantic_v1.BaseModel):
+    detail: typing.Optional[str] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}