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

label_studio_sdk/model_providers/client.py

@@ -0,0 +1,708 @@
+# 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.request_options import RequestOptions
+from ..types.model_provider_connection import ModelProviderConnection
+from ..types.model_provider_connection_budget_reset_period import ModelProviderConnectionBudgetResetPeriod
+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 list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[ModelProviderConnection]:
+        """
+        Get all model provider connections created by the user in the current organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[ModelProviderConnection]
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.model_providers.list()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/model-provider-connections/", method="GET", request_options=request_options
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(typing.List[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)
+
+    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,
+        is_internal: typing.Optional[bool] = OMIT,
+        budget_limit: typing.Optional[float] = OMIT,
+        budget_last_reset_date: typing.Optional[dt.datetime] = OMIT,
+        budget_reset_period: typing.Optional[ModelProviderConnectionBudgetResetPeriod] = OMIT,
+        budget_total_spent: typing.Optional[float] = OMIT,
+        budget_alert_threshold: typing.Optional[float] = 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]
+
+        is_internal : typing.Optional[bool]
+            Whether the model provider connection is internal, not visible to the user.
+
+        budget_limit : typing.Optional[float]
+            Budget limit for the model provider connection (null if unlimited)
+
+        budget_last_reset_date : typing.Optional[dt.datetime]
+            Date and time the budget was last reset
+
+        budget_reset_period : typing.Optional[ModelProviderConnectionBudgetResetPeriod]
+            Budget reset period for the model provider connection (null if not reset)
+
+        budget_total_spent : typing.Optional[float]
+            Tracked total budget spent for the given provider connection within the current budget period
+
+        budget_alert_threshold : typing.Optional[float]
+            Budget alert threshold for the given provider connection
+
+        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,
+                "is_internal": is_internal,
+                "budget_limit": budget_limit,
+                "budget_last_reset_date": budget_last_reset_date,
+                "budget_reset_period": budget_reset_period,
+                "budget_total_spent": budget_total_spent,
+                "budget_alert_threshold": budget_alert_threshold,
+            },
+            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)
+
+    def get(self, pk: int, *, request_options: typing.Optional[RequestOptions] = None) -> ModelProviderConnection:
+        """
+        Get a model provider connection by ID.
+
+        Parameters
+        ----------
+        pk : int
+            Model Provider Connection ID
+
+        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.get(
+            pk=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/model-provider-connections/{jsonable_encoder(pk)}", method="GET", request_options=request_options
+        )
+        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)
+
+    def delete(self, pk: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Delete a model provider connection by ID.
+
+        Parameters
+        ----------
+        pk : int
+            Model Provider Connection ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.model_providers.delete(
+            pk=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/model-provider-connections/{jsonable_encoder(pk)}", method="DELETE", request_options=request_options
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _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 update(
+        self,
+        pk: int,
+        *,
+        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,
+        is_internal: typing.Optional[bool] = OMIT,
+        budget_limit: typing.Optional[float] = OMIT,
+        budget_last_reset_date: typing.Optional[dt.datetime] = OMIT,
+        budget_reset_period: typing.Optional[ModelProviderConnectionBudgetResetPeriod] = OMIT,
+        budget_total_spent: typing.Optional[float] = OMIT,
+        budget_alert_threshold: typing.Optional[float] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ModelProviderConnection:
+        """
+        Update a model provider connection by ID.
+
+        Parameters
+        ----------
+        pk : int
+            Model Provider Connection ID
+
+        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]
+
+        is_internal : typing.Optional[bool]
+            Whether the model provider connection is internal, not visible to the user.
+
+        budget_limit : typing.Optional[float]
+            Budget limit for the model provider connection (null if unlimited)
+
+        budget_last_reset_date : typing.Optional[dt.datetime]
+            Date and time the budget was last reset
+
+        budget_reset_period : typing.Optional[ModelProviderConnectionBudgetResetPeriod]
+            Budget reset period for the model provider connection (null if not reset)
+
+        budget_total_spent : typing.Optional[float]
+            Tracked total budget spent for the given provider connection within the current budget period
+
+        budget_alert_threshold : typing.Optional[float]
+            Budget alert threshold for the given provider connection
+
+        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.update(
+            pk=1,
+            provider="OpenAI",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/model-provider-connections/{jsonable_encoder(pk)}",
+            method="PATCH",
+            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,
+                "is_internal": is_internal,
+                "budget_limit": budget_limit,
+                "budget_last_reset_date": budget_last_reset_date,
+                "budget_reset_period": budget_reset_period,
+                "budget_total_spent": budget_total_spent,
+                "budget_alert_threshold": budget_alert_threshold,
+            },
+            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 list(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[ModelProviderConnection]:
+        """
+        Get all model provider connections created by the user in the current organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[ModelProviderConnection]
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.model_providers.list()
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/model-provider-connections/", method="GET", request_options=request_options
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(typing.List[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)
+
+    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,
+        is_internal: typing.Optional[bool] = OMIT,
+        budget_limit: typing.Optional[float] = OMIT,
+        budget_last_reset_date: typing.Optional[dt.datetime] = OMIT,
+        budget_reset_period: typing.Optional[ModelProviderConnectionBudgetResetPeriod] = OMIT,
+        budget_total_spent: typing.Optional[float] = OMIT,
+        budget_alert_threshold: typing.Optional[float] = 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]
+
+        is_internal : typing.Optional[bool]
+            Whether the model provider connection is internal, not visible to the user.
+
+        budget_limit : typing.Optional[float]
+            Budget limit for the model provider connection (null if unlimited)
+
+        budget_last_reset_date : typing.Optional[dt.datetime]
+            Date and time the budget was last reset
+
+        budget_reset_period : typing.Optional[ModelProviderConnectionBudgetResetPeriod]
+            Budget reset period for the model provider connection (null if not reset)
+
+        budget_total_spent : typing.Optional[float]
+            Tracked total budget spent for the given provider connection within the current budget period
+
+        budget_alert_threshold : typing.Optional[float]
+            Budget alert threshold for the given provider connection
+
+        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,
+                "is_internal": is_internal,
+                "budget_limit": budget_limit,
+                "budget_last_reset_date": budget_last_reset_date,
+                "budget_reset_period": budget_reset_period,
+                "budget_total_spent": budget_total_spent,
+                "budget_alert_threshold": budget_alert_threshold,
+            },
+            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)
+
+    async def get(self, pk: int, *, request_options: typing.Optional[RequestOptions] = None) -> ModelProviderConnection:
+        """
+        Get a model provider connection by ID.
+
+        Parameters
+        ----------
+        pk : int
+            Model Provider Connection ID
+
+        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.get(
+            pk=1,
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/model-provider-connections/{jsonable_encoder(pk)}", method="GET", request_options=request_options
+        )
+        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)
+
+    async def delete(self, pk: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Delete a model provider connection by ID.
+
+        Parameters
+        ----------
+        pk : int
+            Model Provider Connection ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.model_providers.delete(
+            pk=1,
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/model-provider-connections/{jsonable_encoder(pk)}", method="DELETE", request_options=request_options
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _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 update(
+        self,
+        pk: int,
+        *,
+        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,
+        is_internal: typing.Optional[bool] = OMIT,
+        budget_limit: typing.Optional[float] = OMIT,
+        budget_last_reset_date: typing.Optional[dt.datetime] = OMIT,
+        budget_reset_period: typing.Optional[ModelProviderConnectionBudgetResetPeriod] = OMIT,
+        budget_total_spent: typing.Optional[float] = OMIT,
+        budget_alert_threshold: typing.Optional[float] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ModelProviderConnection:
+        """
+        Update a model provider connection by ID.
+
+        Parameters
+        ----------
+        pk : int
+            Model Provider Connection ID
+
+        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]
+
+        is_internal : typing.Optional[bool]
+            Whether the model provider connection is internal, not visible to the user.
+
+        budget_limit : typing.Optional[float]
+            Budget limit for the model provider connection (null if unlimited)
+
+        budget_last_reset_date : typing.Optional[dt.datetime]
+            Date and time the budget was last reset
+
+        budget_reset_period : typing.Optional[ModelProviderConnectionBudgetResetPeriod]
+            Budget reset period for the model provider connection (null if not reset)
+
+        budget_total_spent : typing.Optional[float]
+            Tracked total budget spent for the given provider connection within the current budget period
+
+        budget_alert_threshold : typing.Optional[float]
+            Budget alert threshold for the given provider connection
+
+        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.update(
+            pk=1,
+            provider="OpenAI",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/model-provider-connections/{jsonable_encoder(pk)}",
+            method="PATCH",
+            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,
+                "is_internal": is_internal,
+                "budget_limit": budget_limit,
+                "budget_last_reset_date": budget_last_reset_date,
+                "budget_reset_period": budget_reset_period,
+                "budget_total_spent": budget_total_spent,
+                "budget_alert_threshold": budget_alert_threshold,
+            },
+            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)