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

label_studio_sdk/import_storage/s3/client.py

@@ -21,8 +21,8 @@ class S3Client:
     def list(
         self,
         *,
+        project: int,
         ordering: typing.Optional[str] = None,
-        project: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[S3ImportStorage]:
         """
@@ -30,12 +30,12 @@ class S3Client:
 
         Parameters
         ----------
+        project : int
+            Project ID
+
         ordering : typing.Optional[str]
             Which field to use when ordering the results.
 
-        project : typing.Optional[int]
-            Project ID
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -51,7 +51,9 @@ class S3Client:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.import_storage.s3.list()
+        client.import_storage.s3.list(
+            project=1,
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "api/storages/s3/",
@@ -615,8 +617,8 @@ class AsyncS3Client:
     async def list(
         self,
         *,
+        project: int,
         ordering: typing.Optional[str] = None,
-        project: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[S3ImportStorage]:
         """
@@ -624,12 +626,12 @@ class AsyncS3Client:
 
         Parameters
         ----------
+        project : int
+            Project ID
+
         ordering : typing.Optional[str]
             Which field to use when ordering the results.
 
-        project : typing.Optional[int]
-            Project ID
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -650,7 +652,9 @@ class AsyncS3Client:
 
 
         async def main() -> None:
-            await client.import_storage.s3.list()
+            await client.import_storage.s3.list(
+                project=1,
+            )
 
 
         asyncio.run(main())

label_studio_sdk/import_storage/s3s/client.py

@@ -23,8 +23,8 @@ class S3SClient:
     def list(
         self,
         *,
+        project: int,
         ordering: typing.Optional[str] = None,
-        project: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[LseS3ImportStorage]:
         """
@@ -38,12 +38,12 @@ class S3SClient:
 
         Parameters
         ----------
+        project : int
+            Project ID
+
         ordering : typing.Optional[str]
             Which field to use when ordering the results.
 
-        project : typing.Optional[int]
-            Project ID
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -59,7 +59,9 @@ class S3SClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.import_storage.s3s.list()
+        client.import_storage.s3s.list(
+            project=1,
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "api/storages/s3s/",
@@ -788,8 +790,8 @@ class AsyncS3SClient:
     async def list(
         self,
         *,
+        project: int,
         ordering: typing.Optional[str] = None,
-        project: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[LseS3ImportStorage]:
         """
@@ -803,12 +805,12 @@ class AsyncS3SClient:
 
         Parameters
         ----------
+        project : int
+            Project ID
+
         ordering : typing.Optional[str]
             Which field to use when ordering the results.
 
-        project : typing.Optional[int]
-            Project ID
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -829,7 +831,9 @@ class AsyncS3SClient:
 
 
         async def main() -> None:
-            await client.import_storage.s3s.list()
+            await client.import_storage.s3s.list(
+                project=1,
+            )
 
 
         asyncio.run(main())

label_studio_sdk/label_interface/control_tags.py

@@ -986,7 +986,8 @@ class ChatMessageTag(ControlTag):
                         "role": {"type": "string"},
                         "content": {"type": "string"},
                         "createdAt": {"type": "number"}
-                    }
+                    },
+                    "additionalProperties": True
                 }
             },
             "description": f"Chat message for {self.to_name[0]}"

label_studio_sdk/organizations/__init__.py

@@ -1,6 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import PatchedDefaultRoleRequestCustomScriptsEditableBy
 from . import invites, members, permissions
 
-__all__ = ["PatchedDefaultRoleRequestCustomScriptsEditableBy", "invites", "members", "permissions"]
+__all__ = ["invites", "members", "permissions"]

label_studio_sdk/organizations/client.py

@@ -17,12 +17,8 @@ from ..errors.bad_request_error import BadRequestError
 from ..errors.forbidden_error import ForbiddenError
 from ..errors.not_found_error import NotFoundError
 import datetime as dt
-from .types.patched_default_role_request_custom_scripts_editable_by import (
-    PatchedDefaultRoleRequestCustomScriptsEditableBy,
-)
 from ..types.role9e7enum import Role9E7Enum
 from ..types.default_role import DefaultRole
