label-studio-sdk 2.0.8__py3-none-any.whl → 2.0.10__py3-none-any.whl

label_studio_sdk/types/review_settings_sampling.py

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

label_studio_sdk/types/review_settings_sampling_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReviewSettingsSamplingEnum = typing.Union[typing.Literal["task_id", "random"], typing.Any]

label_studio_sdk/types/{sampling_enum.py → sampling_de5enum.py}

@@ -2,6 +2,6 @@
 
 import typing
 
-SamplingEnum = typing.Union[
+SamplingDe5Enum = typing.Union[
     typing.Literal["Sequential sampling", "Uniform sampling", "Uncertainty sampling"], typing.Any
 ]

label_studio_sdk/types/who_am_i_user.py

@@ -35,6 +35,7 @@ class WhoAmIUser(UncheckedBaseModel):
     last_name: typing.Optional[str] = None
     lse_fields: WhoAmILseFields
     org_membership: typing.List[OrganizationMembership]
+    organization_membership: OrganizationMembership
     pause: str
     permissions: typing.List[str]
     phone: typing.Optional[str] = None

label_studio_sdk/workspaces/client.py

@@ -29,6 +29,12 @@ class WorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Workspace]:
         """
+        <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>
         List all workspaces for your organization. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
 
         Parameters
@@ -90,6 +96,12 @@ class WorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
+        <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 a new workspace. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
 
         Parameters
@@ -159,6 +171,12 @@ class WorkspacesClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Workspace:
         """
+        <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 details for a specific workspace by ID.
 
         Parameters
@@ -205,6 +223,12 @@ class WorkspacesClient:
 
     def delete(self, id: int, *, 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 a specific workspace by ID.
 
         Parameters
@@ -254,6 +278,12 @@ class WorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
+        <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>
         Update settings for a specific workspace by ID.
 
         Parameters
@@ -337,6 +367,12 @@ class AsyncWorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Workspace]:
         """
+        <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>
         List all workspaces for your organization. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
 
         Parameters
@@ -406,6 +442,12 @@ class AsyncWorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
+        <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 a new workspace. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
 
         Parameters
@@ -483,6 +525,12 @@ class AsyncWorkspacesClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Workspace:
         """
+        <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 details for a specific workspace by ID.
 
         Parameters
