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

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,
         )

label_studio_sdk/projects/exports/client.py

@@ -1,5 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import datetime as dt
 import typing
 from json.decoder import JSONDecodeError
 
@@ -8,9 +9,15 @@ from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.pydantic_utilities import pydantic_v1
 from ...core.request_options import RequestOptions
+from ...types.annotation_filter_options import AnnotationFilterOptions
+from ...types.converted_format import ConvertedFormat
 from ...types.export import Export
 from ...types.export_convert import ExportConvert
 from ...types.export_create import ExportCreate
+from ...types.export_create_status import ExportCreateStatus
+from ...types.serialization_options import SerializationOptions
+from ...types.task_filter_options import TaskFilterOptions
+from ...types.user_simple import UserSimple
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -199,7 +206,22 @@ class ExportsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def create(
-        self, id: int, *, request: ExportCreate, request_options: typing.Optional[RequestOptions] = None
+        self,
+        id_: int,
+        *,
+        title: typing.Optional[str] = OMIT,
+        id: typing.Optional[int] = OMIT,
+        created_by: typing.Optional[UserSimple] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        finished_at: typing.Optional[dt.datetime] = OMIT,
+        status: typing.Optional[ExportCreateStatus] = OMIT,
+        md5: typing.Optional[str] = OMIT,
+        counters: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        converted_formats: typing.Optional[typing.Sequence[ConvertedFormat]] = OMIT,
+        task_filter_options: typing.Optional[TaskFilterOptions] = OMIT,
+        annotation_filter_options: typing.Optional[AnnotationFilterOptions] = OMIT,
+        serialization_options: typing.Optional[SerializationOptions] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> ExportCreate:
         """
         Create a new export request to start a background task and generate an export file (snapshot) for a specific project by ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../list).
@@ -210,10 +232,34 @@ class ExportsClient:
 
         Parameters
         ----------
-        id : int
+        id_ : int
             A unique integer value identifying this project.
 
-        request : ExportCreate
+        title : typing.Optional[str]
+
+        id : typing.Optional[int]
+
+        created_by : typing.Optional[UserSimple]
+
+        created_at : typing.Optional[dt.datetime]
+            Creation time
+
+        finished_at : typing.Optional[dt.datetime]
+            Complete or fail time
+
+        status : typing.Optional[ExportCreateStatus]
+
+        md5 : typing.Optional[str]
+
+        counters : typing.Optional[typing.Dict[str, typing.Any]]
+
+        converted_formats : typing.Optional[typing.Sequence[ConvertedFormat]]
+
+        task_filter_options : typing.Optional[TaskFilterOptions]
+
+        annotation_filter_options : typing.Optional[AnnotationFilterOptions]
+
+        serialization_options : typing.Optional[SerializationOptions]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -225,21 +271,32 @@ class ExportsClient:
 
         Examples
         --------
-        from label_studio_sdk import ExportCreate
         from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
         client.projects.exports.create(
-            id=1,
-            request=ExportCreate(),
+            id_=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/",
+            f"api/projects/{jsonable_encoder(id_)}/exports/",
             method="POST",
-            json=request,
+            json={
+                "title": title,
+                "id": id,
+                "created_by": created_by,
+                "created_at": created_at,
+                "finished_at": finished_at,
+                "status": status,
+                "md5": md5,
+                "counters": counters,
+                "converted_formats": converted_formats,
+                "task_filter_options": task_filter_options,
+                "annotation_filter_options": annotation_filter_options,
+                "serialization_options": serialization_options,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -347,12 +404,7 @@ class ExportsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def convert(
-        self,
-        id: int,
-        export_pk: str,
-        *,
-        request: ExportConvert,
-        request_options: typing.Optional[RequestOptions] = None,
+        self, id: int, export_pk: str, *, export_type: str, request_options: typing.Optional[RequestOptions] = None
     ) -> ExportConvert:
         """
         You can use this to convert an export snapshot into the selected format.
@@ -371,7 +423,8 @@ class ExportsClient:
         export_pk : str
             Primary key identifying the export file.
 
-        request : ExportConvert
+        export_type : str
+            Export file format.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -383,7 +436,6 @@ class ExportsClient:
 
         Examples
         --------
-        from label_studio_sdk import ExportConvert
         from label_studio_sdk.client import LabelStudio
 
         client = LabelStudio(
@@ -392,15 +444,13 @@ class ExportsClient:
         client.projects.exports.convert(
             id=1,
             export_pk="export_pk",
-            request=ExportConvert(
-                export_type="export_type",
-            ),
+            export_type="export_type",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}/convert",
             method="POST",
-            json=request,
+            json={"export_type": export_type},
             request_options=request_options,
             omit=OMIT,
         )
@@ -657,7 +707,22 @@ class AsyncExportsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def create(
-        self, id: int, *, request: ExportCreate, request_options: typing.Optional[RequestOptions] = None
+        self,
+        id_: int,
+        *,
+        title: typing.Optional[str] = OMIT,
+        id: typing.Optional[int] = OMIT,
+        created_by: typing.Optional[UserSimple] = OMIT,
+        created_at: typing.Optional[dt.datetime] = OMIT,
+        finished_at: typing.Optional[dt.datetime] = OMIT,
+        status: typing.Optional[ExportCreateStatus] = OMIT,
+        md5: typing.Optional[str] = OMIT,
+        counters: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        converted_formats: typing.Optional[typing.Sequence[ConvertedFormat]] = OMIT,
+        task_filter_options: typing.Optional[TaskFilterOptions] = OMIT,
+        annotation_filter_options: typing.Optional[AnnotationFilterOptions] = OMIT,
+        serialization_options: typing.Optional[SerializationOptions] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> ExportCreate:
         """
         Create a new export request to start a background task and generate an export file (snapshot) for a specific project by ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../list).
@@ -668,10 +733,34 @@ class AsyncExportsClient:
 
         Parameters
         ----------
-        id : int
+        id_ : int
             A unique integer value identifying this project.
 
-        request : ExportCreate
+        title : typing.Optional[str]
+
+        id : typing.Optional[int]
+
+        created_by : typing.Optional[UserSimple]
+
+        created_at : typing.Optional[dt.datetime]
+            Creation time
+
+        finished_at : typing.Optional[dt.datetime]
+            Complete or fail time
+
+        status : typing.Optional[ExportCreateStatus]
+
+        md5 : typing.Optional[str]
+
+        counters : typing.Optional[typing.Dict[str, typing.Any]]
+
+        converted_formats : typing.Optional[typing.Sequence[ConvertedFormat]]
+
+        task_filter_options : typing.Optional[TaskFilterOptions]
+
+        annotation_filter_options : typing.Optional[AnnotationFilterOptions]
+
+        serialization_options : typing.Optional[SerializationOptions]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -683,21 +772,32 @@ class AsyncExportsClient:
 
         Examples
         --------
-        from label_studio_sdk import ExportCreate
         from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
         await client.projects.exports.create(
-            id=1,
-            request=ExportCreate(),
+            id_=1,
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/exports/",
+            f"api/projects/{jsonable_encoder(id_)}/exports/",
             method="POST",
-            json=request,
+            json={
+                "title": title,
+                "id": id,
+                "created_by": created_by,
+                "created_at": created_at,
+                "finished_at": finished_at,
+                "status": status,
+                "md5": md5,
+                "counters": counters,
+                "converted_formats": converted_formats,
+                "task_filter_options": task_filter_options,
+                "annotation_filter_options": annotation_filter_options,
+                "serialization_options": serialization_options,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -805,12 +905,7 @@ class AsyncExportsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def convert(
-        self,
-        id: int,
-        export_pk: str,
-        *,
-        request: ExportConvert,
-        request_options: typing.Optional[RequestOptions] = None,
+        self, id: int, export_pk: str, *, export_type: str, request_options: typing.Optional[RequestOptions] = None
     ) -> ExportConvert:
         """
         You can use this to convert an export snapshot into the selected format.
@@ -829,7 +924,8 @@ class AsyncExportsClient:
         export_pk : str
             Primary key identifying the export file.
 
-        request : ExportConvert
+        export_type : str
+            Export file format.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -841,7 +937,6 @@ class AsyncExportsClient:
 
         Examples
         --------
-        from label_studio_sdk import ExportConvert
         from label_studio_sdk.client import AsyncLabelStudio
 
         client = AsyncLabelStudio(
@@ -850,15 +945,13 @@ class AsyncExportsClient:
         await client.projects.exports.convert(
             id=1,
             export_pk="export_pk",
-            request=ExportConvert(
-                export_type="export_type",
-            ),
+            export_type="export_type",
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/exports/{jsonable_encoder(export_pk)}/convert",
             method="POST",
-            json=request,
+            json={"export_type": export_type},
             request_options=request_options,
             omit=OMIT,
         )

label_studio_sdk/prompts/__init__.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    PromptsBatchFailedPredictionsRequestFailedPredictionsItem,
+    PromptsBatchFailedPredictionsResponse,
+    PromptsBatchPredictionsRequestResultsItem,
+    PromptsBatchPredictionsResponse,
+)
+from . import indicators, runs, versions
+from .runs import RunsListRequestProjectSubset
+
+__all__ = [
+    "PromptsBatchFailedPredictionsRequestFailedPredictionsItem",
+    "PromptsBatchFailedPredictionsResponse",
+    "PromptsBatchPredictionsRequestResultsItem",
+    "PromptsBatchPredictionsResponse",
+    "RunsListRequestProjectSubset",
+    "indicators",
+    "runs",
+    "versions",
+]