-from ..core.serialization import convert_and_respect_annotation_metadata
 from ..core.client_wrapper import AsyncClientWrapper
 from .invites.client import AsyncInvitesClient
 from .members.client import AsyncMembersClient
@@ -185,7 +181,6 @@ class OrganizationsClient:
         *,
         contact_info: typing.Optional[str] = OMIT,
         created_by: typing.Optional[int] = OMIT,
-        custom_scripts_editable_by: typing.Optional[str] = OMIT,
         custom_scripts_enabled: typing.Optional[bool] = OMIT,
         email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
         embed_domains: typing.Optional[typing.Sequence[typing.Dict[str, str]]] = OMIT,
@@ -211,8 +206,6 @@ class OrganizationsClient:
 
         created_by : typing.Optional[int]
 
-        custom_scripts_editable_by : typing.Optional[str]
-
         custom_scripts_enabled : typing.Optional[bool]
 
         email_notification_settings : typing.Optional[typing.Optional[typing.Any]]
@@ -250,7 +243,6 @@ class OrganizationsClient:
             json={
                 "contact_info": contact_info,
                 "created_by": created_by,
-                "custom_scripts_editable_by": custom_scripts_editable_by,
                 "custom_scripts_enabled": custom_scripts_enabled,
                 "email_notification_settings": email_notification_settings,
                 "embed_domains": embed_domains,
@@ -313,7 +305,6 @@ class OrganizationsClient:
         id: int,
         *,
         annotator_reviewer_firewall_enabled_at: typing.Optional[dt.datetime] = OMIT,
-        custom_scripts_editable_by: typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy] = OMIT,
         custom_scripts_enabled_at: typing.Optional[dt.datetime] = OMIT,
         default_role: typing.Optional[Role9E7Enum] = OMIT,
         email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
@@ -342,12 +333,6 @@ class OrganizationsClient:
         annotator_reviewer_firewall_enabled_at : typing.Optional[dt.datetime]
             Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
 
-        custom_scripts_editable_by : typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy]
-            Set the minimum user role that can edit custom scripts (Plugins) in the UI.
-
-            * `AD` - Administrator
-            * `MA` - Manager
-
         custom_scripts_enabled_at : typing.Optional[dt.datetime]
             Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).
 
@@ -406,11 +391,6 @@ class OrganizationsClient:
             method="PATCH",
             json={
                 "annotator_reviewer_firewall_enabled_at": annotator_reviewer_firewall_enabled_at,
-                "custom_scripts_editable_by": convert_and_respect_annotation_metadata(
-                    object_=custom_scripts_editable_by,
-                    annotation=PatchedDefaultRoleRequestCustomScriptsEditableBy,
-                    direction="write",
-                ),
                 "custom_scripts_enabled_at": custom_scripts_enabled_at,
                 "default_role": default_role,
                 "email_notification_settings": email_notification_settings,
@@ -620,7 +600,6 @@ class AsyncOrganizationsClient:
         *,
         contact_info: typing.Optional[str] = OMIT,
         created_by: typing.Optional[int] = OMIT,
-        custom_scripts_editable_by: typing.Optional[str] = OMIT,
         custom_scripts_enabled: typing.Optional[bool] = OMIT,
         email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
         embed_domains: typing.Optional[typing.Sequence[typing.Dict[str, str]]] = OMIT,
@@ -646,8 +625,6 @@ class AsyncOrganizationsClient:
 
         created_by : typing.Optional[int]
 
-        custom_scripts_editable_by : typing.Optional[str]
-
         custom_scripts_enabled : typing.Optional[bool]
 
         email_notification_settings : typing.Optional[typing.Optional[typing.Any]]
@@ -693,7 +670,6 @@ class AsyncOrganizationsClient:
             json={
                 "contact_info": contact_info,
                 "created_by": created_by,
-                "custom_scripts_editable_by": custom_scripts_editable_by,
                 "custom_scripts_enabled": custom_scripts_enabled,
                 "email_notification_settings": email_notification_settings,
                 "embed_domains": embed_domains,
@@ -756,7 +732,6 @@ class AsyncOrganizationsClient:
         id: int,
         *,
         annotator_reviewer_firewall_enabled_at: typing.Optional[dt.datetime] = OMIT,
-        custom_scripts_editable_by: typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy] = OMIT,
         custom_scripts_enabled_at: typing.Optional[dt.datetime] = OMIT,
         default_role: typing.Optional[Role9E7Enum] = OMIT,
         email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = OMIT,
@@ -785,12 +760,6 @@ class AsyncOrganizationsClient:
         annotator_reviewer_firewall_enabled_at : typing.Optional[dt.datetime]
             Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
 
-        custom_scripts_editable_by : typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy]
-            Set the minimum user role that can edit custom scripts (Plugins) in the UI.
-
-            * `AD` - Administrator
-            * `MA` - Manager
-
         custom_scripts_enabled_at : typing.Optional[dt.datetime]
             Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).
 
