label-studio-sdk 2.0.12__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

@@ -53,8 +53,13 @@ from .stats import (
     StatsUserReviewScoreResponse,
     StatsUserReviewScoreResponsePerformanceScore,
     StatsUserReviewScoreResponseReviewScore,
+    StatsUsersGroundTruthAgreementResponse,
+    StatsUsersGroundTruthAgreementResponseAgreementValue,
     StatsUsersPredictionAgreementResponse,
     StatsUsersPredictionAgreementResponseAgreementValue,
+    StatsUsersReviewScoreResponse,
+    StatsUsersReviewScoreResponsePerformanceScoreValue,
+    StatsUsersReviewScoreResponseReviewScoreValue,
 )
 
 __all__ = [
@@ -105,8 +110,13 @@ __all__ = [
     "StatsUserReviewScoreResponse",
     "StatsUserReviewScoreResponsePerformanceScore",
     "StatsUserReviewScoreResponseReviewScore",
+    "StatsUsersGroundTruthAgreementResponse",
+    "StatsUsersGroundTruthAgreementResponseAgreementValue",
     "StatsUsersPredictionAgreementResponse",
     "StatsUsersPredictionAgreementResponseAgreementValue",
+    "StatsUsersReviewScoreResponse",
+    "StatsUsersReviewScoreResponsePerformanceScoreValue",
+    "StatsUsersReviewScoreResponseReviewScoreValue",
     "assignments",
     "exports",
     "members",

label_studio_sdk/projects/metrics/custom/client.py

@@ -23,6 +23,12 @@ class CustomClient:
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> CustomGetLambdaResponse:
         """
+        <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 the AWS Lambda code for the custom metric configured for this project.
 
         Parameters
@@ -77,6 +83,12 @@ class CustomClient:
         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>
         Create or update the AWS Lambda function used for custom metrics in this project.
 
         Parameters
@@ -150,6 +162,12 @@ class CustomClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Dict[str, typing.Optional[typing.Any]]:
         """
+        <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 AWS lambda logs for project, including filtering by start and end dates
 
         Parameters
@@ -210,6 +228,12 @@ class CustomClient:
 
     def check_function(self, id: int, *, code: 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>
         Validate custom matching function code for the project.
 
         Parameters
@@ -266,6 +290,12 @@ class AsyncCustomClient:
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> CustomGetLambdaResponse:
         """
+        <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 the AWS Lambda code for the custom metric configured for this project.
 
         Parameters
@@ -328,6 +358,12 @@ class AsyncCustomClient:
         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>
         Create or update the AWS Lambda function used for custom metrics in this project.
 
         Parameters
@@ -409,6 +445,12 @@ class AsyncCustomClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Dict[str, typing.Optional[typing.Any]]:
         """
+        <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 AWS lambda logs for project, including filtering by start and end dates
 
         Parameters
@@ -479,6 +521,12 @@ class AsyncCustomClient:
         self, id: int, *, code: 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>
         Validate custom matching function code for the project.
 
         Parameters

label_studio_sdk/projects/stats/__init__.py

@@ -26,8 +26,13 @@ from .types import (
     StatsUserReviewScoreResponse,
     StatsUserReviewScoreResponsePerformanceScore,
     StatsUserReviewScoreResponseReviewScore,
+    StatsUsersGroundTruthAgreementResponse,
+    StatsUsersGroundTruthAgreementResponseAgreementValue,
     StatsUsersPredictionAgreementResponse,
     StatsUsersPredictionAgreementResponseAgreementValue,
+    StatsUsersReviewScoreResponse,
+    StatsUsersReviewScoreResponsePerformanceScoreValue,
+    StatsUsersReviewScoreResponseReviewScoreValue,
 )
 
 __all__ = [
@@ -56,6 +61,11 @@ __all__ = [
     "StatsUserReviewScoreResponse",
     "StatsUserReviewScoreResponsePerformanceScore",
     "StatsUserReviewScoreResponseReviewScore",
+    "StatsUsersGroundTruthAgreementResponse",
+    "StatsUsersGroundTruthAgreementResponseAgreementValue",
     "StatsUsersPredictionAgreementResponse",
     "StatsUsersPredictionAgreementResponseAgreementValue",
+    "StatsUsersReviewScoreResponse",
+    "StatsUsersReviewScoreResponsePerformanceScoreValue",
+    "StatsUsersReviewScoreResponseReviewScoreValue",
 ]