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

label_studio_sdk/files/client.py

@@ -96,7 +96,12 @@ class FilesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def update(
-        self, id: int, *, request: FileUpload, request_options: typing.Optional[RequestOptions] = None
+        self,
+        id_: int,
+        *,
+        id: typing.Optional[int] = OMIT,
+        file: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> FileUpload:
         """
         Update a specific uploaded file. To get the file upload ID, use [Get files list](list).
@@ -109,10 +114,12 @@ class FilesClient:
 
         Parameters
         ----------
-        id : int
+        id_ : int
             A unique integer value identifying this file upload.
 
-        request : FileUpload
+        id : typing.Optional[int]
+
+        file : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -124,21 +131,19 @@ class FilesClient:
 
         Examples
         --------
-        from label_studio_sdk import FileUpload
         from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.files.update(
-            id=1,
-            request=FileUpload(),
+            id_=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/import/file-upload/{jsonable_encoder(id)}",
+            f"api/import/file-upload/{jsonable_encoder(id_)}",
             method="PATCH",
-            json=request,
+            json={"id": id, "file": file},
             request_options=request_options,
             omit=OMIT,
         )
@@ -367,7 +372,12 @@ class AsyncFilesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def update(
-        self, id: int, *, request: FileUpload, request_options: typing.Optional[RequestOptions] = None
+        self,
+        id_: int,
+        *,
+        id: typing.Optional[int] = OMIT,
+        file: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> FileUpload:
         """
         Update a specific uploaded file. To get the file upload ID, use [Get files list](list).
@@ -380,10 +390,12 @@ class AsyncFilesClient:
 
         Parameters
         ----------
-        id : int
+        id_ : int
             A unique integer value identifying this file upload.
 
-        request : FileUpload
+        id : typing.Optional[int]
+
+        file : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -395,21 +407,19 @@ class AsyncFilesClient:
 
         Examples
         --------
-        from label_studio_sdk import FileUpload
         from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
         await client.files.update(
-            id=1,
-            request=FileUpload(),
+            id_=1,
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/import/file-upload/{jsonable_encoder(id)}",
+            f"api/import/file-upload/{jsonable_encoder(id_)}",
             method="PATCH",
-            json=request,
+            json={"id": id, "file": file},
             request_options=request_options,
             omit=OMIT,
         )

label_studio_sdk/label_interface/interface.py

@@ -30,9 +30,11 @@ from .control_tags import (
 )
 from .object_tags import ObjectTag
 from .label_tags import LabelTag
-from .objects import AnnotationValue, TaskValue, PredictionValue
+from .objects import AnnotationValue, TaskValue, PredictionValue, Region
 from . import create as CE
 
+logger = logging.getLogger(__name__)
+
 
 dir_path = os.path.dirname(os.path.realpath(__file__))
 file_path = os.path.join(dir_path, "..", "_legacy", "schema", "label_config_schema.json")
@@ -250,8 +252,7 @@ class LabelInterface:
         """
         config = cls.create(*args, **kwargs)
         return cls(config=config, **kwargs)
-    
-    
+
     def __init__(self, config: str, tags_mapping=None, *args, **kwargs):
         """
         Initialize a LabelInterface instance using a config string.
@@ -299,9 +300,41 @@ class LabelInterface:
         self._labels = labels
         self._tree = tree
 
-        
+    def create_regions(self, data: Dict[str, Union[str, Dict, List[str], List[Dict]]]) -> List[Region]:
+        """
+        Takes raw data representation and maps keys to control tag names.
+        If name is not found, it will be skipped
+
+        Args:
+            data (Dict): Raw data representation. Example: {"choices_name": "Positive", "labels_name": [{"start": 0, "end": 10, "label": "person"}]}
+            raise_if_control_not_found (bool): Raise an exception if control tag is not found.
+        """
+        regions = []
+        for control_tag_name, payload in data.items():
+            if control_tag_name not in self._controls:
+                logger.info(f"Control tag '{control_tag_name}' not found in the config")
+                continue
 
-    ##### NEW API
+            control = self._controls[control_tag_name]
+            # TODO: I don't really like this part, looks like a workaround
+            # 1. we should allow control.label to process custom payload outside of those strictly containing "label"
+            # 2. we should be less open regarding the payload type and defining the strict typing elsewhere,
+            # but likely that requires rewriting of how ControlTag.label() is working now
+            if isinstance(payload, str):
+                payload = {'label': payload}
+            elif isinstance(payload, list):
+                if len(payload) > 0:
+                    if isinstance(payload[0], str):
+                        payload = {'label': payload}
+                    else:
+                        pass
+
+            if isinstance(payload, Dict):
+                payload = [payload]
+            for item in payload:
+                regions.append(control.label(**item))
+
+        return regions
 
     @property
     def config(self):

label_studio_sdk/model_providers/__init__.py

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

label_studio_sdk/model_providers/client.py

@@ -0,0 +1,190 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pydantic_utilities import pydantic_v1
+from ..core.request_options import RequestOptions
+from ..types.model_provider_connection import ModelProviderConnection
+from ..types.model_provider_connection_created_by import ModelProviderConnectionCreatedBy
+from ..types.model_provider_connection_organization import ModelProviderConnectionOrganization
+from ..types.model_provider_connection_provider import ModelProviderConnectionProvider
+from ..types.model_provider_connection_scope import ModelProviderConnectionScope
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class ModelProvidersClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create(
+        self,
+        *,
+        provider: ModelProviderConnectionProvider,
+        api_key: typing.Optional[str] = OMIT,
+        deployment_name: typing.Optional[str] = OMIT,
+        endpoint: typing.Optional[str] = OMIT,
+        scope: typing.Optional[ModelProviderConnectionScope] = OMIT,
+        organization: typing.Optional[ModelProviderConnectionOrganization] = OMIT,
+        created_by: typing.Optional[ModelProviderConnectionCreatedBy] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        updated_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None
+    ) -> ModelProviderConnection:
+        """
+        Create a new model provider connection.
+
+        Parameters
+        ----------
+        provider : ModelProviderConnectionProvider
+
+        api_key : typing.Optional[str]
+
+        deployment_name : typing.Optional[str]
+
+        endpoint : typing.Optional[str]
+
+        scope : typing.Optional[ModelProviderConnectionScope]
+
+        organization : typing.Optional[ModelProviderConnectionOrganization]
+
+        created_by : typing.Optional[ModelProviderConnectionCreatedBy]
+
+        created_at : typing.Optional[dt.datetime]
+
+        updated_at : typing.Optional[dt.datetime]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ModelProviderConnection
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.model_providers.create(
+            provider="OpenAI",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/model-provider-connections/",
+            method="POST",
+            json={
+                "provider": provider,
+                "api_key": api_key,
+                "deployment_name": deployment_name,
+                "endpoint": endpoint,
+                "scope": scope,
+                "organization": organization,
+                "created_by": created_by,
+                "created_at": created_at,
+                "updated_at": updated_at,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(ModelProviderConnection, _response.json())  # type: ignore
+            _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 AsyncModelProvidersClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create(
+        self,
+        *,
+        provider: ModelProviderConnectionProvider,
+        api_key: typing.Optional[str] = OMIT,
+        deployment_name: typing.Optional[str] = OMIT,
+        endpoint: typing.Optional[str] = OMIT,
+        scope: typing.Optional[ModelProviderConnectionScope] = OMIT,
+        organization: typing.Optional[ModelProviderConnectionOrganization] = OMIT,
+        created_by: typing.Optional[ModelProviderConnectionCreatedBy] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        updated_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None
+    ) -> ModelProviderConnection:
+        """
+        Create a new model provider connection.
+
+        Parameters
+        ----------
+        provider : ModelProviderConnectionProvider
+
+        api_key : typing.Optional[str]
+
+        deployment_name : typing.Optional[str]
+
+        endpoint : typing.Optional[str]
+
+        scope : typing.Optional[ModelProviderConnectionScope]
+
+        organization : typing.Optional[ModelProviderConnectionOrganization]
+
+        created_by : typing.Optional[ModelProviderConnectionCreatedBy]
+
+        created_at : typing.Optional[dt.datetime]
+
+        updated_at : typing.Optional[dt.datetime]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ModelProviderConnection
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.model_providers.create(
+            provider="OpenAI",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/model-provider-connections/",
+            method="POST",
+            json={
+                "provider": provider,
+                "api_key": api_key,
+                "deployment_name": deployment_name,
+                "endpoint": endpoint,
+                "scope": scope,
+                "organization": organization,
+                "created_by": created_by,
+                "created_at": created_at,
+                "updated_at": updated_at,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(ModelProviderConnection, _response.json())  # type: ignore
+            _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/projects/client.py

@@ -131,6 +131,7 @@ class ProjectsClient:
         color: typing.Optional[str] = OMIT,
         control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         workspace: typing.Optional[int] = OMIT,
+        model_version: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProjectsCreateResponse:
         """
@@ -188,6 +189,9 @@ class ProjectsClient:
         workspace : typing.Optional[int]
             Workspace ID
 
+        model_version : typing.Optional[str]
+            Model version
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -223,6 +227,7 @@ class ProjectsClient:
                 "color": color,
                 "control_weights": control_weights,
                 "workspace": workspace,
+                "model_version": model_version,
             },
             request_options=request_options,
             omit=OMIT,
@@ -332,6 +337,7 @@ class ProjectsClient:
         color: typing.Optional[str] = OMIT,
         control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         workspace: typing.Optional[int] = OMIT,
+        model_version: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProjectsUpdateResponse:
         """
@@ -396,6 +402,9 @@ class ProjectsClient:
         workspace : typing.Optional[int]
             Workspace ID
 
+        model_version : typing.Optional[str]
+            Model version
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -433,6 +442,7 @@ class ProjectsClient:
                 "color": color,
                 "control_weights": control_weights,
                 "workspace": workspace,
+                "model_version": model_version,
             },
             request_options=request_options,
             omit=OMIT,
@@ -541,7 +551,7 @@ class ProjectsClient:
         )
         client.projects.import_tasks(
             id=1,
-            request=[{}],
+            request=[{"key": "value"}],
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -567,7 +577,7 @@ class ProjectsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def validate_config(
-        self, id: int, *, request: ProjectLabelConfig, request_options: typing.Optional[RequestOptions] = None
+        self, id: int, *, label_config: str, request_options: typing.Optional[RequestOptions] = None
     ) -> ProjectLabelConfig:
         """
         Determine whether the label configuration for a specific project is valid. For more information about setting up labeling configs, see [Configure labeling interface](https://labelstud.io/guide/setup) and our [Tags reference](https://labelstud.io/tags/).
@@ -579,7 +589,8 @@ class ProjectsClient:
         id : int
             A unique integer value identifying this project.
 
-        request : ProjectLabelConfig
+        label_config : str
+            Label config in XML format. See more about it in documentation
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -591,7 +602,6 @@ class ProjectsClient:
 
         Examples
         --------
-        from label_studio_sdk import ProjectLabelConfig
         from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
@@ -599,15 +609,13 @@ class ProjectsClient:
         )
         client.projects.validate_config(
             id=1,
-            request=ProjectLabelConfig(
-                label_config="label_config",
-            ),
+            label_config="label_config",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/validate/",
             method="POST",
-            json=request,
+            json={"label_config": label_config},
             request_options=request_options,
             omit=OMIT,
         )
@@ -729,6 +737,7 @@ class AsyncProjectsClient:
         color: typing.Optional[str] = OMIT,
         control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         workspace: typing.Optional[int] = OMIT,
+        model_version: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProjectsCreateResponse:
         """
@@ -786,6 +795,9 @@ class AsyncProjectsClient:
         workspace : typing.Optional[int]
             Workspace ID
 
+        model_version : typing.Optional[str]
+            Model version
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -821,6 +833,7 @@ class AsyncProjectsClient:
                 "color": color,
                 "control_weights": control_weights,
                 "workspace": workspace,
+                "model_version": model_version,
             },
             request_options=request_options,
             omit=OMIT,
@@ -930,6 +943,7 @@ class AsyncProjectsClient:
         color: typing.Optional[str] = OMIT,
         control_weights: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
         workspace: typing.Optional[int] = OMIT,
+        model_version: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProjectsUpdateResponse:
         """
@@ -994,6 +1008,9 @@ class AsyncProjectsClient:
         workspace : typing.Optional[int]
             Workspace ID
 
+        model_version : typing.Optional[str]
+            Model version
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1031,6 +1048,7 @@ class AsyncProjectsClient:
                 "color": color,
                 "control_weights": control_weights,
                 "workspace": workspace,
+                "model_version": model_version,
             },
             request_options=request_options,
             omit=OMIT,
@@ -1139,7 +1157,7 @@ class AsyncProjectsClient:
         )
         await client.projects.import_tasks(
             id=1,
-            request=[{}],
+            request=[{"key": "value"}],
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -1165,7 +1183,7 @@ class AsyncProjectsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def validate_config(
-        self, id: int, *, request: ProjectLabelConfig, request_options: typing.Optional[RequestOptions] = None
+        self, id: int, *, label_config: str, request_options: typing.Optional[RequestOptions] = None
     ) -> ProjectLabelConfig:
         """
         Determine whether the label configuration for a specific project is valid. For more information about setting up labeling configs, see [Configure labeling interface](https://labelstud.io/guide/setup) and our [Tags reference](https://labelstud.io/tags/).
@@ -1177,7 +1195,8 @@ class AsyncProjectsClient:
         id : int
             A unique integer value identifying this project.
 
-        request : ProjectLabelConfig
+        label_config : str
+            Label config in XML format. See more about it in documentation
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1189,7 +1208,6 @@ class AsyncProjectsClient:
 
         Examples
         --------
-        from label_studio_sdk import ProjectLabelConfig
         from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
@@ -1197,15 +1215,13 @@ class AsyncProjectsClient:
         )
         await client.projects.validate_config(
             id=1,
-            request=ProjectLabelConfig(
-                label_config="label_config",
-            ),
+            label_config="label_config",
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/validate/",
             method="POST",
-            json=request,
+            json={"label_config": label_config},
             request_options=request_options,
             omit=OMIT,
         )