@@ -857,11 +826,6 @@ class AsyncOrganizationsClient:
             method="PATCH",
             json={
                 "annotator_reviewer_firewall_enabled_at": annotator_reviewer_firewall_enabled_at,
-                "custom_scripts_editable_by": convert_and_respect_annotation_metadata(
-                    object_=custom_scripts_editable_by,
-                    annotation=PatchedDefaultRoleRequestCustomScriptsEditableBy,
-                    direction="write",
-                ),
                 "custom_scripts_enabled_at": custom_scripts_enabled_at,
                 "default_role": default_role,
                 "email_notification_settings": email_notification_settings,

label_studio_sdk/organizations/permissions/client.py

@@ -237,6 +237,14 @@ class PermissionsClient:
         self, id: int, permission: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> OrganizationPermission:
         """
+        <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>
+        Retrieve the organization-level permission override for a given permission key.
+
         Parameters
         ----------
         id : int
@@ -410,6 +418,14 @@ class PermissionsClient:
 
     def delete(self, id: int, permission: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+        <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>
+        Delete the organization-level permission override for a given permission key.
+
         Parameters
         ----------
         id : int
@@ -817,6 +833,14 @@ class AsyncPermissionsClient:
         self, id: int, permission: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> OrganizationPermission:
         """
+        <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>
+        Retrieve the organization-level permission override for a given permission key.
+
         Parameters
         ----------
         id : int
@@ -1008,6 +1032,14 @@ class AsyncPermissionsClient:
         self, id: int, permission: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> None:
         """
+        <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>
+        Delete the organization-level permission override for a given permission key.
+
         Parameters
         ----------
         id : int

label_studio_sdk/projects/__init__.py

@@ -9,7 +9,7 @@ from .types import (
     ProjectsImportPredictionsResponse,
     ProjectsImportTasksResponse,
 )
-from . import assignments, exports, members, metrics, pauses, stats
+from . import assignments, exports, members, metrics, pauses, roles, stats
 from .assignments import (
     AssignmentsAssignRequestType,
     AssignmentsBulkAssignRequestFilters,
@@ -29,6 +29,7 @@ from .assignments import (
 from .exports import ExportsConvertResponse
 from .stats import (
     StatsAgreementAnnotatorResponse,
+    StatsAgreementAnnotatorsResponse,
     StatsDataFiltersResponse,
     StatsDataFiltersResponseUserFilters,
     StatsDataFiltersResponseUserFiltersStatsItem,
@@ -52,6 +53,13 @@ from .stats import (
     StatsUserReviewScoreResponse,
     StatsUserReviewScoreResponsePerformanceScore,
     StatsUserReviewScoreResponseReviewScore,
+    StatsUsersGroundTruthAgreementResponse,
+    StatsUsersGroundTruthAgreementResponseAgreementValue,
+    StatsUsersPredictionAgreementResponse,
+    StatsUsersPredictionAgreementResponseAgreementValue,
+    StatsUsersReviewScoreResponse,
+    StatsUsersReviewScoreResponsePerformanceScoreValue,
+    StatsUsersReviewScoreResponseReviewScoreValue,
 )
 
 __all__ = [
@@ -78,6 +86,7 @@ __all__ = [
     "ProjectsImportPredictionsResponse",
     "ProjectsImportTasksResponse",
     "StatsAgreementAnnotatorResponse",
+    "StatsAgreementAnnotatorsResponse",
     "StatsDataFiltersResponse",
     "StatsDataFiltersResponseUserFilters",
     "StatsDataFiltersResponseUserFiltersStatsItem",
@@ -101,10 +110,18 @@ __all__ = [
     "StatsUserReviewScoreResponse",
     "StatsUserReviewScoreResponsePerformanceScore",
     "StatsUserReviewScoreResponseReviewScore",
+    "StatsUsersGroundTruthAgreementResponse",
+    "StatsUsersGroundTruthAgreementResponseAgreementValue",
+    "StatsUsersPredictionAgreementResponse",
+    "StatsUsersPredictionAgreementResponseAgreementValue",
+    "StatsUsersReviewScoreResponse",
+    "StatsUsersReviewScoreResponsePerformanceScoreValue",
+    "StatsUsersReviewScoreResponseReviewScoreValue",
     "assignments",
     "exports",
     "members",
     "metrics",
     "pauses",
+    "roles",
     "stats",
 ]

label_studio_sdk/projects/client.py

@@ -2,6 +2,7 @@
 
 import typing
 from ..core.client_wrapper import SyncClientWrapper
+from .roles.client import RolesClient
 from .exports.client import ExportsClient
 from .members.client import MembersClient
 from .metrics.client import MetricsClient
@@ -39,6 +40,7 @@ from ..types.prediction_request import PredictionRequest
 from .types.projects_import_predictions_response import ProjectsImportPredictionsResponse
 from ..types.project_label_config import ProjectLabelConfig
 from ..core.client_wrapper import AsyncClientWrapper
+from .roles.client import AsyncRolesClient
 from .exports.client import AsyncExportsClient
 from .members.client import AsyncMembersClient
 from .metrics.client import AsyncMetricsClient
@@ -54,6 +56,7 @@ OMIT = typing.cast(typing.Any, ...)
 class ProjectsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
+        self.roles = RolesClient(client_wrapper=self._client_wrapper)
         self.exports = ExportsClient(client_wrapper=self._client_wrapper)
         self.members = MembersClient(client_wrapper=self._client_wrapper)
         self.metrics = MetricsClient(client_wrapper=self._client_wrapper)
@@ -276,6 +279,7 @@ class ProjectsClient:
             If set, the annotator can view model predictions
 
         show_ground_truth_first : typing.Optional[bool]
+            Onboarding mode (true): show ground truth tasks first in the labeling stream
 
         show_instruction : typing.Optional[bool]
             Show instructions to the annotator before they start
@@ -702,6 +706,7 @@ class ProjectsClient:
             If set, the annotator can view model predictions
 
         show_ground_truth_first : typing.Optional[bool]
+            Onboarding mode (true): show ground truth tasks first in the labeling stream
 
         show_instruction : typing.Optional[bool]
             Show instructions to the annotator before they start
@@ -1235,6 +1240,7 @@ class ProjectsClient:
 class AsyncProjectsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
+        self.roles = AsyncRolesClient(client_wrapper=self._client_wrapper)
         self.exports = AsyncExportsClient(client_wrapper=self._client_wrapper)
         self.members = AsyncMembersClient(client_wrapper=self._client_wrapper)
         self.metrics = AsyncMetricsClient(client_wrapper=self._client_wrapper)
@@ -1465,6 +1471,7 @@ class AsyncProjectsClient:
             If set, the annotator can view model predictions
 
         show_ground_truth_first : typing.Optional[bool]
+            Onboarding mode (true): show ground truth tasks first in the labeling stream
 
         show_instruction : typing.Optional[bool]
             Show instructions to the annotator before they start
@@ -1923,6 +1930,7 @@ class AsyncProjectsClient:
             If set, the annotator can view model predictions
 
         show_ground_truth_first : typing.Optional[bool]
+            Onboarding mode (true): show ground truth tasks first in the labeling stream
 
         show_instruction : typing.Optional[bool]
             Show instructions to the annotator before they start