label-studio-sdk 2.0.0__tar.gz → 2.0.2__tar.gz

{label_studio_sdk-2.0.0 → label_studio_sdk-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 2.0.0
+Version: 2.0.2
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers
@@ -45,29 +45,6 @@ Description-Content-Type: text/markdown
 
 # Label Studio Python Library
 
-<!-- Note about deprecated version <1 -->
----
-> :warning: **Note**<br/>
->
-> The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
-> If you still want to use the old version, you can install it with `pip install "label-studio-sdk<1"`.
-> OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
->
-> ```sh
-> git clone https://github.com/HumanSignal/label-studio-sdk.git
-> cd label-studio-sdk
-> git fetch origin
-> git checkout release/0.0.34
-> ```
-> 
-> OR you can change your import statements as follows:
-> ```python
-> from label_studio_sdk import Client
-> from label_studio_sdk.data_manager import Filters, Column, Operator, Type
-> from label_studio_sdk._legacy import Project
-> ```
----
-
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
 [![pypi](https://img.shields.io/pypi/v/label-studio-sdk.svg)](https://pypi.python.org/pypi/label-studio-sdk)
 
@@ -100,6 +77,77 @@ ls = LabelStudio(
 )
 ```
 
+# Versions
+
+## SDK 2.0.0
+
+In August 2025, we released SDK version 2.0.0. 
+
+This version has a number of documentation and functional improvements over SDK 1. 
+
+### Enhancements 
+
+**Enterprise-only**
+
+- Added a new `projects.stats.iaa` endpoint to return stats from the inter-annotator agreement matrix. 
+- You can now update tasks that have comments.
+- Added support for `sync` to `S3s` (S3 with IAM role) exports.
+
+**Enterprise and open source**
+
+- Expanded support to include all project settings, many of which were missing in SDK 1. For example, in Enterprise environments you can now configure `assignment_settings`, `review_settings`, `annotator_evaluation`, and many more.
+- Fixed passing the `project` parameter in `actions.list()` (broken in SDK 1). 
+- Relaxed request/response validation reduces pydantic errors in SDK 2.
+
+### Breaking changes
+
+**Enterprise-only**
+
+- `comments.create` no longer accepts a `project` argument.
+- In `prompts.indicators`, the `pk` parameter is now `id`.
+- In `prompts.runs` and `prompts.versions`, the `id` parameter is now `prompt_id`.
+- `workspaces.members.list` responses are now objects instead of dictionaries.
+
+**Enterprise and open source**
+
+- In `projects.exports` calls, the project ID is now passed as `id`, while the export ID is passed as `export_pk`.
+- Predictions returned in task responses are now objects instead of dictionaries. 
+
+## SDK 1.0+
+
+SDK 1 was released in June 2024. 
+
+If you use the Label Studio SDK 1 package in any automated pipelines, we strongly recommend pinning your SDK version to `<2.0.0` until you can reconcile the breaking changes. 
+
+
+## SDK <1
+
+The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
+
+<details>
+
+<summary> To use SDK <1 </summary>
+
+If you still want to use the deprecated version, you can install it with `pip install "label-studio-sdk<1"`. 
+
+OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
+
+```sh
+git clone https://github.com/HumanSignal/label-studio-sdk.git
+cd label-studio-sdk
+git fetch origin
+git checkout release/0.0.34
+```
+
+OR you can change your import statements as follows:
+```python
+from label_studio_sdk import Client
+from label_studio_sdk.data_manager import Filters, Column, Operator, Type
+from label_studio_sdk._legacy import Project
+```
+
+</details>
+
 # Examples
 
 Check more examples [here](https://api.labelstud.io/).
@@ -111,7 +159,7 @@ from label_studio_sdk.label_interface import LabelInterface
 from label_studio_sdk.label_interface.create import labels
 
 project = ls.projects.create(
-    name="Project name",
+    title="Project name",
     description="Project description",
     label_config=LabelInterface.create({
       "image": "Image",

{label_studio_sdk-2.0.0 → label_studio_sdk-2.0.2}/README.md

@@ -1,28 +1,5 @@
 # Label Studio Python Library
 
-<!-- Note about deprecated version <1 -->
----
-> :warning: **Note**<br/>
->
-> The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
-> If you still want to use the old version, you can install it with `pip install "label-studio-sdk<1"`.
-> OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
->
-> ```sh
-> git clone https://github.com/HumanSignal/label-studio-sdk.git
-> cd label-studio-sdk
-> git fetch origin
-> git checkout release/0.0.34
-> ```
-> 
-> OR you can change your import statements as follows:
-> ```python
-> from label_studio_sdk import Client
-> from label_studio_sdk.data_manager import Filters, Column, Operator, Type
-> from label_studio_sdk._legacy import Project
-> ```
----
-
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
 [![pypi](https://img.shields.io/pypi/v/label-studio-sdk.svg)](https://pypi.python.org/pypi/label-studio-sdk)
 
@@ -55,6 +32,77 @@ ls = LabelStudio(
 )
 ```
 
+# Versions
+
+## SDK 2.0.0
+
+In August 2025, we released SDK version 2.0.0. 
+
+This version has a number of documentation and functional improvements over SDK 1. 
+
+### Enhancements 
+
+**Enterprise-only**
+
+- Added a new `projects.stats.iaa` endpoint to return stats from the inter-annotator agreement matrix. 
+- You can now update tasks that have comments.
+- Added support for `sync` to `S3s` (S3 with IAM role) exports.
+
+**Enterprise and open source**
+
+- Expanded support to include all project settings, many of which were missing in SDK 1. For example, in Enterprise environments you can now configure `assignment_settings`, `review_settings`, `annotator_evaluation`, and many more.
+- Fixed passing the `project` parameter in `actions.list()` (broken in SDK 1). 
+- Relaxed request/response validation reduces pydantic errors in SDK 2.
+
+### Breaking changes
+
+**Enterprise-only**
+
+- `comments.create` no longer accepts a `project` argument.
+- In `prompts.indicators`, the `pk` parameter is now `id`.
+- In `prompts.runs` and `prompts.versions`, the `id` parameter is now `prompt_id`.
+- `workspaces.members.list` responses are now objects instead of dictionaries.
+
+**Enterprise and open source**
+
+- In `projects.exports` calls, the project ID is now passed as `id`, while the export ID is passed as `export_pk`.
+- Predictions returned in task responses are now objects instead of dictionaries. 
+
+## SDK 1.0+
+
+SDK 1 was released in June 2024. 
+
+If you use the Label Studio SDK 1 package in any automated pipelines, we strongly recommend pinning your SDK version to `<2.0.0` until you can reconcile the breaking changes. 
+
+
+## SDK <1
+
+The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
+
+<details>
+
+<summary> To use SDK <1 </summary>
+
+If you still want to use the deprecated version, you can install it with `pip install "label-studio-sdk<1"`. 
+
+OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
+
+```sh
+git clone https://github.com/HumanSignal/label-studio-sdk.git
+cd label-studio-sdk
+git fetch origin
+git checkout release/0.0.34
+```
+
+OR you can change your import statements as follows:
+```python
+from label_studio_sdk import Client
+from label_studio_sdk.data_manager import Filters, Column, Operator, Type
+from label_studio_sdk._legacy import Project
+```
+
+</details>
+
 # Examples
 
 Check more examples [here](https://api.labelstud.io/).
@@ -66,7 +114,7 @@ from label_studio_sdk.label_interface import LabelInterface
 from label_studio_sdk.label_interface.create import labels
 
 project = ls.projects.create(
-    name="Project name",
+    title="Project name",
     description="Project description",
     label_config=LabelInterface.create({
       "image": "Image",

{label_studio_sdk-2.0.0 → label_studio_sdk-2.0.2}/pyproject.toml

@@ -3,7 +3,7 @@ name = "label-studio-sdk"
 
 [tool.poetry]
 name = "label-studio-sdk"
-version = "2.0.0"
+version = "2.0.2"
 description = ""
 readme = "README.md"
 authors = []

{label_studio_sdk-2.0.0 → label_studio_sdk-2.0.2}/src/label_studio_sdk/__init__.py

@@ -20,6 +20,9 @@ from .types import (
     AzureBlobImportStorage,
     BatchFailedPredictions,
     BatchPredictions,
+    BillingChecks,
+    BillingFlags,
+    BillingInfoResponse,
     BlankEnum,
     BlueprintList,
     BudgetResetPeriodEnum,
@@ -29,6 +32,7 @@ from .types import (
     CommentSerializerWithExpandedUser,
     ConvertedFormat,
     ConvertedFormatRequest,
+    CountLimit,
     CustomScriptsEditableByEnum,
     DefaultRoleEnum,
     EditionEnum,
@@ -57,6 +61,7 @@ from .types import (
     LseKeyIndicatorValue,
     LseOrganization,
     LseOrganizationCustomScriptsEditableBy,
+    LseOrganizationMemberList,
     LseProjectCreate,
     LseProjectCreateSampling,
     LseProjectCreateSkipQueue,
@@ -88,6 +93,7 @@ from .types import (
     LseTaskSerializerForReviewersPredictionsItem,
     LseUser,
     LseUserApi,
+    LseUserOrganizationMemberList,
     LseapiTokenCreate,
     LseapiTokenList,
     LsejwtSettings,
@@ -110,6 +116,7 @@ from .types import (
     OrganizationMember,
     OrganizationMembership,
     PaginatedAllRolesProjectListList,
+    PaginatedLseOrganizationMemberListList,
     PaginatedRoleBasedTaskList,
     Pause,
     PauseRequest,
@@ -122,6 +129,7 @@ from .types import (
     ProjectSampling,
     ProjectSkipQueue,
     ProjectSubsetEnum,
+    PromptsStatusEnum,
     ProviderEnum,
     ReasonEnum,
     RedisExportStorage,
@@ -136,6 +144,7 @@ from .types import (
     ReviewSettingsRequeueRejectedTasksMode,
     ReviewSettingsReviewCriteria,
     ReviewedEnum,
+    Role9E7Enum,
     RoleBasedTask,
     S3ExportStorage,
     S3ImportStorage,
@@ -152,11 +161,13 @@ from .types import (
     StateEnum,
     Status7BfEnum,
     StatusC5AEnum,
+    TaskAssignment,
     ThirdPartyModelVersion,
     ThirdPartyModelVersionRequest,
     TokenRefreshResponse,
     TokenRotateResponse,
     TrialRoleEnum,
+    TypeEnum,
     UserSimple,
     UserSimpleRequest,
     VersionResponse,
@@ -178,6 +189,7 @@ from .errors import (
 from . import (
     actions,
     annotations,
+    billing,
     comments,
     export_storage,
     files,
@@ -307,6 +319,9 @@ __all__ = [
     "BadRequestError",
     "BatchFailedPredictions",
     "BatchPredictions",
+    "BillingChecks",
+    "BillingFlags",
+    "BillingInfoResponse",
     "BlankEnum",
     "BlueprintList",
     "BudgetResetPeriodEnum",
@@ -317,6 +332,7 @@ __all__ = [
     "CommentSerializerWithExpandedUser",
     "ConvertedFormat",
     "ConvertedFormatRequest",
+    "CountLimit",
     "CustomScriptsEditableByEnum",
     "DefaultRoleEnum",
     "EditionEnum",
@@ -351,6 +367,7 @@ __all__ = [
     "LseKeyIndicatorValue",
     "LseOrganization",
     "LseOrganizationCustomScriptsEditableBy",
+    "LseOrganizationMemberList",
     "LseProjectCreate",
     "LseProjectCreateRequestSampling",
     "LseProjectCreateRequestSkipQueue",
@@ -384,6 +401,7 @@ __all__ = [
     "LseTaskSerializerForReviewersPredictionsItem",
     "LseUser",
     "LseUserApi",
+    "LseUserOrganizationMemberList",
     "LseapiTokenCreate",
     "LseapiTokenList",
     "LsejwtSettings",
@@ -412,6 +430,7 @@ __all__ = [
     "OrganizationMember",
     "OrganizationMembership",
     "PaginatedAllRolesProjectListList",
+    "PaginatedLseOrganizationMemberListList",
     "PaginatedRoleBasedTaskList",
     "PatchedLseProjectUpdateRequestSampling",
     "PatchedLseProjectUpdateRequestSkipQueue",
@@ -430,6 +449,7 @@ __all__ = [
     "ProjectsImportTasksResponse",
     "ProjectsListRequestFilter",
     "PromptsCompatibleProjectsRequestProjectType",
+    "PromptsStatusEnum",
     "ProviderEnum",
     "ReasonEnum",
     "RedisExportStorage",
@@ -444,6 +464,7 @@ __all__ = [
     "ReviewSettingsRequeueRejectedTasksMode",
     "ReviewSettingsReviewCriteria",
     "ReviewedEnum",
+    "Role9E7Enum",
     "RoleBasedTask",
     "S3ExportStorage",
     "S3ImportStorage",
@@ -460,12 +481,14 @@ __all__ = [
     "StateEnum",
     "Status7BfEnum",
     "StatusC5AEnum",
+    "TaskAssignment",
     "TasksListRequestFields",
     "ThirdPartyModelVersion",
     "ThirdPartyModelVersionRequest",
     "TokenRefreshResponse",
     "TokenRotateResponse",
     "TrialRoleEnum",
+    "TypeEnum",
     "UnauthorizedError",
     "UserSimple",
     "UserSimpleRequest",
@@ -513,6 +536,7 @@ __all__ = [
     "__version__",
     "actions",
     "annotations",
+    "billing",
     "comments",
     "export_storage",
     "files",

{label_studio_sdk-2.0.0 → label_studio_sdk-2.0.2}/src/label_studio_sdk/base_client.py

@@ -7,6 +7,7 @@ import httpx
 from .core.api_error import ApiError
 from .core.client_wrapper import SyncClientWrapper
 from .annotations.client import AnnotationsClient
+from .billing.client import BillingClient
 from .comments.client import CommentsClient
 from .users.client import UsersClient
 from .actions.client import ActionsClient
@@ -28,6 +29,7 @@ from .webhooks.client import WebhooksClient
 from .workspaces.client import WorkspacesClient
 from .core.client_wrapper import AsyncClientWrapper
 from .annotations.client import AsyncAnnotationsClient
+from .billing.client import AsyncBillingClient
 from .comments.client import AsyncCommentsClient
 from .users.client import AsyncUsersClient
 from .actions.client import AsyncActionsClient
@@ -112,6 +114,7 @@ class LabelStudioBase:
             timeout=_defaulted_timeout,
         )
         self.annotations = AnnotationsClient(client_wrapper=self._client_wrapper)
+        self.billing = BillingClient(client_wrapper=self._client_wrapper)
         self.comments = CommentsClient(client_wrapper=self._client_wrapper)
         self.users = UsersClient(client_wrapper=self._client_wrapper)
         self.actions = ActionsClient(client_wrapper=self._client_wrapper)
@@ -196,6 +199,7 @@ class AsyncLabelStudioBase:
             timeout=_defaulted_timeout,
         )
         self.annotations = AsyncAnnotationsClient(client_wrapper=self._client_wrapper)
+        self.billing = AsyncBillingClient(client_wrapper=self._client_wrapper)
         self.comments = AsyncCommentsClient(client_wrapper=self._client_wrapper)
         self.users = AsyncUsersClient(client_wrapper=self._client_wrapper)
         self.actions = AsyncActionsClient(client_wrapper=self._client_wrapper)

label_studio_sdk-2.0.2/src/label_studio_sdk/billing/client.py

@@ -0,0 +1,112 @@
+# 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.billing_info_response import BillingInfoResponse
+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 BillingClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def info(self, *, request_options: typing.Optional[RequestOptions] = None) -> BillingInfoResponse:
+        """
+        Retrieve billing checks and feature flags for the active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BillingInfoResponse
+            Billing information for the active organization
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.billing.info()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/billing/info",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    BillingInfoResponse,
+                    construct_type(
+                        type_=BillingInfoResponse,  # 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 AsyncBillingClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def info(self, *, request_options: typing.Optional[RequestOptions] = None) -> BillingInfoResponse:
+        """
+        Retrieve billing checks and feature flags for the active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BillingInfoResponse
+            Billing information for the active organization
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.billing.info()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/billing/info",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    BillingInfoResponse,
+                    construct_type(
+                        type_=BillingInfoResponse,  # 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)