@@ -537,6 +585,12 @@ class AsyncWorkspacesClient:
 
     async def delete(self, id: int, *, 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 a specific workspace by ID.
 
         Parameters
@@ -594,6 +648,12 @@ class AsyncWorkspacesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Workspace:
         """
+        <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>
         Update settings for a specific workspace by ID.
 
         Parameters

label_studio_sdk/workspaces/members/bulk/client.py

@@ -29,6 +29,12 @@ class BulkClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BulkPostResponse:
         """
+        <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>
         Assign workspace members in bulk.
 
         Parameters
@@ -91,6 +97,12 @@ class BulkClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> BulkDeleteResponse:
         """
+        <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>
         Unassign workspace members in bulk. Allows the same request body as bulk assign.
 
         Parameters
@@ -150,6 +162,12 @@ class AsyncBulkClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BulkPostResponse:
         """
+        <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>
         Assign workspace members in bulk.
 
         Parameters
@@ -220,6 +238,12 @@ class AsyncBulkClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> BulkDeleteResponse:
         """
+        <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>
         Unassign workspace members in bulk. Allows the same request body as bulk assign.
 
         Parameters

label_studio_sdk/workspaces/members/client.py

@@ -29,6 +29,12 @@ class MembersClient:
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[WorkspaceMemberList]:
         """
+        <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 a list of all members in a specific workspace.
 
         Parameters
@@ -82,6 +88,12 @@ class MembersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WorkspaceMemberCreate:
         """
+        <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>
         Add a new workspace member by user ID.
 
         Parameters
@@ -143,6 +155,12 @@ class MembersClient:
 
     def delete(self, id: int, *, 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>
         Remove a specific member by ID from a workspace. This endpoint expects an object like `{"user_id": 123}`.
 
         Parameters
@@ -191,6 +209,12 @@ class AsyncMembersClient:
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[WorkspaceMemberList]:
         """
+        <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 a list of all members in a specific workspace.
 
         Parameters
@@ -252,6 +276,12 @@ class AsyncMembersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WorkspaceMemberCreate:
         """
+        <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>
         Add a new workspace member by user ID.
 
         Parameters
@@ -321,6 +351,12 @@ class AsyncMembersClient:
 
     async def delete(self, id: int, *, 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>
         Remove a specific member by ID from a workspace. This endpoint expects an object like `{"user_id": 123}`.
 
         Parameters

label_studio_sdk/workspaces/members/paginated/client.py

@@ -29,6 +29,12 @@ class PaginatedClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SyncPager[LseUser]:
         """
+        <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 members for a specific workspace.
 
         Parameters
@@ -124,6 +130,12 @@ class AsyncPaginatedClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncPager[LseUser]:
         """
+        <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 members for a specific workspace.
 
         Parameters

{label_studio_sdk-2.0.8.dist-info → label_studio_sdk-2.0.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 2.0.8
+Version: 2.0.10
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers
@@ -69,9 +69,9 @@ poetry add label-studio-sdk
 # Usage
 
 ```python
-from label_studio_sdk.client import LabelStudio
+from label_studio_sdk import LabelStudio
 
-ls = LabelStudio(
+client = LabelStudio(
     base_url='YOUR_LABEL_STUDIO_URL',  
     api_key="YOUR_API_KEY",
 )
@@ -148,105 +148,56 @@ from label_studio_sdk._legacy import Project
 
 </details>
 
-# Examples
-
-Check more examples [here](https://api.labelstud.io/).
-
-## Create a new project
+# Example: Create a new project with tasks
 
 ```python
-from label_studio_sdk.label_interface import LabelInterface
-from label_studio_sdk.label_interface.create import labels
-
-project = ls.projects.create(
-    title="Project name",
-    description="Project description",
-    label_config=LabelInterface.create({
-      "image": "Image",
-      "bbox": labels(["cat", "dog"], tag_type="RectangleLabels")
-    })
-)
-```
+# Import the SDK and the client module
+from label_studio_sdk import LabelStudio
 
-## Create a new task
-    
-```python
-task = ls.tasks.create(
-    project=project.id,
-    data={"image": "https://example.com/image.jpg"}
+client = LabelStudio(
+    base_url="http://localhost:8080",   # <-- put your LS URL here
+    api_key="YOUR_API_KEY",             # <-- put your API key here
 )
-```
-Now you can open the project `PROJECT_ID` in the Label Studio UI and create annotations for the task.
 
-## Export annotations
-
-```python
-annotations = [
-    task.annotations
-    for task in ls.tasks.list(project=project.id, fields='all')
-    if task.annotations
-]
-```
-
-
-## Async client
-
-```python
-from label_studio_sdk.client import AsyncLabelStudio
-
-client = AsyncLabelStudio(
-    api_key="YOUR_API_KEY",
+label_config = """
+<View>
+  <Header value="Choose text sentiment:"/>
+  <Text name="text" value="$text"/>
+  <Choices name="sentiment" toName="text" choice="single">
+    <Choice value="Positive"/>
+    <Choice value="Negative"/>
+    <Choice value="Neutral"/>
+  </Choices>
+</View>
+"""
+
+# Create project
+project = client.projects.create(
+    title="Sentiment Classification",
+    label_config=label_config
 )
-```
 
-## Advanced
+# (Optional) validate the config to catch mistakes early
+client.projects.validate_label_config(id=project.id, label_config=label_config)
 
-### Timeouts
-By default, requests time out after 60 seconds. You can configure this with a 
-timeout option at the client or request level.
-
-```python
-from label_studio_sdk.client import LabelStudio
-
-ls = LabelStudio(
-    # All timeouts set to 20 seconds
-    timeout=20.0
+# Create a single task
+task = client.tasks.create(
+    project=project.id,
+    data={"text": "Label Studio is the best!"}  # 'text' matches value="$text"
 )
-
-ls.projects.create(..., {
-    # Override timeout for a specific method
-    timeout=20.0
-})
-```
-
-### Custom HTTP client
-You can override the httpx client to customize it for your use-case. Some common use-cases 
-include support for proxies and transports.
-
-```python
-import httpx
-
-from label_studio_sdk.client import LabelStudio
-
-ls = LabelStudio(
-    http_client=httpx.Client(
-        proxies="http://my.test.proxy.example.com",
-        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
-    ),
+print(f"Created task id: {task.id}")
+
+# Or create multiple tasks at once
+client.projects.import_tasks(
+    id=project.id,
+    request=[
+        {"text": "I love Label Studio"},
+        {"text": "Label Studio helps me ship faster"},
+    ]
 )
 ```
 
-## Enterprise features
-
-### Create comments
-    
-```python
-comment = ls.comments.create(
-    project=project.id,
-    annotation=annotation.id,
-    text="Comment text"
-)
-```
+For additional examples, see [our API reference](https://api.labelstud.io/). 
 
 <!-- Begin Contributing, generated by Fern  -->
 # Contributing