label-studio-sdk 2.0.1__py3-none-any.whl → 2.0.2__py3-none-any.whl

label_studio_sdk/prompts/runs/client.py

@@ -9,8 +9,8 @@ from ...core.jsonable_encoder import jsonable_encoder
 from ...core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
-from ...types.project_subset_enum import ProjectSubsetEnum
 import datetime as dt
+from ...types.project_subset_enum import ProjectSubsetEnum
 from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -104,13 +104,13 @@ class RunsClient:
         version_id: int,
         *,
         project: int,
-        project_subset: typing.Optional[ProjectSubsetEnum] = OMIT,
         job_id: typing.Optional[str] = OMIT,
-        total_predictions: typing.Optional[int] = OMIT,
+        organization: typing.Optional[int] = OMIT,
+        predictions_updated_at: typing.Optional[dt.datetime] = OMIT,
+        project_subset: typing.Optional[ProjectSubsetEnum] = OMIT,
         total_correct_predictions: typing.Optional[int] = OMIT,
+        total_predictions: typing.Optional[int] = OMIT,
         total_tasks: typing.Optional[int] = OMIT,
-        predictions_updated_at: typing.Optional[dt.datetime] = OMIT,
-        organization: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ModelRun:
         """
@@ -124,20 +124,20 @@ class RunsClient:
 
         project : int
 
-        project_subset : typing.Optional[ProjectSubsetEnum]
-
         job_id : typing.Optional[str]
             Job ID for inference job for a ModelRun e.g. Adala job ID
 
-        total_predictions : typing.Optional[int]
+        organization : typing.Optional[int]
 
-        total_correct_predictions : typing.Optional[int]
+        predictions_updated_at : typing.Optional[dt.datetime]
 
-        total_tasks : typing.Optional[int]
+        project_subset : typing.Optional[ProjectSubsetEnum]
 
-        predictions_updated_at : typing.Optional[dt.datetime]
+        total_correct_predictions : typing.Optional[int]
 
-        organization : typing.Optional[int]
+        total_predictions : typing.Optional[int]
+
+        total_tasks : typing.Optional[int]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -164,14 +164,14 @@ class RunsClient:
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/inference-runs",
             method="POST",
             json={
-                "project_subset": project_subset,
                 "job_id": job_id,
-                "total_predictions": total_predictions,
-                "total_correct_predictions": total_correct_predictions,
-                "total_tasks": total_tasks,
-                "predictions_updated_at": predictions_updated_at,
                 "organization": organization,
+                "predictions_updated_at": predictions_updated_at,
                 "project": project,
+                "project_subset": project_subset,
+                "total_correct_predictions": total_correct_predictions,
+                "total_predictions": total_predictions,
+                "total_tasks": total_tasks,
             },
             headers={
                 "content-type": "application/json",
@@ -289,13 +289,13 @@ class AsyncRunsClient:
         version_id: int,
         *,
         project: int,
-        project_subset: typing.Optional[ProjectSubsetEnum] = OMIT,
         job_id: typing.Optional[str] = OMIT,
-        total_predictions: typing.Optional[int] = OMIT,
+        organization: typing.Optional[int] = OMIT,
+        predictions_updated_at: typing.Optional[dt.datetime] = OMIT,
+        project_subset: typing.Optional[ProjectSubsetEnum] = OMIT,
         total_correct_predictions: typing.Optional[int] = OMIT,
+        total_predictions: typing.Optional[int] = OMIT,
         total_tasks: typing.Optional[int] = OMIT,
-        predictions_updated_at: typing.Optional[dt.datetime] = OMIT,
-        organization: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ModelRun:
         """
@@ -309,20 +309,20 @@ class AsyncRunsClient:
 
         project : int
 
-        project_subset : typing.Optional[ProjectSubsetEnum]
-
         job_id : typing.Optional[str]
             Job ID for inference job for a ModelRun e.g. Adala job ID
 
-        total_predictions : typing.Optional[int]
+        organization : typing.Optional[int]
 
-        total_correct_predictions : typing.Optional[int]
+        predictions_updated_at : typing.Optional[dt.datetime]
 
