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

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):
         """
@@ -475,7 +481,7 @@ class ControlTag(LabelStudioTag):
         for value in values:
             if len(value) == 1 and self._label_attr_name in value:
                 v = value[self._label_attr_name]
-                labels.append(v[0] if len(v) == 1 else v)
+                labels.append(v[0] if type(v) == list and len(v) == 1 else v)
             else:
                 labels.append(value)
         return labels[0] if len(labels) == 1 else labels
@@ -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
     #####

label_studio_sdk/label_interface/object_tags.py

@@ -119,7 +119,7 @@ class ObjectTag(LabelStudioTag):
             tag=tag.tag,
             attr=dict(tag.attrib),
             name=tag.attrib.get("name"),
-            value=tag.attrib["value"],
+            value=tag.attrib.get('valueList', tag.attrib.get('value')),
         )
 
     @classmethod
@@ -127,7 +127,7 @@ class ObjectTag(LabelStudioTag):
         """
         Check if tag is input
         """
-        return bool(tag.attrib.get("name") and tag.attrib.get("value"))
+        return bool(tag.attrib.get("name") and (tag.attrib.get("value") or tag.attrib.get("valueList")))
 
     @property
     def value_type(self):