label-studio-sdk 2.0.11__py3-none-any.whl → 2.0.12__py3-none-any.whl

label_studio_sdk/projects/stats/client.py

@@ -12,10 +12,12 @@ from .types.stats_model_version_ground_truth_agreement_response import StatsMode
 from .types.stats_model_version_prediction_agreement_response import StatsModelVersionPredictionAgreementResponse
 from .types.stats_iaa_response import StatsIaaResponse
 from .types.stats_agreement_annotator_response import StatsAgreementAnnotatorResponse
+from .types.stats_agreement_annotators_response import StatsAgreementAnnotatorsResponse
 from .types.stats_data_filters_response import StatsDataFiltersResponse
 from .types.stats_finished_tasks_response import StatsFinishedTasksResponse
 from .types.stats_lead_time_response import StatsLeadTimeResponse
 from .types.stats_total_agreement_response import StatsTotalAgreementResponse
+from .types.stats_users_prediction_agreement_response import StatsUsersPredictionAgreementResponse
 from .types.stats_user_prediction_agreement_response import StatsUserPredictionAgreementResponse
 from .types.stats_user_review_score_response import StatsUserReviewScoreResponse
 from .types.stats_user_ground_truth_agreement_response import StatsUserGroundTruthAgreementResponse
@@ -355,6 +357,67 @@ class StatsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def agreement_annotators(
+        self, id: int, *, ids: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> StatsAgreementAnnotatorsResponse:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Get agreement statistics for multiple annotators within a project.
+
+        Parameters
+        ----------
+        id : int
+
+        ids : str
+            Comma separated list of annotator user IDs to get agreement scores for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StatsAgreementAnnotatorsResponse
+            Multiple annotator agreement statistics
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.stats.agreement_annotators(
+            id=1,
+            ids="ids",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/stats/agreement_annotators",
+            method="GET",
+            params={
+                "ids": ids,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    StatsAgreementAnnotatorsResponse,
+                    construct_type(
+                        type_=StatsAgreementAnnotatorsResponse,  # 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 data_filters(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> StatsDataFiltersResponse:
@@ -627,6 +690,76 @@ class StatsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def users_prediction_agreement(
+        self,
+        id: int,
+        *,
+        ids: str,
+        per_label: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> StatsUsersPredictionAgreementResponse:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Get prediction agreement statistics for multiple annotators within a project.
+
+        Parameters
+        ----------
+        id : int
+
+        ids : str
+            Comma separated list of annotator user IDs to get agreement scores for
+
+        per_label : typing.Optional[bool]
+            Per label
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StatsUsersPredictionAgreementResponse
+            Prediction agreement statistics for multiple annotators
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.stats.users_prediction_agreement(
+            id=1,
+            ids="ids",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/user-stats/prediction",
+            method="GET",
+            params={
+                "ids": ids,
+                "per_label": per_label,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    StatsUsersPredictionAgreementResponse,
+                    construct_type(
+                        type_=StatsUsersPredictionAgreementResponse,  # 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 user_prediction_agreement(
         self,
         id: int,
@@ -1205,6 +1338,75 @@ class AsyncStatsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    async def agreement_annotators(
+        self, id: int, *, ids: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> StatsAgreementAnnotatorsResponse:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Get agreement statistics for multiple annotators within a project.
+
+        Parameters
+        ----------
+        id : int
+
+        ids : str
+            Comma separated list of annotator user IDs to get agreement scores for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StatsAgreementAnnotatorsResponse
+            Multiple annotator agreement statistics
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.stats.agreement_annotators(
+                id=1,
+                ids="ids",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/stats/agreement_annotators",
+            method="GET",
+            params={
+                "ids": ids,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    StatsAgreementAnnotatorsResponse,
+                    construct_type(
+                        type_=StatsAgreementAnnotatorsResponse,  # 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 data_filters(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> StatsDataFiltersResponse:
@@ -1519,6 +1721,84 @@ class AsyncStatsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    async def users_prediction_agreement(
+        self,
+        id: int,
+        *,
+        ids: str,
+        per_label: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> StatsUsersPredictionAgreementResponse:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Get prediction agreement statistics for multiple annotators within a project.
+
+        Parameters
+        ----------
+        id : int
+
+        ids : str
+            Comma separated list of annotator user IDs to get agreement scores for
+
+        per_label : typing.Optional[bool]
+            Per label
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StatsUsersPredictionAgreementResponse
+            Prediction agreement statistics for multiple annotators
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.stats.users_prediction_agreement(
+                id=1,
+                ids="ids",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/user-stats/prediction",
+            method="GET",
+            params={
+                "ids": ids,
+                "per_label": per_label,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    StatsUsersPredictionAgreementResponse,
+                    construct_type(
+                        type_=StatsUsersPredictionAgreementResponse,  # 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 user_prediction_agreement(
         self,
         id: int,

label_studio_sdk/projects/stats/types/__init__.py

@@ -1,6 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .stats_agreement_annotator_response import StatsAgreementAnnotatorResponse
+from .stats_agreement_annotators_response import StatsAgreementAnnotatorsResponse
 from .stats_data_filters_response import StatsDataFiltersResponse
 from .stats_data_filters_response_user_filters import StatsDataFiltersResponseUserFilters
 from .stats_data_filters_response_user_filters_stats_item import StatsDataFiltersResponseUserFiltersStatsItem
@@ -26,9 +27,14 @@ from .stats_user_prediction_agreement_response_average_prediction_agreement_per_
 from .stats_user_review_score_response import StatsUserReviewScoreResponse
 from .stats_user_review_score_response_performance_score import StatsUserReviewScoreResponsePerformanceScore
 from .stats_user_review_score_response_review_score import StatsUserReviewScoreResponseReviewScore
+from .stats_users_prediction_agreement_response import StatsUsersPredictionAgreementResponse
+from .stats_users_prediction_agreement_response_agreement_value import (
+    StatsUsersPredictionAgreementResponseAgreementValue,
+)
 
 __all__ = [
     "StatsAgreementAnnotatorResponse",
+    "StatsAgreementAnnotatorsResponse",
     "StatsDataFiltersResponse",
     "StatsDataFiltersResponseUserFilters",
     "StatsDataFiltersResponseUserFiltersStatsItem",
@@ -52,4 +58,6 @@ __all__ = [
     "StatsUserReviewScoreResponse",
     "StatsUserReviewScoreResponsePerformanceScore",
     "StatsUserReviewScoreResponseReviewScore",
+    "StatsUsersPredictionAgreementResponse",
+    "StatsUsersPredictionAgreementResponseAgreementValue",
 ]

label_studio_sdk/projects/stats/types/stats_agreement_annotators_response.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
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class StatsAgreementAnnotatorsResponse(UncheckedBaseModel):
+    agreement: typing.Dict[str, float] = pydantic.Field()
+    """
+    Mapping of annotator ID to their agreement score (0-1) or null if no data
+    """
+
+    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_users_prediction_agreement_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ....core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .stats_users_prediction_agreement_response_agreement_value import (
+    StatsUsersPredictionAgreementResponseAgreementValue,
+)
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class StatsUsersPredictionAgreementResponse(UncheckedBaseModel):
+    agreement: typing.Optional[typing.Dict[str, StatsUsersPredictionAgreementResponseAgreementValue]] = pydantic.Field(
+        default=None
+    )
+    """
+    Dictionary mapping user IDs to their prediction agreement scores
+    """
+
+    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_users_prediction_agreement_response_agreement_value.py

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

label_studio_sdk/types/__init__.py

@@ -163,13 +163,18 @@ from .pause import Pause
 from .pause_request import PauseRequest
 from .prediction import Prediction
 from .prediction_request import PredictionRequest
+from .project import Project
 from .project_group import ProjectGroup
 from .project_group_request import ProjectGroupRequest
 from .project_group_role_enum import ProjectGroupRoleEnum
 from .project_import import ProjectImport
 from .project_label_config import ProjectLabelConfig
 from .project_label_config_request import ProjectLabelConfigRequest
+from .project_member import ProjectMember
 from .project_member_bulk_assign_roles_request import ProjectMemberBulkAssignRolesRequest
+from .project_role import ProjectRole
+from .project_sampling import ProjectSampling
+from .project_skip_queue import ProjectSkipQueue
 from .project_subset_enum import ProjectSubsetEnum
 from .project_subset_item import ProjectSubsetItem
 from .project_subset_task_item import ProjectSubsetTaskItem
@@ -400,13 +405,18 @@ __all__ = [
     "PauseRequest",
     "Prediction",
     "PredictionRequest",
+    "Project",
     "ProjectGroup",
     "ProjectGroupRequest",
     "ProjectGroupRoleEnum",
     "ProjectImport",
     "ProjectLabelConfig",
     "ProjectLabelConfigRequest",
+    "ProjectMember",
     "ProjectMemberBulkAssignRolesRequest",
+    "ProjectRole",
+    "ProjectSampling",
+    "ProjectSkipQueue",
     "ProjectSubsetEnum",
     "ProjectSubsetItem",
     "ProjectSubsetTaskItem",

label_studio_sdk/types/all_roles_project_list.py

@@ -151,7 +151,11 @@ class AllRolesProjectList(UncheckedBaseModel):
     If set, the annotator can view model predictions
     """
 
-    show_ground_truth_first: typing.Optional[bool] = None
+    show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Onboarding mode (true): show ground truth tasks first in the labeling stream
+    """
+
     show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Show instructions to the annotator before they start

label_studio_sdk/types/lse_project.py

@@ -151,7 +151,11 @@ class LseProject(UncheckedBaseModel):
     If set, the annotator can view model predictions
     """
 
-    show_ground_truth_first: typing.Optional[bool] = None
+    show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Onboarding mode (true): show ground truth tasks first in the labeling stream
+    """
+
     show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Show instructions to the annotator before they start

label_studio_sdk/types/lse_project_create.py

@@ -126,7 +126,11 @@ class LseProjectCreate(UncheckedBaseModel):
     If set, the annotator can view model predictions
     """
 
-    show_ground_truth_first: typing.Optional[bool] = None
+    show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Onboarding mode (true): show ground truth tasks first in the labeling stream
+    """
+
     show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Show instructions to the annotator before they start

label_studio_sdk/types/lse_project_response.py

@@ -151,7 +151,11 @@ class LseProjectResponse(UncheckedBaseModel):
     If set, the annotator can view model predictions
     """
 
-    show_ground_truth_first: typing.Optional[bool] = None
+    show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Onboarding mode (true): show ground truth tasks first in the labeling stream
+    """
+
     show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Show instructions to the annotator before they start

label_studio_sdk/types/lse_project_update.py

@@ -144,7 +144,11 @@ class LseProjectUpdate(UncheckedBaseModel):
     If set, the annotator can view model predictions
     """
 
-    show_ground_truth_first: typing.Optional[bool] = None
+    show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Onboarding mode (true): show ground truth tasks first in the labeling stream
+    """
+
     show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Show instructions to the annotator before they start