-        total_tasks : typing.Optional[int]
+        project_subset : typing.Optional[ProjectSubsetEnum]
 
-        predictions_updated_at : typing.Optional[dt.datetime]
+        total_correct_predictions : typing.Optional[int]
 
-        organization : typing.Optional[int]
+        total_predictions : typing.Optional[int]
+
+        total_tasks : typing.Optional[int]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -357,14 +357,14 @@ class AsyncRunsClient:
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/inference-runs",
             method="POST",
             json={
-                "project_subset": project_subset,
                 "job_id": job_id,
-                "total_predictions": total_predictions,
-                "total_correct_predictions": total_correct_predictions,
-                "total_tasks": total_tasks,
-                "predictions_updated_at": predictions_updated_at,
                 "organization": organization,
+                "predictions_updated_at": predictions_updated_at,
                 "project": project,
+                "project_subset": project_subset,
+                "total_correct_predictions": total_correct_predictions,
+                "total_predictions": total_predictions,
+                "total_tasks": total_tasks,
             },
             headers={
                 "content-type": "application/json",

label_studio_sdk/prompts/versions/client.py

@@ -128,13 +128,13 @@ class VersionsClient:
         self,
         prompt_id: int,
         *,
-        title: str,
         prompt: str,
         provider_model_id: str,
-        parent_model: typing.Optional[int] = OMIT,
-        provider: typing.Optional[ProviderEnum] = OMIT,
+        title: str,
         model_provider_connection: typing.Optional[int] = OMIT,
         organization: typing.Optional[int] = OMIT,
+        parent_model: typing.Optional[int] = OMIT,
+        provider: typing.Optional[ProviderEnum] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ThirdPartyModelVersion:
         """
@@ -144,15 +144,19 @@ class VersionsClient:
         ----------
         prompt_id : int
 
-        title : str
-            Model name
-
         prompt : str
             Prompt to execute
 
         provider_model_id : str
             The model ID to use within the given provider, e.g. gpt-3.5
 
+        title : str
+            Model name
+
+        model_provider_connection : typing.Optional[int]
+
+        organization : typing.Optional[int]
+
         parent_model : typing.Optional[int]
             Parent model interface ID
 
@@ -167,10 +171,6 @@ class VersionsClient:
             * `Anthropic` - Anthropic
             * `Custom` - Custom
 
-        model_provider_connection : typing.Optional[int]
-
-        organization : typing.Optional[int]
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -188,22 +188,22 @@ class VersionsClient:
         )
         client.prompts.versions.create(
             prompt_id=1,
-            title="title",
             prompt="prompt",
             provider_model_id="provider_model_id",
+            title="title",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions",
             method="POST",
             json={
+                "model_provider_connection": model_provider_connection,
+                "organization": organization,
                 "parent_model": parent_model,
-                "title": title,
                 "prompt": prompt,
                 "provider": provider,
                 "provider_model_id": provider_model_id,
-                "model_provider_connection": model_provider_connection,
-                "organization": organization,
+                "title": title,
             },
             request_options=request_options,
             omit=OMIT,
@@ -322,13 +322,13 @@ class VersionsClient:
         prompt_id: int,
         version_id: int,
         *,
+        model_provider_connection: typing.Optional[int] = OMIT,
+        organization: typing.Optional[int] = OMIT,
         parent_model: typing.Optional[int] = OMIT,
-        title: typing.Optional[str] = OMIT,
         prompt: typing.Optional[str] = OMIT,
         provider: typing.Optional[ProviderEnum] = OMIT,
         provider_model_id: typing.Optional[str] = OMIT,
-        model_provider_connection: typing.Optional[int] = OMIT,
-        organization: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ThirdPartyModelVersion:
         """
@@ -340,12 +340,13 @@ class VersionsClient:
 
         version_id : int
 
+        model_provider_connection : typing.Optional[int]
+
+        organization : typing.Optional[int]
+
         parent_model : typing.Optional[int]
             Parent model interface ID
 
-        title : typing.Optional[str]
-            Model name
-
         prompt : typing.Optional[str]
             Prompt to execute
 
@@ -363,9 +364,8 @@ class VersionsClient:
         provider_model_id : typing.Optional[str]
             The model ID to use within the given provider, e.g. gpt-3.5
 
-        model_provider_connection : typing.Optional[int]
-
-        organization : typing.Optional[int]
+        title : typing.Optional[str]
+            Model name
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -391,13 +391,13 @@ class VersionsClient:
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}",
             method="PATCH",
             json={
+                "model_provider_connection": model_provider_connection,
+                "organization": organization,
                 "parent_model": parent_model,
-                "title": title,
                 "prompt": prompt,
                 "provider": provider,
                 "provider_model_id": provider_model_id,
-                "model_provider_connection": model_provider_connection,
-                "organization": organization,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -537,9 +537,9 @@ class VersionsClient:
         prompt_id: int,
         version_id: int,
         *,
-        teacher_model_provider_connection_id: int,
-        teacher_model_name: str,
         project_id: int,
+        teacher_model_name: str,
+        teacher_model_provider_connection_id: int,
         async_: typing.Optional[bool] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RefinedPromptResponse:
@@ -552,14 +552,14 @@ class VersionsClient:
 
         version_id : int
 
-        teacher_model_provider_connection_id : int
-            Model Provider Connection ID to use to refine the prompt
+        project_id : int
+            Project ID to target the refined prompt for
 
         teacher_model_name : str
             Name of the model to use to refine the prompt
 
-        project_id : int
-            Project ID to target the refined prompt for
+        teacher_model_provider_connection_id : int
+            Model Provider Connection ID to use to refine the prompt
 
         async_ : typing.Optional[bool]
             Whether to run the refinement asynchronously
@@ -582,9 +582,9 @@ class VersionsClient:
         client.prompts.versions.refine_prompt(
             prompt_id=1,
             version_id=1,
-            teacher_model_provider_connection_id=1,
-            teacher_model_name="teacher_model_name",
             project_id=1,
+            teacher_model_name="teacher_model_name",
+            teacher_model_provider_connection_id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -594,9 +594,9 @@ class VersionsClient:
                 "async": async_,
             },
             json={
-                "teacher_model_provider_connection_id": teacher_model_provider_connection_id,
-                "teacher_model_name": teacher_model_name,
                 "project_id": project_id,
+                "teacher_model_name": teacher_model_name,
+                "teacher_model_provider_connection_id": teacher_model_provider_connection_id,
             },
             headers={
                 "content-type": "application/json",
@@ -748,13 +748,13 @@ class AsyncVersionsClient:
         self,
         prompt_id: int,
         *,
-        title: str,
         prompt: str,
         provider_model_id: str,
-        parent_model: typing.Optional[int] = OMIT,
-        provider: typing.Optional[ProviderEnum] = OMIT,
+        title: str,
         model_provider_connection: typing.Optional[int] = OMIT,
         organization: typing.Optional[int] = OMIT,
+        parent_model: typing.Optional[int] = OMIT,
+        provider: typing.Optional[ProviderEnum] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ThirdPartyModelVersion:
         """
@@ -764,15 +764,19 @@ class AsyncVersionsClient:
         ----------
         prompt_id : int
 
-        title : str
-            Model name
-
         prompt : str
             Prompt to execute
 
         provider_model_id : str
             The model ID to use within the given provider, e.g. gpt-3.5
 
+        title : str
+            Model name
+
+        model_provider_connection : typing.Optional[int]
+
+        organization : typing.Optional[int]
+
         parent_model : typing.Optional[int]
             Parent model interface ID
 
@@ -787,10 +791,6 @@ class AsyncVersionsClient:
             * `Anthropic` - Anthropic
             * `Custom` - Custom
 
-        model_provider_connection : typing.Optional[int]
-
-        organization : typing.Optional[int]
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -813,9 +813,9 @@ class AsyncVersionsClient:
         async def main() -> None:
             await client.prompts.versions.create(
                 prompt_id=1,
-                title="title",
                 prompt="prompt",
                 provider_model_id="provider_model_id",
+                title="title",
             )
 
 
@@ -825,13 +825,13 @@ class AsyncVersionsClient:
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions",
             method="POST",
             json={
+                "model_provider_connection": model_provider_connection,
+                "organization": organization,
                 "parent_model": parent_model,
-                "title": title,
                 "prompt": prompt,
                 "provider": provider,
                 "provider_model_id": provider_model_id,
-                "model_provider_connection": model_provider_connection,
-                "organization": organization,
+                "title": title,
             },
             request_options=request_options,
             omit=OMIT,
@@ -966,13 +966,13 @@ class AsyncVersionsClient:
         prompt_id: int,
         version_id: int,
         *,
+        model_provider_connection: typing.Optional[int] = OMIT,
+        organization: typing.Optional[int] = OMIT,
         parent_model: typing.Optional[int] = OMIT,
-        title: typing.Optional[str] = OMIT,
         prompt: typing.Optional[str] = OMIT,
         provider: typing.Optional[ProviderEnum] = OMIT,
         provider_model_id: typing.Optional[str] = OMIT,
-        model_provider_connection: typing.Optional[int] = OMIT,
-        organization: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ThirdPartyModelVersion:
         """
@@ -984,12 +984,13 @@ class AsyncVersionsClient:
 
         version_id : int
 
+        model_provider_connection : typing.Optional[int]
+
+        organization : typing.Optional[int]
+
         parent_model : typing.Optional[int]
             Parent model interface ID
 
-        title : typing.Optional[str]
-            Model name
-
         prompt : typing.Optional[str]
             Prompt to execute
 
@@ -1007,9 +1008,8 @@ class AsyncVersionsClient:
         provider_model_id : typing.Optional[str]
             The model ID to use within the given provider, e.g. gpt-3.5
 
-        model_provider_connection : typing.Optional[int]
-
-        organization : typing.Optional[int]
+        title : typing.Optional[str]
+            Model name
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1043,13 +1043,13 @@ class AsyncVersionsClient:
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}",
             method="PATCH",
             json={
+                "model_provider_connection": model_provider_connection,
+                "organization": organization,
                 "parent_model": parent_model,
-                "title": title,
                 "prompt": prompt,
                 "provider": provider,
                 "provider_model_id": provider_model_id,
-                "model_provider_connection": model_provider_connection,
-                "organization": organization,
+                "title": title,
             },
             headers={
                 "content-type": "application/json",
@@ -1205,9 +1205,9 @@ class AsyncVersionsClient:
         prompt_id: int,
         version_id: int,
         *,
-        teacher_model_provider_connection_id: int,
-        teacher_model_name: str,
         project_id: int,
+        teacher_model_name: str,
+        teacher_model_provider_connection_id: int,
         async_: typing.Optional[bool] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RefinedPromptResponse:
@@ -1220,14 +1220,14 @@ class AsyncVersionsClient:
 
         version_id : int
 
-        teacher_model_provider_connection_id : int
-            Model Provider Connection ID to use to refine the prompt
+        project_id : int
+            Project ID to target the refined prompt for
 
         teacher_model_name : str
             Name of the model to use to refine the prompt
 
-        project_id : int
-            Project ID to target the refined prompt for
+        teacher_model_provider_connection_id : int
+            Model Provider Connection ID to use to refine the prompt
 
         async_ : typing.Optional[bool]
             Whether to run the refinement asynchronously
@@ -1255,9 +1255,9 @@ class AsyncVersionsClient:
             await client.prompts.versions.refine_prompt(
                 prompt_id=1,
                 version_id=1,
-                teacher_model_provider_connection_id=1,
-                teacher_model_name="teacher_model_name",
                 project_id=1,
+                teacher_model_name="teacher_model_name",
+                teacher_model_provider_connection_id=1,
             )
 
 
@@ -1270,9 +1270,9 @@ class AsyncVersionsClient:
                 "async": async_,
             },
             json={
-                "teacher_model_provider_connection_id": teacher_model_provider_connection_id,
-                "teacher_model_name": teacher_model_name,
                 "project_id": project_id,
+                "teacher_model_name": teacher_model_name,
+                "teacher_model_provider_connection_id": teacher_model_provider_connection_id,
             },
             headers={
                 "content-type": "application/json",