label-studio-sdk 2.0.3__py3-none-any.whl → 2.0.5__py3-none-any.whl

label_studio_sdk/projects/stats/client.py

@@ -8,6 +8,7 @@ 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 .types.stats_total_agreement_response import StatsTotalAgreementResponse
 from ...core.client_wrapper import AsyncClientWrapper
 
 
@@ -88,6 +89,66 @@ class StatsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def total_agreement(
+        self,
+        id: int,
+        *,
+        per_label: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> StatsTotalAgreementResponse:
+        """
+        Overall or per-label total agreement across the project.
+
+        NOTE: due to an open issue in Fern, SDK clients will raise ApiError upon handling a 204 response. As a workaround, wrap call to this function in a try-except block.
+
+        Parameters
+        ----------
+        id : int
+
+        per_label : typing.Optional[bool]
+            Return agreement per label
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StatsTotalAgreementResponse
+            Total agreement
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.stats.total_agreement(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/stats/total_agreement",
+            method="GET",
+            params={
+                "per_label": per_label,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    StatsTotalAgreementResponse,
+                    construct_type(
+                        type_=StatsTotalAgreementResponse,  # 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):
@@ -173,3 +234,71 @@ class AsyncStatsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def total_agreement(
+        self,
+        id: int,
+        *,
+        per_label: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> StatsTotalAgreementResponse:
+        """
+        Overall or per-label total agreement across the project.
+
+        NOTE: due to an open issue in Fern, SDK clients will raise ApiError upon handling a 204 response. As a workaround, wrap call to this function in a try-except block.
+
+        Parameters
+        ----------
+        id : int
+
+        per_label : typing.Optional[bool]
+            Return agreement per label
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        StatsTotalAgreementResponse
+            Total agreement
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.stats.total_agreement(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/stats/total_agreement",
+            method="GET",
+            params={
+                "per_label": per_label,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    StatsTotalAgreementResponse,
+                    construct_type(
+                        type_=StatsTotalAgreementResponse,  # 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

@@ -4,5 +4,16 @@ 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
+from .stats_total_agreement_response import StatsTotalAgreementResponse
+from .stats_total_agreement_response_one import StatsTotalAgreementResponseOne
+from .stats_total_agreement_response_zero import StatsTotalAgreementResponseZero
 
-__all__ = ["StatsIaaResponse", "StatsIaaResponseCommonTasks", "StatsIaaResponseIaa", "StatsIaaResponseStd"]
+__all__ = [
+    "StatsIaaResponse",
+    "StatsIaaResponseCommonTasks",
+    "StatsIaaResponseIaa",
+    "StatsIaaResponseStd",
+    "StatsTotalAgreementResponse",
+    "StatsTotalAgreementResponseOne",
+    "StatsTotalAgreementResponseZero",
+]

label_studio_sdk/projects/stats/types/stats_total_agreement_response.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .stats_total_agreement_response_zero import StatsTotalAgreementResponseZero
+from .stats_total_agreement_response_one import StatsTotalAgreementResponseOne
+
+StatsTotalAgreementResponse = typing.Union[StatsTotalAgreementResponseZero, StatsTotalAgreementResponseOne]

label_studio_sdk/projects/stats/types/stats_total_agreement_response_one.py

@@ -0,0 +1,19 @@
+# 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 StatsTotalAgreementResponseOne(UncheckedBaseModel):
+    total_agreement: typing.Optional[typing.Dict[str, float]] = 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/projects/stats/types/stats_total_agreement_response_zero.py

@@ -0,0 +1,19 @@
+# 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 StatsTotalAgreementResponseZero(UncheckedBaseModel):
+    total_agreement: typing.Optional[float] = 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/types/__init__.py

@@ -1,6 +1,8 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .actions_enum import ActionsEnum
+from .activity_log import ActivityLog
+from .activity_log_response import ActivityLogResponse
 from .all_roles_project_list import AllRolesProjectList
 from .all_roles_project_list_sampling import AllRolesProjectListSampling
 from .all_roles_project_list_skip_queue import AllRolesProjectListSkipQueue
@@ -99,6 +101,7 @@ from .lseapi_token_create import LseapiTokenCreate
 from .lseapi_token_list import LseapiTokenList
 from .lsejwt_settings import LsejwtSettings
 from .maybe_expanded_comment import MaybeExpandedComment
+from .metric_param import MetricParam
 from .ml_backend import MlBackend
 from .mode_enum import ModeEnum
 from .model_interface import ModelInterface
@@ -182,12 +185,18 @@ from .version_response import VersionResponse
 from .view import View
 from .webhook import Webhook
 from .webhook_serializer_for_update import WebhookSerializerForUpdate
+from .who_am_i_lse_fields import WhoAmILseFields
+from .who_am_i_lse_fields_onboarding_state import WhoAmILseFieldsOnboardingState
+from .who_am_i_lse_fields_trial_role import WhoAmILseFieldsTrialRole
+from .who_am_i_user import WhoAmIUser
 from .workspace import Workspace
 from .workspace_member_create import WorkspaceMemberCreate
 from .workspace_member_list import WorkspaceMemberList
 
 __all__ = [
     "ActionsEnum",
+    "ActivityLog",
+    "ActivityLogResponse",
     "AllRolesProjectList",
     "AllRolesProjectListSampling",
     "AllRolesProjectListSkipQueue",
@@ -284,6 +293,7 @@ __all__ = [
     "LseapiTokenList",
     "LsejwtSettings",
     "MaybeExpandedComment",
+    "MetricParam",
     "MlBackend",
     "ModeEnum",
     "ModelInterface",
@@ -367,6 +377,10 @@ __all__ = [
     "View",
     "Webhook",
     "WebhookSerializerForUpdate",
+    "WhoAmILseFields",
+    "WhoAmILseFieldsOnboardingState",
+    "WhoAmILseFieldsTrialRole",
+    "WhoAmIUser",
     "Workspace",
     "WorkspaceMemberCreate",
     "WorkspaceMemberList",

label_studio_sdk/types/activity_log.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import datetime as dt
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ActivityLog(UncheckedBaseModel):
+    datetime: dt.datetime
+    duration: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Duration of response generation in ms
+    """
+
+    email: str
+    extra_data: typing.Optional[typing.Optional[typing.Any]] = None
+    http_referer: typing.Optional[str] = None
+    id: int
+    ip_address: typing.Optional[str] = None
+    organization_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Organization id
+    """
+
+    project_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Project id if request has it
+    """
+
+    request_method: str
+    request_url: str
+    response_code: str
+    user_agent: typing.Optional[str] = None
+    user_id: int
+    workspace_owner_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Owner id of workspace where action performed
+    """
+
+    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/types/activity_log_response.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .activity_log import ActivityLog
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ActivityLogResponse(UncheckedBaseModel):
+    """
+    Serializer for ActivityLogAPI response.
+    """
+
+    data: typing.List[ActivityLog]
+    records_filtered: typing_extensions.Annotated[int, FieldMetadata(alias="recordsFiltered")]
+    records_total: typing_extensions.Annotated[int, FieldMetadata(alias="recordsTotal")]
+
+    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/types/metric_param.py

@@ -0,0 +1,31 @@
+# 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 MetricParam(UncheckedBaseModel):
+    agreement_threshold: str
+    allowed: str
+    max_additional_annotators_assignable: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Maximum number of additional annotators that can be assigned to a low agreement task
+    """
+
+    metric_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Evaluation metric chosen for this project
+    """
+
+    metric_params: typing.Optional[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/types/who_am_i_lse_fields.py

@@ -0,0 +1,50 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import datetime as dt
+from .who_am_i_lse_fields_onboarding_state import WhoAmILseFieldsOnboardingState
+import pydantic
+from .who_am_i_lse_fields_trial_role import WhoAmILseFieldsTrialRole
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class WhoAmILseFields(UncheckedBaseModel):
+    active_organization_external_id: typing.Optional[str] = None
+    email_notification_settings: str
+    invite_activated: typing.Optional[bool] = None
+    invite_expired: str
+    invite_expired_at: str
+    invited_at: typing.Optional[dt.datetime] = None
+    invited_by: typing.Optional[int] = None
+    onboarding_state: typing.Optional[WhoAmILseFieldsOnboardingState] = pydantic.Field(default=None)
+    """
+    The current stage of user onboarding
+    
+    * `not_started` - Not Started
+    * `signup` - Signup
+    * `trial_signup` - Trial Signup
+    * `first_tutorial` - First Tutorial
+    * `in_app_guidance` - In App Guidance
+    * `complete` - Complete
+    """
+
+    social_auth_finished: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Is user finished social authentication
+    """
+
+    trial_company: typing.Optional[str] = None
+    trial_experience_labeling: typing.Optional[str] = None
+    trial_license_enterprise: typing.Optional[bool] = None
+    trial_models_in_production: typing.Optional[str] = None
+    trial_role: typing.Optional[WhoAmILseFieldsTrialRole] = 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/types/who_am_i_lse_fields_onboarding_state.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .onboarding_state_enum import OnboardingStateEnum
+from .blank_enum import BlankEnum
+from .null_enum import NullEnum
+
+WhoAmILseFieldsOnboardingState = typing.Union[OnboardingStateEnum, BlankEnum, NullEnum]

label_studio_sdk/types/who_am_i_lse_fields_trial_role.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .trial_role_enum import TrialRoleEnum
+from .blank_enum import BlankEnum
+from .null_enum import NullEnum
+
+WhoAmILseFieldsTrialRole = typing.Union[TrialRoleEnum, BlankEnum, NullEnum]

label_studio_sdk/types/who_am_i_user.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+import datetime as dt
+from .who_am_i_lse_fields import WhoAmILseFields
+from .organization_membership import OrganizationMembership
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class WhoAmIUser(UncheckedBaseModel):
+    """
+    A ModelSerializer that takes additional arguments for
+    "fields", "omit" and "expand" in order to
+    control which fields are displayed, and whether to replace simple
+    values with complex, nested serializations
+    """
+
+    active_organization: typing.Optional[int] = None
+    active_organization_meta: str
+    allow_newsletters: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow sending newsletters to user
+    """
+
+    avatar: str
+    custom_hotkeys: typing.Optional[typing.Optional[typing.Any]] = None
+    date_joined: typing.Optional[dt.datetime] = None
+    email: typing.Optional[str] = None
+    first_name: typing.Optional[str] = None
+    id: int
+    initials: str
+    last_activity: dt.datetime
+    last_name: typing.Optional[str] = None
+    lse_fields: WhoAmILseFields
+    org_membership: typing.List[OrganizationMembership]
+    pause: str
+    phone: typing.Optional[str] = None
+    username: str
+
+    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/users/client.py

@@ -11,6 +11,7 @@ import datetime as dt
 from ..types.hotkeys import Hotkeys
 from .types.users_reset_token_response import UsersResetTokenResponse
 from .types.users_get_token_response import UsersGetTokenResponse
+from ..types.who_am_i_user import WhoAmIUser
 from ..types.lse_user import LseUser
 from ..core.jsonable_encoder import jsonable_encoder
 from ..core.client_wrapper import AsyncClientWrapper
@@ -348,7 +349,7 @@ class UsersClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def whoami(self, *, request_options: typing.Optional[RequestOptions] = None) -> LseUser:
+    def whoami(self, *, request_options: typing.Optional[RequestOptions] = None) -> WhoAmIUser:
         """
         Retrieve details of the account that you are using to access the API.
 
@@ -359,7 +360,7 @@ class UsersClient:
 
         Returns
         -------
-        LseUser
+        WhoAmIUser
 
 
         Examples
@@ -379,9 +380,9 @@ class UsersClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    LseUser,
+                    WhoAmIUser,
                     construct_type(
-                        type_=LseUser,  # type: ignore
+                        type_=WhoAmIUser,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -1109,7 +1110,7 @@ class AsyncUsersClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def whoami(self, *, request_options: typing.Optional[RequestOptions] = None) -> LseUser:
+    async def whoami(self, *, request_options: typing.Optional[RequestOptions] = None) -> WhoAmIUser:
         """
         Retrieve details of the account that you are using to access the API.
 
@@ -1120,7 +1121,7 @@ class AsyncUsersClient:
 
         Returns
         -------
-        LseUser
+        WhoAmIUser
 
 
         Examples
@@ -1148,9 +1149,9 @@ class AsyncUsersClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    LseUser,
+                    WhoAmIUser,
                     construct_type(
-                        type_=LseUser,  # type: ignore
+                        type_=WhoAmIUser,  # type: ignore
                         object_=_response.json(),
                     ),
                 )

label_studio_sdk/workspaces/members/__init__.py

@@ -1,2 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
+from . import bulk
+from .bulk import BulkDeleteResponse, BulkPostResponse
+
+__all__ = ["BulkDeleteResponse", "BulkPostResponse", "bulk"]

label_studio_sdk/workspaces/members/bulk/__init__.py

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