label-studio-sdk 2.0.0__py3-none-any.whl → 2.0.2__py3-none-any.whl

label_studio_sdk/webhooks/types/webhooks_info_response_label_link_deleted.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseLabelLinkDeleted(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_label_link_updated.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseLabelLinkUpdated(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_project_created.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseProjectCreated(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_project_deleted.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseProjectDeleted(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_project_updated.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseProjectUpdated(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_review_created.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseReviewCreated(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_review_updated.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseReviewUpdated(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_reviews_deleted.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseReviewsDeleted(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_tasks_created.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseTasksCreated(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/webhooks/types/webhooks_info_response_tasks_deleted.py

@@ -9,9 +9,9 @@ import pydantic
 
 
 class WebhooksInfoResponseTasksDeleted(UncheckedBaseModel):
-    name: str
     description: str
     key: str
+    name: str
     organization_only: typing_extensions.Annotated[bool, FieldMetadata(alias="organization-only")]
 
     if IS_PYDANTIC_V2:

label_studio_sdk/workspaces/client.py

@@ -83,10 +83,10 @@ class WorkspacesClient:
         self,
         *,
         title: str,
-        description: typing.Optional[str] = OMIT,
         color: typing.Optional[str] = OMIT,
-        is_personal: typing.Optional[bool] = OMIT,
+        description: typing.Optional[str] = OMIT,
         is_archived: typing.Optional[bool] = OMIT,
+        is_personal: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
@@ -97,17 +97,17 @@ class WorkspacesClient:
         title : str
             Workspace name
 
+        color : typing.Optional[str]
+
         description : typing.Optional[str]
             Workspace description
 
-        color : typing.Optional[str]
+        is_archived : typing.Optional[bool]
+            Workspace is archived
 
         is_personal : typing.Optional[bool]
             Workspace is a personal user workspace
 
-        is_archived : typing.Optional[bool]
-            Workspace is archived
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -131,11 +131,11 @@ class WorkspacesClient:
             "api/workspaces/",
             method="POST",
             json={
-                "title": title,
-                "description": description,
                 "color": color,
-                "is_personal": is_personal,
+                "description": description,
                 "is_archived": is_archived,
+                "is_personal": is_personal,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -246,11 +246,11 @@ class WorkspacesClient:
         self,
         id: int,
         *,
-        title: typing.Optional[str] = OMIT,
-        description: typing.Optional[str] = OMIT,
         color: typing.Optional[str] = OMIT,
-        is_personal: typing.Optional[bool] = OMIT,
+        description: typing.Optional[str] = OMIT,
         is_archived: typing.Optional[bool] = OMIT,
+        is_personal: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
@@ -260,19 +260,19 @@ class WorkspacesClient:
         ----------
         id : int
 
-        title : typing.Optional[str]
-            Workspace name
+        color : typing.Optional[str]
 
         description : typing.Optional[str]
             Workspace description
 
-        color : typing.Optional[str]
+        is_archived : typing.Optional[bool]
+            Workspace is archived
 
         is_personal : typing.Optional[bool]
             Workspace is a personal user workspace
 
-        is_archived : typing.Optional[bool]
-            Workspace is archived
+        title : typing.Optional[str]
+            Workspace name
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -297,11 +297,11 @@ class WorkspacesClient:
             f"api/workspaces/{jsonable_encoder(id)}/",
             method="PATCH",
             json={
-                "title": title,
-                "description": description,
                 "color": color,
-                "is_personal": is_personal,
+                "description": description,
                 "is_archived": is_archived,
+                "is_personal": is_personal,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -399,10 +399,10 @@ class AsyncWorkspacesClient:
         self,
         *,
         title: str,
-        description: typing.Optional[str] = OMIT,
         color: typing.Optional[str] = OMIT,
-        is_personal: typing.Optional[bool] = OMIT,
+        description: typing.Optional[str] = OMIT,
         is_archived: typing.Optional[bool] = OMIT,
+        is_personal: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
@@ -413,17 +413,17 @@ class AsyncWorkspacesClient:
         title : str
             Workspace name
 
+        color : typing.Optional[str]
+
         description : typing.Optional[str]
             Workspace description
 
-        color : typing.Optional[str]
+        is_archived : typing.Optional[bool]
+            Workspace is archived
 
         is_personal : typing.Optional[bool]
             Workspace is a personal user workspace
 
-        is_archived : typing.Optional[bool]
-            Workspace is archived
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -455,11 +455,11 @@ class AsyncWorkspacesClient:
             "api/workspaces/",
             method="POST",
             json={
-                "title": title,
-                "description": description,
                 "color": color,
-                "is_personal": is_personal,
+                "description": description,
                 "is_archived": is_archived,
+                "is_personal": is_personal,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -586,11 +586,11 @@ class AsyncWorkspacesClient:
         self,
         id: int,
         *,
-        title: typing.Optional[str] = OMIT,
-        description: typing.Optional[str] = OMIT,
         color: typing.Optional[str] = OMIT,
-        is_personal: typing.Optional[bool] = OMIT,
+        description: typing.Optional[str] = OMIT,
         is_archived: typing.Optional[bool] = OMIT,
+        is_personal: typing.Optional[bool] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
@@ -600,19 +600,19 @@ class AsyncWorkspacesClient:
         ----------
         id : int
 
-        title : typing.Optional[str]
-            Workspace name
+        color : typing.Optional[str]
 
         description : typing.Optional[str]
             Workspace description
 
-        color : typing.Optional[str]
+        is_archived : typing.Optional[bool]
+            Workspace is archived
 
         is_personal : typing.Optional[bool]
             Workspace is a personal user workspace
 
-        is_archived : typing.Optional[bool]
-            Workspace is archived
+        title : typing.Optional[str]
+            Workspace name
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -645,11 +645,11 @@ class AsyncWorkspacesClient:
             f"api/workspaces/{jsonable_encoder(id)}/",
             method="PATCH",
             json={
-                "title": title,
-                "description": description,
                 "color": color,
-                "is_personal": is_personal,
+                "description": description,
                 "is_archived": is_archived,
+                "is_personal": is_personal,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",

{label_studio_sdk-2.0.0.dist-info → label_studio_sdk-2.0.2.dist-info}/METADATA

@@ -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",