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

label_studio_sdk/projects/stats/client.py

@@ -0,0 +1,175 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.client_wrapper import SyncClientWrapper
+import typing
+from ...core.request_options import RequestOptions
+from .types.stats_iaa_response import StatsIaaResponse
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.unchecked_base_model import construct_type
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper
+
+
+class StatsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def iaa(
+        self,
+        id: int,
+        *,
+        expand: typing.Optional[str] = None,
+        per_label: typing.Optional[bool] = None,
+        std: typing.Optional[bool] = None,
+        task: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> StatsIaaResponse:
+        """
+        Get Inter-Annotator Agreement (IAA) matrix for a project, showing agreement between all annotators.
+
+        Parameters
+        ----------
+        id : int
+
+        expand : typing.Optional[str]
+            Comma-separated list of fields to expand
+
+        per_label : typing.Optional[bool]
+            Calculate IAA per label
+
+        std : typing.Optional[bool]
+            Include standard deviation in results
+
+        task : typing.Optional[str]
+            Comma-separated list of task IDs to filter by
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StatsIaaResponse
+            Inter-Annotator Agreement matrix
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.stats.iaa(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/stats/IAA",
+            method="GET",
+            params={
+                "expand": expand,
+                "per_label": per_label,
+                "std": std,
+                "task": task,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    StatsIaaResponse,
+                    construct_type(
+                        type_=StatsIaaResponse,  # 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 AsyncStatsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def iaa(
+        self,
+        id: int,
+        *,
+        expand: typing.Optional[str] = None,
+        per_label: typing.Optional[bool] = None,
+        std: typing.Optional[bool] = None,
+        task: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> StatsIaaResponse:
+        """
+        Get Inter-Annotator Agreement (IAA) matrix for a project, showing agreement between all annotators.
+
+        Parameters
+        ----------
+        id : int
+
+        expand : typing.Optional[str]
+            Comma-separated list of fields to expand
+
+        per_label : typing.Optional[bool]
+            Calculate IAA per label
+
+        std : typing.Optional[bool]
+            Include standard deviation in results
+
+        task : typing.Optional[str]
+            Comma-separated list of task IDs to filter by
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StatsIaaResponse
+            Inter-Annotator Agreement matrix
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.stats.iaa(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/stats/IAA",
+            method="GET",
+            params={
+                "expand": expand,
+                "per_label": per_label,
+                "std": std,
+                "task": task,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    StatsIaaResponse,
+                    construct_type(
+                        type_=StatsIaaResponse,  # 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/projects/stats/types/__init__.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .stats_iaa_response import StatsIaaResponse
+from .stats_iaa_response_common_tasks import StatsIaaResponseCommonTasks
+from .stats_iaa_response_iaa import StatsIaaResponseIaa
+from .stats_iaa_response_std import StatsIaaResponseStd
+
+__all__ = ["StatsIaaResponse", "StatsIaaResponseCommonTasks", "StatsIaaResponseIaa", "StatsIaaResponseStd"]

label_studio_sdk/projects/stats/types/stats_iaa_response.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ....core.unchecked_base_model import UncheckedBaseModel
+import typing_extensions
+import typing
+from .stats_iaa_response_iaa import StatsIaaResponseIaa
+from ....core.serialization import FieldMetadata
+import pydantic
+from .stats_iaa_response_std import StatsIaaResponseStd
+from .stats_iaa_response_common_tasks import StatsIaaResponseCommonTasks
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class StatsIaaResponse(UncheckedBaseModel):
+    iaa: typing_extensions.Annotated[typing.Optional[StatsIaaResponseIaa], FieldMetadata(alias="IAA")] = pydantic.Field(
+        default=None
+    )
+    """
+    Inter-Annotator Agreement matrix - 2D array when per_label=false, object with label keys when per_label=true
+    """
+
+    users: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
+    """
+    List of users in the matrix
+    """
+
+    std: typing.Optional[StatsIaaResponseStd] = pydantic.Field(default=None)
+    """
+    Standard deviation - number when per_label=false, object with label keys when per_label=true
+    """
+
+    common_tasks: typing.Optional[StatsIaaResponseCommonTasks] = pydantic.Field(default=None)
+    """
+    Common tasks matrix - 2D array when per_label=false, object with label keys when per_label=true
+    """
+
+    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/projects/stats/types/stats_iaa_response_common_tasks.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+StatsIaaResponseCommonTasks = typing.Union[
+    typing.List[typing.List[float]], typing.Dict[str, typing.List[typing.List[float]]]
+]

label_studio_sdk/projects/stats/types/stats_iaa_response_iaa.py

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

label_studio_sdk/{types/base_task_file_upload.py → projects/stats/types/stats_iaa_response_std.py}

@@ -2,4 +2,4 @@
 
 import typing
 
-BaseTaskFileUpload = typing.Union[typing.Optional[str], typing.Optional[int]]
+StatsIaaResponseStd = typing.Union[float, typing.Dict[str, float]]

label_studio_sdk/projects/types/__init__.py

@@ -1,15 +1,19 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .projects_create_response import ProjectsCreateResponse
+from .lse_project_create_request_sampling import LseProjectCreateRequestSampling
+from .lse_project_create_request_skip_queue import LseProjectCreateRequestSkipQueue
+from .patched_lse_project_update_request_sampling import PatchedLseProjectUpdateRequestSampling
+from .patched_lse_project_update_request_skip_queue import PatchedLseProjectUpdateRequestSkipQueue
+from .projects_duplicate_response import ProjectsDuplicateResponse
 from .projects_import_tasks_response import ProjectsImportTasksResponse
 from .projects_list_request_filter import ProjectsListRequestFilter
-from .projects_list_response import ProjectsListResponse
-from .projects_update_response import ProjectsUpdateResponse
 
 __all__ = [
-    "ProjectsCreateResponse",
+    "LseProjectCreateRequestSampling",
+    "LseProjectCreateRequestSkipQueue",
+    "PatchedLseProjectUpdateRequestSampling",
+    "PatchedLseProjectUpdateRequestSkipQueue",
+    "ProjectsDuplicateResponse",
     "ProjectsImportTasksResponse",
     "ProjectsListRequestFilter",
-    "ProjectsListResponse",
-    "ProjectsUpdateResponse",
 ]

label_studio_sdk/projects/types/lse_project_create_request_sampling.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...types.sampling_enum import SamplingEnum
+from ...types.null_enum import NullEnum
+
+LseProjectCreateRequestSampling = typing.Union[SamplingEnum, NullEnum]

label_studio_sdk/projects/types/lse_project_create_request_skip_queue.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...types.skip_queue_enum import SkipQueueEnum
+from ...types.null_enum import NullEnum
+
+LseProjectCreateRequestSkipQueue = typing.Union[SkipQueueEnum, NullEnum]

label_studio_sdk/projects/types/patched_lse_project_update_request_sampling.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...types.sampling_enum import SamplingEnum
+from ...types.null_enum import NullEnum
+
+PatchedLseProjectUpdateRequestSampling = typing.Union[SamplingEnum, NullEnum]

label_studio_sdk/projects/types/patched_lse_project_update_request_skip_queue.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...types.skip_queue_enum import SkipQueueEnum
+from ...types.null_enum import NullEnum
+
+PatchedLseProjectUpdateRequestSkipQueue = typing.Union[SkipQueueEnum, NullEnum]

label_studio_sdk/{prompts/types/prompts_batch_failed_predictions_response.py → projects/types/projects_duplicate_response.py}

@@ -1,13 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
-import typing
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
 import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
 
 
-class PromptsBatchFailedPredictionsResponse(UniversalBaseModel):
-    detail: typing.Optional[str] = None
+class ProjectsDuplicateResponse(UncheckedBaseModel):
+    id: int = pydantic.Field()
+    """
+    The ID of the duplicated project.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/projects/types/projects_import_tasks_response.py

@@ -1,12 +1,12 @@
 # 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
 import pydantic
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ProjectsImportTasksResponse(UniversalBaseModel):
+class ProjectsImportTasksResponse(UncheckedBaseModel):
     """
     Task creation response
     """

label_studio_sdk/projects/types/projects_list_request_filter.py

@@ -2,4 +2,4 @@
 
 import typing
 
-ProjectsListRequestFilter = typing.Union[typing.Literal["all", "pinned_only", "exclude_pinned"], typing.Any]
+ProjectsListRequestFilter = typing.Union[typing.Literal["all", "exclude_pinned", "pinned_only"], typing.Any]

label_studio_sdk/prompts/__init__.py

@@ -1,19 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import (
-    PromptsBatchFailedPredictionsRequestFailedPredictionsItem,
-    PromptsBatchFailedPredictionsResponse,
-    PromptsBatchPredictionsRequestResultsItem,
-    PromptsBatchPredictionsResponse,
-)
+from .types import PromptsCompatibleProjectsRequestProjectType
 from . import indicators, runs, versions
+from .indicators import IndicatorsListResponseItem
 from .runs import RunsListRequestProjectSubset
 
 __all__ = [
-    "PromptsBatchFailedPredictionsRequestFailedPredictionsItem",
-    "PromptsBatchFailedPredictionsResponse",
-    "PromptsBatchPredictionsRequestResultsItem",
-    "PromptsBatchPredictionsResponse",
+    "IndicatorsListResponseItem",
+    "PromptsCompatibleProjectsRequestProjectType",
     "RunsListRequestProjectSubset",
     "indicators",
     "runs",