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

label_studio_sdk/__init__.py

@@ -23,9 +23,9 @@ from .types import (
     DataManagerTaskSerializerDraftsItem,
     DataManagerTaskSerializerPredictionsItem,
     Export,
-    ExportConvert,
-    ExportCreate,
-    ExportCreateStatus,
+    ExportFormat,
+    ExportSnapshot,
+    ExportSnapshotStatus,
     ExportStatus,
     FileUpload,
     Filter,
@@ -35,6 +35,7 @@ from .types import (
     GcsImportStorage,
     GcsImportStorageStatus,
     InferenceRun,
+    InferenceRunCostEstimate,
     InferenceRunCreatedBy,
     InferenceRunOrganization,
     InferenceRunProjectSubset,
@@ -52,6 +53,7 @@ from .types import (
     MlBackendAuthMethod,
     MlBackendState,
     ModelProviderConnection,
+    ModelProviderConnectionBudgetResetPeriod,
     ModelProviderConnectionCreatedBy,
     ModelProviderConnectionOrganization,
     ModelProviderConnectionProvider,
@@ -64,6 +66,8 @@ from .types import (
     ProjectSampling,
     ProjectSkipQueue,
     Prompt,
+    PromptAssociatedProjectsItem,
+    PromptAssociatedProjectsItemId,
     PromptCreatedBy,
     PromptOrganization,
     PromptVersion,
@@ -87,6 +91,7 @@ from .types import (
     SerializationOptions,
     Task,
     TaskAnnotatorsItem,
+    TaskCommentAuthorsItem,
     TaskFilterOptions,
     UserSimple,
     View,
@@ -111,6 +116,7 @@ from . import (
     prompts,
     tasks,
     users,
+    versions,
     views,
     webhooks,
     workspaces,
@@ -129,7 +135,8 @@ from .actions import (
     ActionsCreateRequestSelectedItemsExcluded,
     ActionsCreateRequestSelectedItemsIncluded,
 )
-from .annotations import AnnotationsCreateBulkResponseItem
+from .annotations import AnnotationsCreateBulkRequestSelectedItems, AnnotationsCreateBulkResponseItem
+from .client import AsyncLabelStudio, LabelStudio
 from .environment import LabelStudioEnvironment
 from .export_storage import ExportStorageListTypesResponseItem
 from .import_storage import ImportStorageListTypesResponseItem
@@ -151,6 +158,7 @@ from .prompts import (
 from .tasks import TasksListRequestFields, TasksListResponse
 from .users import UsersGetTokenResponse, UsersResetTokenResponse
 from .version import __version__
+from .versions import VersionsGetResponse, VersionsGetResponseEdition
 from .views import (
     ViewsCreateRequestData,
     ViewsCreateRequestDataFilters,
@@ -186,9 +194,11 @@ __all__ = [
     "Annotation",
     "AnnotationFilterOptions",
     "AnnotationLastAction",
+    "AnnotationsCreateBulkRequestSelectedItems",
     "AnnotationsCreateBulkResponseItem",
     "AnnotationsDmField",
     "AnnotationsDmFieldLastAction",
+    "AsyncLabelStudio",
     "AzureBlobExportStorage",
     "AzureBlobExportStorageStatus",
     "AzureBlobImportStorage",
@@ -208,9 +218,9 @@ __all__ = [
     "DataManagerTaskSerializerDraftsItem",
     "DataManagerTaskSerializerPredictionsItem",
     "Export",
-    "ExportConvert",
-    "ExportCreate",
-    "ExportCreateStatus",
+    "ExportFormat",
+    "ExportSnapshot",
+    "ExportSnapshotStatus",
     "ExportStatus",
     "ExportStorageListTypesResponseItem",
     "FileUpload",
@@ -222,6 +232,7 @@ __all__ = [
     "GcsImportStorageStatus",
     "ImportStorageListTypesResponseItem",
     "InferenceRun",
+    "InferenceRunCostEstimate",
     "InferenceRunCreatedBy",
     "InferenceRunOrganization",
     "InferenceRunProjectSubset",
@@ -232,6 +243,7 @@ __all__ = [
     "KeyIndicatorsItem",
     "KeyIndicatorsItemAdditionalKpisItem",
     "KeyIndicatorsItemExtraKpisItem",
+    "LabelStudio",
     "LabelStudioEnvironment",
     "LocalFilesExportStorage",
     "LocalFilesExportStorageStatus",
@@ -247,6 +259,7 @@ __all__ = [
     "MlUpdateResponse",
     "MlUpdateResponseAuthMethod",
     "ModelProviderConnection",
+    "ModelProviderConnectionBudgetResetPeriod",
     "ModelProviderConnectionCreatedBy",
     "ModelProviderConnectionOrganization",
     "ModelProviderConnectionProvider",
@@ -263,6 +276,8 @@ __all__ = [
     "ProjectsListResponse",
     "ProjectsUpdateResponse",
     "Prompt",
+    "PromptAssociatedProjectsItem",
+    "PromptAssociatedProjectsItemId",
     "PromptCreatedBy",
     "PromptOrganization",
     "PromptVersion",
@@ -290,12 +305,15 @@ __all__ = [
     "SerializationOptions",
     "Task",
     "TaskAnnotatorsItem",
+    "TaskCommentAuthorsItem",
     "TaskFilterOptions",
     "TasksListRequestFields",
     "TasksListResponse",
     "UserSimple",
     "UsersGetTokenResponse",
     "UsersResetTokenResponse",
+    "VersionsGetResponse",
+    "VersionsGetResponseEdition",
     "View",
     "ViewsCreateRequestData",
     "ViewsCreateRequestDataFilters",
@@ -333,6 +351,7 @@ __all__ = [
     "prompts",
     "tasks",
     "users",
+    "versions",
     "views",
     "webhooks",
     "workspaces",

label_studio_sdk/_extensions/label_studio_tools/core/label_config.py

@@ -82,17 +82,26 @@ def parse_config(config_string):
         elif _is_input_tag(tag):
             inputs[tag.attrib["name"]] = {
                 "type": tag.tag,
-                "value": tag.attrib["value"].lstrip("$"),
                 "valueType": tag.attrib.get("valueType"),
             }
+            if 'value' in tag.attrib:
+                inputs[tag.attrib["name"]]["value"] = tag.attrib["value"].lstrip("$")
+            elif 'valueList' in tag.attrib:
+                inputs[tag.attrib["name"]]["valueList"] = tag.attrib["valueList"].lstrip("$")
+            else:
+                raise ValueError(
+                    'Inspecting tag {tag_name}... found no "value" or "valueList" attributes.'.format(
+                        tag_name=etree.tostring(tag, encoding="unicode").strip()[:50]
+                    )
+                )
         if tag.tag not in _LABEL_TAGS:
             continue
         parent_name = _get_parent_output_tag_name(tag, outputs)
         if parent_name is not None:
-            actual_value = tag.attrib.get("alias") or tag.attrib.get("value")
+            actual_value = tag.attrib.get("alias") or tag.attrib.get("value") or tag.attrib.get("valueList")
             if not actual_value:
                 logger.debug(
-                    'Inspecting tag {tag_name}... found no "value" or "alias" attributes.'.format(
+                    'Inspecting tag {tag_name}... found no "value", "valueList", or "alias" attributes.'.format(
                         tag_name=etree.tostring(tag, encoding="unicode").strip()[:50]
                     )
                 )
@@ -137,7 +146,7 @@ def _is_input_tag(tag):
     """
     Check if tag is input
     """
-    return tag.attrib.get("name") and tag.attrib.get("value")
+    return tag.attrib.get("name") and (tag.attrib.get("value") or tag.attrib.get("valueList"))
 
 
 def _is_output_tag(tag):

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

@@ -37,6 +37,17 @@ def get_cache_dir():
     return cache_dir
 
 
+def safe_build_path(base_dir: str, user_path: str) -> str:
+    combined_path = os.path.join(base_dir, user_path)
+    absolute_path = os.path.abspath(combined_path)
+    base_dir_abs = os.path.abspath(base_dir)
+
+    if os.path.commonpath([absolute_path, base_dir_abs]) != base_dir_abs:
+        raise ValueError(f"Invalid path: {user_path}")
+
+    return absolute_path
+
+
 def get_local_path(
     url,
     cache_dir=None,
@@ -103,7 +114,7 @@ def get_local_path(
     # instead of downloading them from LS instance
     if is_local_storage_file:
         filepath = url.split("?d=")[1]
-        filepath = os.path.join(LOCAL_FILES_DOCUMENT_ROOT, filepath)
+        filepath = safe_build_path(LOCAL_FILES_DOCUMENT_ROOT, filepath)
         if os.path.exists(filepath):
             logger.debug(
                 f"Local Storage file path exists locally, use it as a local file: {filepath}"
@@ -124,9 +135,9 @@ def get_local_path(
     if is_uploaded_file and os.path.exists(image_dir):
         project_id = url.split("/")[-2]  # To retrieve project_id
         filepath = os.path.join(image_dir, project_id, os.path.basename(url))
-        if cache_dir and download_resources:
-            shutil.copy(filepath, cache_dir)
         if os.path.exists(filepath):
+            if cache_dir and download_resources:
+                shutil.copy(filepath, cache_dir)
             logger.debug(f"Uploaded file: Path exists in image_dir: {filepath}")
             return filepath
 
@@ -202,7 +213,7 @@ def download_and_cache(
     filepath = os.path.join(cache_dir, url_hash + "__" + url_filename)
 
     if not os.path.exists(filepath):
-        logger.info("Download {url} to {filepath}".format(url=url, filepath=filepath))
+        logger.info("Download {url} to {filepath}. download_resources: {download_resources}".format(url=url, filepath=filepath, download_resources=download_resources))
         if download_resources:
             headers = {
                 # avoid requests.exceptions.HTTPError: 403 Client Error: Forbidden. Please comply with the User-Agent policy:
@@ -227,6 +238,7 @@ def download_and_cache(
                 raise e
             with io.open(filepath, mode="wb") as fout:
                 fout.write(r.content)
+                logger.info(f"File downloaded to {filepath}")
     return filepath
 
 

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

@@ -0,0 +1,86 @@
+import json
+import types
+import sys
+import functools
+from typing import Type, Dict, Any, Tuple, Generator
+from pathlib import Path
+from tempfile import TemporaryDirectory
+from datamodel_code_generator import DataModelType, PythonVersion, LiteralType
+from datamodel_code_generator.model import get_data_model_types
+from datamodel_code_generator.parser.jsonschema import JsonSchemaParser
+from pydantic import BaseModel
+from contextlib import contextmanager
+
+
+@functools.lru_cache(maxsize=128)
+def _generate_model_code(json_schema_str: str, class_name: str = 'MyModel') -> str:
+
+    data_model_types = get_data_model_types(
+        DataModelType.PydanticV2BaseModel,
+        target_python_version=PythonVersion.PY_311
+    )
+
+    parser = JsonSchemaParser(
+        json_schema_str,
+        data_model_type=data_model_types.data_model,
+        data_model_root_type=data_model_types.root_model,
+        data_model_field_type=data_model_types.field_model,
+        data_type_manager_type=data_model_types.data_type_manager,
+        dump_resolve_reference_action=data_model_types.dump_resolve_reference_action,
+        enum_field_as_literal=LiteralType.All,
+        class_name=class_name
+    )
+
+    model_code = parser.parse()
+    return model_code
+
+@contextmanager
+def json_schema_to_pydantic(json_schema: dict, class_name: str = 'MyModel') -> Generator[Type[BaseModel], None, None]:
+    """
+    Convert a JSON schema to a Pydantic model and provide it as a context manager.
+
+    Args:
+        json_schema (dict): The JSON schema to convert.
+        class_name (str, optional): The name of the generated Pydantic class. Defaults to 'MyModel'.
+
+    Example:
+        ```python
+        example_schema = {
+            "type": "object",
+            "properties": {
+                "sentiment": {
+                    "type": "string",
+                    "description": "Sentiment of the text",
+                    "enum": ["Positive", "Negative", "Neutral"],
+                }
+            },
+            "required": ["sentiment"]
+        }
+        with json_schema_to_pydantic(example_schema) as ResponseModel:
+            instance = ResponseModel(sentiment='Positive')
+            print(instance.model_dump())
+        ```
+    """
+    # Convert the JSON schema dictionary to a JSON string
+    json_schema_str = json.dumps(json_schema)
+    
+    # Generate Pydantic model code from the JSON schema string
+    model_code: str = _generate_model_code(json_schema_str, class_name)
+    
+    # Create a unique module name using the id of the JSON schema string
+    module_name = f'dynamic_module_{id(json_schema_str)}'
+    
+    # Create a new module object with the unique name and execute the generated model code in the context of the new module
+    mod = types.ModuleType(module_name)
+    exec(model_code, mod.__dict__)
+    model_class = getattr(mod, class_name)
+    
+    try:
+        # 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
+        yield model_class
+    finally:
+        if module_name in sys.modules:
+            del sys.modules[module_name]
+        

label_studio_sdk/_extensions/pager_ext.py

@@ -47,3 +47,11 @@ class AsyncPagerExt(AsyncPager, typing.Generic[T]):
             if exc.status_code == 404:
                 return
             raise
+        
+    async def __anext__(self) -> T:
+        try:
+            return await super().__anext__()
+        except ApiError as exc:
+            if exc.status_code == 404:
+                raise StopAsyncIteration
+            raise

label_studio_sdk/_legacy/schema/label_config_schema.json

@@ -35,22 +35,44 @@
         }
       }
     },
-    "tag_with_value_required_name": {
+    "tag_with_name_and_toname": {
       "type": "object",
-      "anyOf": [
-	{
-          "required": [
-            "@name",
-            "@valueList"
-          ]
-        },
+      "oneOf": [
         {
           "required": [
             "@name",
-            "@value"
+            "@toName"
           ]
         }
       ],
+      "properties": {
+        "@name": {
+          "$ref": "#/definitions/@name"
+        },
+        "@toName": {
+          "$ref": "#/definitions/@toName"
+        },
+        "$": {
+          "$ref": "#/definitions/$"
+        }
+      }
+    },
+    "tag_with_value_required_name": {
+      "type": "object",
+      "oneOf": [
+          {
+            "required": [
+                "@name",
+                "@value"
+            ]
+          },
+          {
+            "required": [
+                "@name",
+                "@valueList"
+            ]
+          }
+      ],
       "properties": {
         "@value": {
           "$ref": "#/definitions/@value"
@@ -80,6 +102,13 @@
         "items": {"$ref": "#/definitions/tag_with_value_required_name"}
       }, {"$ref": "#/definitions/tag_with_value_required_name"}]
     },
+    "tags_with_name_and_toname": {
+      "anyOf": [{"$ref": "#/definitions/tag_with_name_and_toname"},
+        {
+          "type": "array",
+          "items": {"$ref": "#/definitions/tag_with_name_and_toname"}
+        }]
+    },
     "View": {
       "type": "object",
       "additionalProperties": true,
@@ -92,7 +121,8 @@
         "Text": {"$ref": "#/definitions/tags_with_value_required_name"},
         "HyperText": {"$ref": "#/definitions/tags_with_value_required_name"},
         "View": {"$ref": "#/definitions/MaybeMultipleView"},
-        "TextArea": {"$ref": "#/definitions/MaybeMultipleTextAreas"}
+        "TextArea": {"$ref": "#/definitions/MaybeMultipleTextAreas"},
+        "Number": {"$ref": "#/definitions/tags_with_name_and_toname"}
       }
     },
     "MaybeMultipleView": {
@@ -219,7 +249,8 @@
         "Image": {"$ref": "#/definitions/tags_with_value_required_name"},
         "Text": {"$ref": "#/definitions/tags_with_value_required_name"},
         "HyperText": {"$ref": "#/definitions/tags_with_value_required_name"},
-        "TextArea": {"$ref": "#/definitions/MaybeMultipleTextAreas"}
+        "TextArea": {"$ref": "#/definitions/MaybeMultipleTextAreas"},
+        "Number": {"$ref": "#/definitions/tags_with_name_and_toname"}
       }
     }
   }

label_studio_sdk/actions/client.py

@@ -1,15 +1,16 @@
 # 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 json.decoder import JSONDecodeError
-
 from ..core.api_error import ApiError
-from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.request_options import RequestOptions
-from .types.actions_create_request_filters import ActionsCreateRequestFilters
 from .types.actions_create_request_id import ActionsCreateRequestId
-from .types.actions_create_request_ordering_item import ActionsCreateRequestOrderingItem
+from .types.actions_create_request_filters import ActionsCreateRequestFilters
 from .types.actions_create_request_selected_items import ActionsCreateRequestSelectedItems
+from .types.actions_create_request_ordering_item import ActionsCreateRequestOrderingItem
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -34,7 +35,7 @@ class ActionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -42,7 +43,9 @@ class ActionsClient:
         client.actions.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/dm/actions/", method="GET", request_options=request_options
+            "api/dm/actions/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -61,7 +64,7 @@ class ActionsClient:
         filters: typing.Optional[ActionsCreateRequestFilters] = OMIT,
         selected_items: typing.Optional[ActionsCreateRequestSelectedItems] = OMIT,
         ordering: typing.Optional[typing.Sequence[ActionsCreateRequestOrderingItem]] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
         Perform a Data Manager action with the selected tasks and filters. Note: More complex actions require additional parameters in the request body. Call `GET api/actions?project=<id>` to explore them. <br>Example: `GET api/actions?id=delete_tasks&project=1`
@@ -95,12 +98,12 @@ class ActionsClient:
 
         Examples
         --------
-        from label_studio_sdk import (
+        from label_studio_sdk import LabelStudio
+        from label_studio_sdk.actions import (
             ActionsCreateRequestFilters,
             ActionsCreateRequestFiltersItemsItem,
             ActionsCreateRequestSelectedItemsExcluded,
         )
-        from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -129,8 +132,23 @@ class ActionsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/dm/actions/",
             method="POST",
-            params={"id": id, "project": project, "view": view},
-            json={"filters": filters, "selectedItems": selected_items, "ordering": ordering},
+            params={
+                "id": id,
+                "project": project,
+                "view": view,
+            },
+            json={
+                "filters": convert_and_respect_annotation_metadata(
+                    object_=filters, annotation=ActionsCreateRequestFilters, direction="write"
+                ),
+                "selectedItems": convert_and_respect_annotation_metadata(
+                    object_=selected_items, annotation=ActionsCreateRequestSelectedItems, direction="write"
+                ),
+                "ordering": ordering,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -162,15 +180,25 @@ class AsyncActionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.actions.list()
+
+
+        async def main() -> None:
+            await client.actions.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/dm/actions/", method="GET", request_options=request_options
+            "api/dm/actions/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -189,7 +217,7 @@ class AsyncActionsClient:
         filters: typing.Optional[ActionsCreateRequestFilters] = OMIT,
         selected_items: typing.Optional[ActionsCreateRequestSelectedItems] = OMIT,
         ordering: typing.Optional[typing.Sequence[ActionsCreateRequestOrderingItem]] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
         Perform a Data Manager action with the selected tasks and filters. Note: More complex actions require additional parameters in the request body. Call `GET api/actions?project=<id>` to explore them. <br>Example: `GET api/actions?id=delete_tasks&project=1`
@@ -223,42 +251,65 @@ class AsyncActionsClient:
 
         Examples
         --------
-        from label_studio_sdk import (
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+        from label_studio_sdk.actions import (
             ActionsCreateRequestFilters,
             ActionsCreateRequestFiltersItemsItem,
             ActionsCreateRequestSelectedItemsExcluded,
         )
-        from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.actions.create(
-            id="retrieve_tasks_predictions",
-            project=1,
-            filters=ActionsCreateRequestFilters(
-                conjunction="or",
-                items=[
-                    ActionsCreateRequestFiltersItemsItem(
-                        filter="filter:tasks:id",
-                        operator="greater",
-                        type="Number",
-                        value=123,
-                    )
-                ],
-            ),
-            selected_items=ActionsCreateRequestSelectedItemsExcluded(
-                all_=True,
-                excluded=[124, 125, 126],
-            ),
-            ordering=["tasks:total_annotations"],
-        )
+
+
+        async def main() -> None:
+            await client.actions.create(
+                id="retrieve_tasks_predictions",
+                project=1,
+                filters=ActionsCreateRequestFilters(
+                    conjunction="or",
+                    items=[
+                        ActionsCreateRequestFiltersItemsItem(
+                            filter="filter:tasks:id",
+                            operator="greater",
+                            type="Number",
+                            value=123,
+                        )
+                    ],
+                ),
+                selected_items=ActionsCreateRequestSelectedItemsExcluded(
+                    all_=True,
+                    excluded=[124, 125, 126],
+                ),
+                ordering=["tasks:total_annotations"],
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/dm/actions/",
             method="POST",
-            params={"id": id, "project": project, "view": view},
-            json={"filters": filters, "selectedItems": selected_items, "ordering": ordering},
+            params={
+                "id": id,
+                "project": project,
+                "view": view,
+            },
+            json={
+                "filters": convert_and_respect_annotation_metadata(
+                    object_=filters, annotation=ActionsCreateRequestFilters, direction="write"
+                ),
+                "selectedItems": convert_and_respect_annotation_metadata(
+                    object_=selected_items, annotation=ActionsCreateRequestSelectedItems, direction="write"
+                ),
+                "ordering": ordering,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )