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

label_studio_sdk/prompts/versions/client.py

@@ -1,19 +1,21 @@
 # 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.jsonable_encoder import jsonable_encoder
-from ...core.pydantic_utilities import pydantic_v1
+from ...core.client_wrapper import SyncClientWrapper
 from ...core.request_options import RequestOptions
 from ...types.prompt_version import PromptVersion
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
+from ...types.prompt_version_provider import PromptVersionProvider
 from ...types.prompt_version_created_by import PromptVersionCreatedBy
+import datetime as dt
 from ...types.prompt_version_organization import PromptVersionOrganization
-from ...types.prompt_version_provider import PromptVersionProvider
+from ...core.serialization import convert_and_respect_annotation_metadata
+from ...types.inference_run_cost_estimate import InferenceRunCostEstimate
 from ...types.refined_prompt_response import RefinedPromptResponse
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -42,7 +44,7 @@ class VersionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -52,11 +54,19 @@ class VersionsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/prompts/{jsonable_encoder(id)}/versions", method="GET", request_options=request_options
+            f"api/prompts/{jsonable_encoder(id)}/versions",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[PromptVersion], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[PromptVersion],
+                    parse_obj_as(
+                        type_=typing.List[PromptVersion],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -116,7 +126,7 @@ class VersionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -135,17 +145,27 @@ class VersionsClient:
                 "prompt": prompt,
                 "provider": provider,
                 "provider_model_id": provider_model_id,
-                "created_by": created_by,
+                "created_by": convert_and_respect_annotation_metadata(
+                    object_=created_by, annotation=PromptVersionCreatedBy, direction="write"
+                ),
                 "created_at": created_at,
                 "updated_at": updated_at,
-                "organization": organization,
+                "organization": convert_and_respect_annotation_metadata(
+                    object_=organization, annotation=PromptVersionOrganization, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PromptVersion, _response.json())  # type: ignore
+                return typing.cast(
+                    PromptVersion,
+                    parse_obj_as(
+                        type_=PromptVersion,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -175,7 +195,7 @@ class VersionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -192,7 +212,13 @@ class VersionsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PromptVersion, _response.json())  # type: ignore
+                return typing.cast(
+                    PromptVersion,
+                    parse_obj_as(
+                        type_=PromptVersion,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -219,7 +245,7 @@ class VersionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -300,7 +326,7 @@ class VersionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -320,17 +346,98 @@ class VersionsClient:
                 "prompt": prompt,
                 "provider": provider,
                 "provider_model_id": provider_model_id,
-                "created_by": created_by,
+                "created_by": convert_and_respect_annotation_metadata(
+                    object_=created_by, annotation=PromptVersionCreatedBy, direction="write"
+                ),
                 "created_at": created_at,
                 "updated_at": updated_at,
-                "organization": organization,
+                "organization": convert_and_respect_annotation_metadata(
+                    object_=organization, annotation=PromptVersionOrganization, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PromptVersion, _response.json())  # type: ignore
+                return typing.cast(
+                    PromptVersion,
+                    parse_obj_as(
+                        type_=PromptVersion,  # 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 cost_estimate(
+        self,
+        prompt_id: int,
+        version_id: int,
+        *,
+        project_id: int,
+        project_subset: int,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InferenceRunCostEstimate:
+        """
+        Get cost estimate for running a prompt version on a particular project/subset
+
+        Parameters
+        ----------
+        prompt_id : int
+            Prompt ID
+
+        version_id : int
+            Prompt Version ID
+
+        project_id : int
+            ID of the project to get an estimate for running on
+
+        project_subset : int
+            Subset of the project to get an estimate for running on (e.g. 'All', 'Sample', or 'HasGT')
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InferenceRunCostEstimate
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.versions.cost_estimate(
+            prompt_id=1,
+            version_id=1,
+            project_id=1,
+            project_subset=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/cost-estimate",
+            method="POST",
+            params={
+                "project_id": project_id,
+                "project_subset": project_subset,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    InferenceRunCostEstimate,
+                    parse_obj_as(
+                        type_=InferenceRunCostEstimate,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -368,7 +475,7 @@ class VersionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -382,12 +489,20 @@ class VersionsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/refine",
             method="GET",
-            params={"refinement_job_id": refinement_job_id},
+            params={
+                "refinement_job_id": refinement_job_id,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RefinedPromptResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    RefinedPromptResponse,
+                    parse_obj_as(
+                        type_=RefinedPromptResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -437,7 +552,7 @@ class VersionsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -450,18 +565,29 @@ class VersionsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/refine",
             method="POST",
-            params={"async": async_},
+            params={
+                "async": async_,
+            },
             json={
                 "teacher_model_provider_connection_id": teacher_model_provider_connection_id,
                 "teacher_model_name": teacher_model_name,
                 "project_id": project_id,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RefinedPromptResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    RefinedPromptResponse,
+                    parse_obj_as(
+                        type_=RefinedPromptResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -493,21 +619,37 @@ class AsyncVersionsClient:
 
         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.prompts.versions.list(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.prompts.versions.list(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/prompts/{jsonable_encoder(id)}/versions", method="GET", request_options=request_options
+            f"api/prompts/{jsonable_encoder(id)}/versions",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[PromptVersion], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[PromptVersion],
+                    parse_obj_as(
+                        type_=typing.List[PromptVersion],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -567,14 +709,22 @@ class AsyncVersionsClient:
 
         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.prompts.versions.create(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.prompts.versions.create(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(id)}/versions",
@@ -586,17 +736,27 @@ class AsyncVersionsClient:
                 "prompt": prompt,
                 "provider": provider,
                 "provider_model_id": provider_model_id,
-                "created_by": created_by,
+                "created_by": convert_and_respect_annotation_metadata(
+                    object_=created_by, annotation=PromptVersionCreatedBy, direction="write"
+                ),
                 "created_at": created_at,
                 "updated_at": updated_at,
-                "organization": organization,
+                "organization": convert_and_respect_annotation_metadata(
+                    object_=organization, annotation=PromptVersionOrganization, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PromptVersion, _response.json())  # type: ignore
+                return typing.cast(
+                    PromptVersion,
+                    parse_obj_as(
+                        type_=PromptVersion,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -626,15 +786,23 @@ class AsyncVersionsClient:
 
         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.prompts.versions.get(
-            id=1,
-            version_id=1,
-        )
+
+
+        async def main() -> None:
+            await client.prompts.versions.get(
+                id=1,
+                version_id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}",
@@ -643,7 +811,13 @@ class AsyncVersionsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PromptVersion, _response.json())  # type: ignore
+                return typing.cast(
+                    PromptVersion,
+                    parse_obj_as(
+                        type_=PromptVersion,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -672,15 +846,23 @@ class AsyncVersionsClient:
 
         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.prompts.versions.delete(
-            id=1,
-            version_id=1,
-        )
+
+
+        async def main() -> None:
+            await client.prompts.versions.delete(
+                id=1,
+                version_id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}",
@@ -753,15 +935,23 @@ class AsyncVersionsClient:
 
         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.prompts.versions.update(
-            id=1,
-            version_id=1,
-        )
+
+
+        async def main() -> None:
+            await client.prompts.versions.update(
+                id=1,
+                version_id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}",
@@ -773,17 +963,106 @@ class AsyncVersionsClient:
                 "prompt": prompt,
                 "provider": provider,
                 "provider_model_id": provider_model_id,
-                "created_by": created_by,
+                "created_by": convert_and_respect_annotation_metadata(
+                    object_=created_by, annotation=PromptVersionCreatedBy, direction="write"
+                ),
                 "created_at": created_at,
                 "updated_at": updated_at,
-                "organization": organization,
+                "organization": convert_and_respect_annotation_metadata(
+                    object_=organization, annotation=PromptVersionOrganization, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PromptVersion, _response.json())  # type: ignore
+                return typing.cast(
+                    PromptVersion,
+                    parse_obj_as(
+                        type_=PromptVersion,  # 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 cost_estimate(
+        self,
+        prompt_id: int,
+        version_id: int,
+        *,
+        project_id: int,
+        project_subset: int,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InferenceRunCostEstimate:
+        """
+        Get cost estimate for running a prompt version on a particular project/subset
+
+        Parameters
+        ----------
+        prompt_id : int
+            Prompt ID
+
+        version_id : int
+            Prompt Version ID
+
+        project_id : int
+            ID of the project to get an estimate for running on
+
+        project_subset : int
+            Subset of the project to get an estimate for running on (e.g. 'All', 'Sample', or 'HasGT')
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InferenceRunCostEstimate
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.prompts.versions.cost_estimate(
+                prompt_id=1,
+                version_id=1,
+                project_id=1,
+                project_subset=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/cost-estimate",
+            method="POST",
+            params={
+                "project_id": project_id,
+                "project_subset": project_subset,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    InferenceRunCostEstimate,
+                    parse_obj_as(
+                        type_=InferenceRunCostEstimate,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -821,26 +1100,42 @@ class AsyncVersionsClient:
 
         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.prompts.versions.get_refined_prompt(
-            prompt_id=1,
-            version_id=1,
-            refinement_job_id="refinement_job_id",
-        )
+
+
+        async def main() -> None:
+            await client.prompts.versions.get_refined_prompt(
+                prompt_id=1,
+                version_id=1,
+                refinement_job_id="refinement_job_id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/refine",
             method="GET",
-            params={"refinement_job_id": refinement_job_id},
+            params={
+                "refinement_job_id": refinement_job_id,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RefinedPromptResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    RefinedPromptResponse,
+                    parse_obj_as(
+                        type_=RefinedPromptResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -890,31 +1185,50 @@ class AsyncVersionsClient:
 
         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.prompts.versions.refine_prompt(
-            prompt_id=1,
-            version_id=1,
-        )
+
+
+        async def main() -> None:
+            await client.prompts.versions.refine_prompt(
+                prompt_id=1,
+                version_id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/refine",
             method="POST",
-            params={"async": async_},
+            params={
+                "async": async_,
+            },
             json={
                 "teacher_model_provider_connection_id": teacher_model_provider_connection_id,
                 "teacher_model_name": teacher_model_name,
                 "project_id": project_id,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(RefinedPromptResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    RefinedPromptResponse,
+                    parse_obj_as(
+                        type_=RefinedPromptResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)