label-studio-sdk 2.0.6__py3-none-any.whl → 2.0.7__py3-none-any.whl

label_studio_sdk/__init__.py

@@ -46,6 +46,8 @@ from .types import (
     ConvertedFormatRequest,
     CountLimit,
     CustomScriptsEditableByEnum,
+    DefaultRole,
+    DefaultRoleCustomScriptsEditableBy,
     DefaultRoleEnum,
     EditionEnum,
     Export,
@@ -78,9 +80,12 @@ from .types import (
     LseOrganization,
     LseOrganizationCustomScriptsEditableBy,
     LseOrganizationMemberList,
+    LseProject,
     LseProjectCreate,
     LseProjectCreateSampling,
     LseProjectCreateSkipQueue,
+    LseProjectSampling,
+    LseProjectSkipQueue,
     LseProjectUpdate,
     LseProjectUpdateSampling,
     LseProjectUpdateSkipQueue,
@@ -154,6 +159,8 @@ from .types import (
     ProjectSampling,
     ProjectSkipQueue,
     ProjectSubsetEnum,
+    ProjectTemplate,
+    ProjectTemplateRequest,
     PromptsStatusEnum,
     ProviderEnum,
     ReasonEnum,
@@ -238,6 +245,7 @@ from . import (
     model_providers,
     organizations,
     predictions,
+    project_templates,
     projects,
     prompts,
     session_policy,
@@ -275,6 +283,7 @@ from .export_storage import ExportStorageListTypesResponseItem
 from .import_storage import ImportStorageListTypesResponseItem
 from .ml import MlCreateRequestAuthMethod, MlListModelVersionsResponse, MlUpdateRequestAuthMethod
 from .model_providers import ModelProvidersListModelProviderChoicesResponse
+from .organizations import PatchedDefaultRoleRequestCustomScriptsEditableBy
 from .projects import (
     LseProjectCreateRequestSampling,
     LseProjectCreateRequestSkipQueue,
@@ -391,6 +400,8 @@ __all__ = [
     "ConvertedFormatRequest",
     "CountLimit",
     "CustomScriptsEditableByEnum",
+    "DefaultRole",
+    "DefaultRoleCustomScriptsEditableBy",
     "DefaultRoleEnum",
     "EditionEnum",
     "Export",
@@ -429,11 +440,14 @@ __all__ = [
     "LseOrganization",
     "LseOrganizationCustomScriptsEditableBy",
     "LseOrganizationMemberList",
+    "LseProject",
     "LseProjectCreate",
     "LseProjectCreateRequestSampling",
     "LseProjectCreateRequestSkipQueue",
     "LseProjectCreateSampling",
     "LseProjectCreateSkipQueue",
+    "LseProjectSampling",
+    "LseProjectSkipQueue",
     "LseProjectUpdate",
     "LseProjectUpdateSampling",
     "LseProjectUpdateSkipQueue",
@@ -498,6 +512,7 @@ __all__ = [
     "PaginatedPaginatedProjectMemberList",
     "PaginatedProjectMember",
     "PaginatedRoleBasedTaskList",
+    "PatchedDefaultRoleRequestCustomScriptsEditableBy",
     "PatchedLseProjectUpdateRequestSampling",
     "PatchedLseProjectUpdateRequestSkipQueue",
     "Pause",
@@ -515,6 +530,8 @@ __all__ = [
     "ProjectSampling",
     "ProjectSkipQueue",
     "ProjectSubsetEnum",
+    "ProjectTemplate",
+    "ProjectTemplateRequest",
     "ProjectsDuplicateResponse",
     "ProjectsImportTasksResponse",
     "ProjectsListRequestFilter",
@@ -630,6 +647,7 @@ __all__ = [
     "model_providers",
     "organizations",
     "predictions",
+    "project_templates",
     "projects",
     "prompts",
     "session_policy",

label_studio_sdk/base_client.py

@@ -23,6 +23,7 @@ from .ml.client import MlClient
 from .model_providers.client import ModelProvidersClient
 from .prompts.client import PromptsClient
 from .predictions.client import PredictionsClient
+from .project_templates.client import ProjectTemplatesClient
 from .projects.client import ProjectsClient
 from .tasks.client import TasksClient
 from .session_policy.client import SessionPolicyClient
@@ -51,6 +52,7 @@ from .ml.client import AsyncMlClient
 from .model_providers.client import AsyncModelProvidersClient
 from .prompts.client import AsyncPromptsClient
 from .predictions.client import AsyncPredictionsClient
+from .project_templates.client import AsyncProjectTemplatesClient
 from .projects.client import AsyncProjectsClient
 from .tasks.client import AsyncTasksClient
 from .session_policy.client import AsyncSessionPolicyClient
@@ -142,6 +144,7 @@ class LabelStudioBase:
         self.model_providers = ModelProvidersClient(client_wrapper=self._client_wrapper)
         self.prompts = PromptsClient(client_wrapper=self._client_wrapper)
         self.predictions = PredictionsClient(client_wrapper=self._client_wrapper)
+        self.project_templates = ProjectTemplatesClient(client_wrapper=self._client_wrapper)
         self.projects = ProjectsClient(client_wrapper=self._client_wrapper)
         self.tasks = TasksClient(client_wrapper=self._client_wrapper)
         self.session_policy = SessionPolicyClient(client_wrapper=self._client_wrapper)
@@ -233,6 +236,7 @@ class AsyncLabelStudioBase:
         self.model_providers = AsyncModelProvidersClient(client_wrapper=self._client_wrapper)
         self.prompts = AsyncPromptsClient(client_wrapper=self._client_wrapper)
         self.predictions = AsyncPredictionsClient(client_wrapper=self._client_wrapper)
+        self.project_templates = AsyncProjectTemplatesClient(client_wrapper=self._client_wrapper)
         self.projects = AsyncProjectsClient(client_wrapper=self._client_wrapper)
         self.tasks = AsyncTasksClient(client_wrapper=self._client_wrapper)
         self.session_policy = AsyncSessionPolicyClient(client_wrapper=self._client_wrapper)

label_studio_sdk/core/client_wrapper.py

@@ -4,7 +4,7 @@ import httpx
 
 from .http_client import AsyncHttpClient, HttpClient
 
-VERSION = "2.0.6"
+VERSION = "2.0.7"
 
 class BaseClientWrapper:
     def __init__(

label_studio_sdk/label_interface/control_tags.py

@@ -39,6 +39,7 @@ _TAG_TO_CLASS = {
     "taxonomy": "TaxonomyTag",
     "textarea": "TextAreaTag",
     "timeserieslabels": "TimeSeriesLabelsTag",
+    "chatmessage": "ChatMessageTag",
 }
 
 
@@ -950,6 +951,43 @@ class RatingTag(ControlTag):
         }
 
 
+class ChatMessageContent(BaseModel):
+    role: str
+    content: str
+    createdAt: Optional[int] = None
+
+
+class ChatMessageValue(BaseModel):
+    chatmessage: ChatMessageContent
+
+
+class ChatMessageTag(ControlTag):
+    """Control tag for chat messages targeting a `<Chat>` object.
+
+    This tag is a hybrid where `from_name == to_name` and `type == 'chatmessage'`.
+    """
+    tag: str = "ChatMessage"
+    _value_class: Type[ChatMessageValue] = ChatMessageValue
+
+    def to_json_schema(self):
+        return {
+            "type": "object",
+            "required": ["chatmessage"],
+            "properties": {
+                "chatmessage": {
+                    "type": "object",
+                    "required": ["role", "content"],
+                    "properties": {
+                        "role": {"type": "string"},
+                        "content": {"type": "string"},
+                        "createdAt": {"type": "number"}
+                    }
+                }
+            },
+            "description": f"Chat message for {self.to_name[0]}"
+        }
+
+
 class RelationsTag(ControlTag):
     """ """
     tag: str = "Relations"

label_studio_sdk/label_interface/data_examples.json

@@ -10,6 +10,12 @@
     "Header": "Task header",
     "Paragraphs":  [{"author": "Alice", "text": "Hi, Bob."}, {"author": "Bob", "text": "Hello, Alice!"}, {"author": "Alice", "text": "What's up?"}, {"author": "Bob", "text": "Good. Ciao!"}, {"author": "Alice", "text": "Bye, Bob."}],
     "ParagraphsUrl": "<HOSTNAME>/samples/paragraphs.json?",
+    "Chat": [
+      {"role": "user", "content": "Hi there!", "createdAt": 1710000000000},
+      {"role": "assistant", "content": "Hello! How can I help you today?", "createdAt": 1710000005000},
+      {"role": "user", "content": "Can you summarize our onboarding checklist?", "createdAt": 1710000010000},
+      {"role": "assistant", "content": "Sure. It includes account setup, roles, labeling instructions, GT tasks, overlap and review.", "createdAt": 1710000015000}
+    ],
     "Table": {"Card number": 18799210, "First name": "Max", "Last name":  "Nobel"},
     "$videoHack": "<video src='<HOSTNAME>/static/samples/opossum_snow.mp4' width=100% controls>",
     "Video": "<HOSTNAME>/static/samples/opossum_snow.mp4",
@@ -85,6 +91,10 @@
     "AudioPlus": "<HOSTNAME>/static/samples/game.wav",
     "Header": "Task header",
     "Paragraphs":  [{"author": "Alice", "text": "Hi, Bob."}, {"author": "Bob", "text": "Hello, Alice!"}, {"author": "Alice", "text": "What's up?"}, {"author": "Bob", "text": "Good. Ciao!"}, {"author": "Alice", "text": "Bye, Bob."}],
+    "Chat": [
+      {"role": "user", "content": "Hello!", "createdAt": 1710000000000},
+      {"role": "assistant", "content": "Hi! What can I do for you?", "createdAt": 1710000004000}
+    ],
     "Table": {"Card number": 18799210, "First name": "Max", "Last name":  "Nobel"},
     "$videoHack": "<video src='static/samples/opossum_snow.mp4' width=100% controls>",
     "Video": "<HOSTNAME>/static/samples/opossum_snow.mp4",

label_studio_sdk/label_interface/interface.py

@@ -27,6 +27,7 @@ from label_studio_sdk._legacy.exceptions import (
 
 from .base import LabelStudioTag
 from .control_tags import (
+    ChatMessageTag,
     ControlTag,
     ChoicesTag,
     LabelsTag,
@@ -623,6 +624,18 @@ class LabelInterface:
                 if lb:
                     labels[lb.parent_name][lb.value] = lb
 
+        # Special handling: auto-create ChatMessage control for each Chat object
+        chat_object_names = [name for name, obj in objects.items() if getattr(obj, 'tag', '').lower() == 'chat']
+        for name in chat_object_names:
+            if name not in controls:
+                controls[name] = ChatMessageTag(
+                    tag='ChatMessage',
+                    name=name,
+                    to_name=[name],
+                    attr={"name": name, "toName": name}
+                )
+
+
         return controls, objects, labels, xml_tree
 
     @classmethod

label_studio_sdk/label_interface/object_tags.py

@@ -20,6 +20,7 @@ _TAG_TO_CLASS = {
     "list": "ListTag",
     "paragraphs": "ParagraphsTag",
     "timeseries": "TimeSeriesTag",
+    "chat": "ChatTag",
 }
 
 _DATA_EXAMPLES = None
@@ -306,3 +307,11 @@ class TimeSeriesTag(ObjectTag):
         else:
             # data is JSON
             return generate_time_series_json(time_column, value_columns, time_format)
+
+class ChatTag(ObjectTag):
+    """ """
+    tag: str = "Chat"
+
+    def _generate_example(self, examples, only_urls=False):
+        """ """
+        return examples.get("Chat")

label_studio_sdk/ml/client.py

@@ -457,6 +457,64 @@ class MlClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def predict_all_tasks(
+        self,
+        id: int,
+        *,
+        batch_size: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Note: not available in the community edition of Label Studio.
+
+        Create predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project.
+
+        See [Set up machine learning](https://labelstud.io/guide/ml.html) for more details about a Label Studio ML backend.
+
+        Reference the ML backend ID in the path of this API call. Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).
+
+        Parameters
+        ----------
+        id : int
+            A unique integer value identifying this ML backend.
+
+        batch_size : typing.Optional[int]
+            Computed number of tasks without predictions that the ML backend needs to predict.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.ml.predict_all_tasks(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/ml/{jsonable_encoder(id)}/predict",
+            method="POST",
+            params={
+                "batch_size": batch_size,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _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)
+
     def train(
         self,
         id: int,
@@ -1064,6 +1122,72 @@ class AsyncMlClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    async def predict_all_tasks(
+        self,
+        id: int,
+        *,
+        batch_size: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Note: not available in the community edition of Label Studio.
+
+        Create predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project.
+
+        See [Set up machine learning](https://labelstud.io/guide/ml.html) for more details about a Label Studio ML backend.
+
+        Reference the ML backend ID in the path of this API call. Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).
+
+        Parameters
+        ----------
+        id : int
+            A unique integer value identifying this ML backend.
+
+        batch_size : typing.Optional[int]
+            Computed number of tasks without predictions that the ML backend needs to predict.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ml.predict_all_tasks(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/ml/{jsonable_encoder(id)}/predict",
+            method="POST",
+            params={
+                "batch_size": batch_size,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _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)
+
     async def train(
         self,
         id: int,

label_studio_sdk/organizations/__init__.py

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