label-studio-sdk 1.0.10__py3-none-any.whl → 1.0.11__py3-none-any.whl

label_studio_sdk/__init__.py

@@ -1,11 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .types import (
+    AccessTokenResponse,
     Annotation,
     AnnotationFilterOptions,
     AnnotationLastAction,
     AnnotationsDmField,
     AnnotationsDmFieldLastAction,
+    ApiTokenResponse,
     AzureBlobExportStorage,
     AzureBlobExportStorageStatus,
     AzureBlobImportStorage,
@@ -40,6 +42,7 @@ from .types import (
     InferenceRunOrganization,
     InferenceRunProjectSubset,
     InferenceRunStatus,
+    JwtSettingsResponse,
     KeyIndicatorValue,
     KeyIndicators,
     KeyIndicatorsItem,
@@ -58,6 +61,8 @@ from .types import (
     ModelProviderConnectionOrganization,
     ModelProviderConnectionProvider,
     ModelProviderConnectionScope,
+    Pause,
+    PausePausedBy,
     Prediction,
     Project,
     ProjectImport,
@@ -101,7 +106,7 @@ from .types import (
     WebhookSerializerForUpdateActionsItem,
     Workspace,
 )
-from .errors import BadRequestError, InternalServerError
+from .errors import BadRequestError, InternalServerError, NotFoundError, UnauthorizedError
 from . import (
     actions,
     annotations,
@@ -109,12 +114,14 @@ from . import (
     export_storage,
     files,
     import_storage,
+    jwt_settings,
     ml,
     model_providers,
     predictions,
     projects,
     prompts,
     tasks,
+    tokens,
     users,
     versions,
     views,
@@ -180,6 +187,7 @@ from .views import (
 from .webhooks import WebhooksUpdateRequestActionsItem
 
 __all__ = [
+    "AccessTokenResponse",
     "ActionsCreateRequestFilters",
     "ActionsCreateRequestFiltersConjunction",
     "ActionsCreateRequestFiltersItemsItem",
@@ -198,6 +206,7 @@ __all__ = [
     "AnnotationsCreateBulkResponseItem",
     "AnnotationsDmField",
     "AnnotationsDmFieldLastAction",
+    "ApiTokenResponse",
     "AsyncLabelStudio",
     "AzureBlobExportStorage",
     "AzureBlobExportStorageStatus",
@@ -238,6 +247,7 @@ __all__ = [
     "InferenceRunProjectSubset",
     "InferenceRunStatus",
     "InternalServerError",
+    "JwtSettingsResponse",
     "KeyIndicatorValue",
     "KeyIndicators",
     "KeyIndicatorsItem",
@@ -264,6 +274,9 @@ __all__ = [
     "ModelProviderConnectionOrganization",
     "ModelProviderConnectionProvider",
     "ModelProviderConnectionScope",
+    "NotFoundError",
+    "Pause",
+    "PausePausedBy",
     "Prediction",
     "Project",
     "ProjectImport",
@@ -309,6 +322,7 @@ __all__ = [
     "TaskFilterOptions",
     "TasksListRequestFields",
     "TasksListResponse",
+    "UnauthorizedError",
     "UserSimple",
     "UsersGetTokenResponse",
     "UsersResetTokenResponse",
@@ -344,12 +358,14 @@ __all__ = [
     "export_storage",
     "files",
     "import_storage",
+    "jwt_settings",
     "ml",
     "model_providers",
     "predictions",
     "projects",
     "prompts",
     "tasks",
+    "tokens",
     "users",
     "versions",
     "views",

label_studio_sdk/_extensions/label_studio_tools/core/utils/json_schema.py

@@ -2,6 +2,7 @@ import json
 import types
 import sys
 import functools
+import logging
 from typing import Type, Dict, Any, Tuple, Generator
 from pathlib import Path
 from tempfile import TemporaryDirectory
@@ -11,6 +12,8 @@ from datamodel_code_generator.parser.jsonschema import JsonSchemaParser
 from pydantic import BaseModel
 from contextlib import contextmanager
 
+logger = logging.getLogger(__name__)
+
 
 @functools.lru_cache(maxsize=128)
 def _generate_model_code(json_schema_str: str, class_name: str = 'MyModel') -> str:
@@ -65,6 +68,7 @@ def json_schema_to_pydantic(json_schema: dict, class_name: str = 'MyModel') -> G
     json_schema_str = json.dumps(json_schema)
     
     # Generate Pydantic model code from the JSON schema string
+    logger.debug(f"Generating Pydantic model code from json schema: {json_schema_str}")
     model_code: str = _generate_model_code(json_schema_str, class_name)
     
     # Create a unique module name using the id of the JSON schema string
@@ -79,6 +83,7 @@ def json_schema_to_pydantic(json_schema: dict, class_name: str = 'MyModel') -> G
         # Add the new module to sys.modules to make it importable
         # This is necessary to avoid Pydantic errors related to undefined models
         sys.modules[module_name] = mod
+        logger.debug(f"Generated Pydantic model: {model_class}")
         yield model_class
     finally:
         if module_name in sys.modules:

label_studio_sdk/base_client.py

@@ -23,6 +23,8 @@ from .prompts.client import PromptsClient
 from .model_providers.client import ModelProvidersClient
 from .comments.client import CommentsClient
 from .workspaces.client import WorkspacesClient
+from .tokens.client import TokensClient
+from .jwt_settings.client import JwtSettingsClient
 from .core.client_wrapper import AsyncClientWrapper
 from .annotations.client import AsyncAnnotationsClient
 from .users.client import AsyncUsersClient
@@ -41,6 +43,8 @@ from .prompts.client import AsyncPromptsClient
 from .model_providers.client import AsyncModelProvidersClient
 from .comments.client import AsyncCommentsClient
 from .workspaces.client import AsyncWorkspacesClient
+from .tokens.client import AsyncTokensClient
+from .jwt_settings.client import AsyncJwtSettingsClient
 
 
 class LabelStudioBase:
@@ -122,6 +126,8 @@ class LabelStudioBase:
         self.model_providers = ModelProvidersClient(client_wrapper=self._client_wrapper)
         self.comments = CommentsClient(client_wrapper=self._client_wrapper)
         self.workspaces = WorkspacesClient(client_wrapper=self._client_wrapper)
+        self.tokens = TokensClient(client_wrapper=self._client_wrapper)
+        self.jwt_settings = JwtSettingsClient(client_wrapper=self._client_wrapper)
 
 
 class AsyncLabelStudioBase:
@@ -203,6 +209,8 @@ class AsyncLabelStudioBase:
         self.model_providers = AsyncModelProvidersClient(client_wrapper=self._client_wrapper)
         self.comments = AsyncCommentsClient(client_wrapper=self._client_wrapper)
         self.workspaces = AsyncWorkspacesClient(client_wrapper=self._client_wrapper)
+        self.tokens = AsyncTokensClient(client_wrapper=self._client_wrapper)
+        self.jwt_settings = AsyncJwtSettingsClient(client_wrapper=self._client_wrapper)
 
 
 def _get_base_url(*, base_url: typing.Optional[str] = None, environment: LabelStudioEnvironment) -> str:

label_studio_sdk/core/client_wrapper.py

@@ -1,36 +1,55 @@
-# This file was auto-generated by Fern from our API Definition.
-
 import typing
+
 import httpx
-from .http_client import HttpClient
-from .http_client import AsyncHttpClient
+
+from .http_client import AsyncHttpClient, HttpClient
 
 
 class BaseClientWrapper:
-    def __init__(self, *, api_key: str, base_url: str, timeout: typing.Optional[float] = None):
-        self.api_key = api_key
+    def __init__(
+        self,
+        *,
+        api_key: str,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+    ):
         self._base_url = base_url
         self._timeout = timeout
 
+        # even in the async case, refreshing access token (when the existing one is expired) should be sync
+        from ..tokens.client_ext import TokensClientExt
+        self._tokens_client = TokensClientExt(base_url=base_url, api_key=api_key)
+
+
+    def get_timeout(self) -> typing.Optional[float]:
+        return self._timeout
+
+
+    def get_base_url(self) -> str:
+        return self._base_url
+
+
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "label-studio-sdk",
-            "X-Fern-SDK-Version": "1.0.9",
+            "X-Fern-SDK-Version": "1.0.11",
         }
-        headers["Authorization"] = f"Token  {self.api_key}"
+        if self._tokens_client._use_legacy_token:
+            headers["Authorization"] = f"Token {self._tokens_client.api_key}"
+        else:
+            headers["Authorization"] = f"Bearer {self._tokens_client.api_key}"
         return headers
 
-    def get_base_url(self) -> str:
-        return self._base_url
-
-    def get_timeout(self) -> typing.Optional[float]:
-        return self._timeout
-
 
 class SyncClientWrapper(BaseClientWrapper):
     def __init__(
-        self, *, api_key: str, base_url: str, timeout: typing.Optional[float] = None, httpx_client: httpx.Client
+        self,
+        *,
+        api_key: str,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.Client,
     ):
         super().__init__(api_key=api_key, base_url=base_url, timeout=timeout)
         self.httpx_client = HttpClient(

label_studio_sdk/errors/__init__.py

@@ -2,5 +2,7 @@
 
 from .bad_request_error import BadRequestError
 from .internal_server_error import InternalServerError
+from .not_found_error import NotFoundError
+from .unauthorized_error import UnauthorizedError
 
-__all__ = ["BadRequestError", "InternalServerError"]
+__all__ = ["BadRequestError", "InternalServerError", "NotFoundError", "UnauthorizedError"]

label_studio_sdk/errors/not_found_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.api_error import ApiError
+import typing
+
+
+class NotFoundError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=404, body=body)

label_studio_sdk/errors/unauthorized_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.api_error import ApiError
+import typing
+
+
+class UnauthorizedError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=401, body=body)

label_studio_sdk/jwt_settings/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+

label_studio_sdk/jwt_settings/client.py

@@ -0,0 +1,259 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ..core.client_wrapper import SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.jwt_settings_response import JwtSettingsResponse
+from ..core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class JwtSettingsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> JwtSettingsResponse:
+        """
+        Retrieve JWT settings for the currently active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        JwtSettingsResponse
+            JWT settings retrieved successfully
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.jwt_settings.get()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/jwt/settings",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    JwtSettingsResponse,
+                    parse_obj_as(
+                        type_=JwtSettingsResponse,  # 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)
+
+    def create(
+        self,
+        *,
+        api_tokens_enabled: bool,
+        legacy_api_tokens_enabled: bool,
+        api_token_ttl_days: int,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> JwtSettingsResponse:
+        """
+        Update JWT settings for the currently active organization.
+
+        Parameters
+        ----------
+        api_tokens_enabled : bool
+            Whether JWT API tokens are enabled
+
+        legacy_api_tokens_enabled : bool
+            Whether legacy API tokens are enabled
+
+        api_token_ttl_days : int
+            Number of days before API tokens expire
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        JwtSettingsResponse
+            JWT settings updated successfully
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.jwt_settings.create(
+            api_tokens_enabled=True,
+            legacy_api_tokens_enabled=True,
+            api_token_ttl_days=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/jwt/settings",
+            method="POST",
+            json={
+                "api_tokens_enabled": api_tokens_enabled,
+                "legacy_api_tokens_enabled": legacy_api_tokens_enabled,
+                "api_token_ttl_days": api_token_ttl_days,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    JwtSettingsResponse,
+                    parse_obj_as(
+                        type_=JwtSettingsResponse,  # 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 AsyncJwtSettingsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> JwtSettingsResponse:
+        """
+        Retrieve JWT settings for the currently active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        JwtSettingsResponse
+            JWT settings retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.jwt_settings.get()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/jwt/settings",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    JwtSettingsResponse,
+                    parse_obj_as(
+                        type_=JwtSettingsResponse,  # 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)
+
+    async def create(
+        self,
+        *,
+        api_tokens_enabled: bool,
+        legacy_api_tokens_enabled: bool,
+        api_token_ttl_days: int,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> JwtSettingsResponse:
+        """
+        Update JWT settings for the currently active organization.
+
+        Parameters
+        ----------
+        api_tokens_enabled : bool
+            Whether JWT API tokens are enabled
+
+        legacy_api_tokens_enabled : bool
+            Whether legacy API tokens are enabled
+
+        api_token_ttl_days : int
+            Number of days before API tokens expire
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        JwtSettingsResponse
+            JWT settings updated successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.jwt_settings.create(
+                api_tokens_enabled=True,
+                legacy_api_tokens_enabled=True,
+                api_token_ttl_days=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/jwt/settings",
+            method="POST",
+            json={
+                "api_tokens_enabled": api_tokens_enabled,
+                "legacy_api_tokens_enabled": legacy_api_tokens_enabled,
+                "api_token_ttl_days": api_token_ttl_days,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    JwtSettingsResponse,
+                    parse_obj_as(
+                        type_=JwtSettingsResponse,  # 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)

label_studio_sdk/label_interface/control_tags.py

@@ -92,6 +92,12 @@ class ControlTag(LabelStudioTag):
             and tag.attrib.get("toName")
             and tag.tag not in _NOT_CONTROL_TAGS
         )
+        
+    @property
+    def is_output_required(self):
+        # TextArea can be blank unless user specifies "required"="true" in the attribute
+        required_in_attr = str(self.attr.get("required", "false")).lower() == "true"
+        return required_in_attr or False
 
     def to_json_schema(self):
         """
@@ -566,6 +572,7 @@ class LabelsTag(ControlTag):
                 "properties": {
                     "start": {
                         "type": "integer",
+                        # TODO: this is incompatible with the OpenAI API using PredictedOutputs
                         "minimum": 0
                     },
                     "end": {
@@ -985,8 +992,14 @@ class TextAreaTag(ControlTag):
             dict: A dictionary representing the JSON Schema compatible with OpenAPI 3.
         """
         return {
-            "type": "string",
-            "description": f"Text for {self.to_name[0]}"
+            "oneOf": [
+                {"type": "string"},
+                {
+                    "type": "array",
+                    "items": {"type": "string"}
+                }
+            ],
+            "description": f"Text or list of texts for {self.to_name[0]}"
         }
 
 

label_studio_sdk/label_interface/interface.py

@@ -312,6 +312,15 @@ class LabelInterface:
         """
         regions = []
         for control_tag_name, payload in data.items():
+            
+            if payload is None:
+                logger.warning(
+                    f"Payload for control tag '{control_tag_name}' is None: "
+                    "it can be ok if this payload is autogenerated by LLMs - "
+                    "try to adjust the prompt to generate valid payloads. "
+                    "Otherwise, it can signify an error")
+                continue
+            
             if control_tag_name not in self._controls:
                 logger.info(f"Control tag '{control_tag_name}' not found in the config")
                 continue
@@ -545,12 +554,16 @@ class LabelInterface:
         Returns:
             dict: A dictionary representing the JSON Schema.
         """
+        required_outputs = [
+            name for name, control in self._controls.items()
+            if control.is_output_required
+        ]
         return {
             "type": "object",
             "properties": {
                 name: control.to_json_schema() for name, control in self._controls.items()
             },
-            "required": list(self._controls.keys())
+            "required": required_outputs
         }
     
     def parse(self, config_string: str) -> Tuple[Dict, Dict, Dict, etree._Element]:
@@ -902,6 +915,72 @@ class LabelInterface:
             logger.debug(f'Sample annotation {annotation_dct} failed validation for label config {self.config}')
             return None
 
+    def generate_complete_sample_task(self, raise_on_failure: bool = False) -> Optional[dict]:
+        """Generate a complete sample task with annotations and predictions.
+
+        This method combines the generation of a sample task, sample prediction, and sample annotation
+        into a single method call, returning a complete task structure.
+
+        Args:
+            raise_on_failure: If True, will raise ValueError when any step
+                              (including annotation/prediction generation) fails
+
+        Raises:
+            ValueError: If raise_on_failure is True and any generation step fails.
+
+        Example:
+            {
+              'data': {'text': 'Sample text for labeling'},
+              'annotations': [
+                {'was_cancelled': False,
+                 'ground_truth': False,
+                 'completed_by': -1,
+                 'result': [
+                   {'id': 'b05da11d-3ffc-4657-8b8d-f5bc37cd59ac',
+                    'from_name': 'sentiment',
+                    'to_name': 'text',
+                    'type': 'choices',
+                    'value': {'choices': ['Negative']}}
+                 ]
+                }
+              ],
+              'predictions': [
+                {'model_version': 'sample model version',
+                 'score': 0.95,
+                 'result': [
+                   {'id': 'e7bd76e6-4e88-4eb3-b433-55e03661bf5d',
+                    'from_name': 'sentiment',
+                    'to_name': 'text',
+                    'type': 'choices',
+                    'value': {'choices': ['Neutral']}}
+                 ]
+                }
+              ]
+            }
+
+        NOTE: `id` field in result is not required when importing predictions; it will be generated automatically.
+        NOTE: for each control tag, depends on tag.to_json_schema() being implemented correctly
+        """
+        sample_task = self.generate_sample_task()
+        if not sample_task:
+            if raise_on_failure:
+                raise ValueError("LabelInterface.generate_sample_task failed to generate a valid sample task")
+            return None
+
+        sample_prediction = self.generate_sample_prediction()
+        if not sample_prediction and raise_on_failure:
+            raise ValueError("LabelInterface.generate_sample_prediction failed to generate a valid prediction")
+
+        sample_annotation = self.generate_sample_annotation()
+        if not sample_annotation and raise_on_failure:
+            raise ValueError("LabelInterface.generate_sample_annotation failed to generate a valid annotation")
+
+        return {
+            "data": sample_task,
+            "annotations": [sample_annotation] if sample_annotation else [],
+            "predictions": [sample_prediction] if sample_prediction else []
+        }
+
     #####
     ##### COMPATIBILITY LAYER
     #####