label-studio-sdk 2.0.3__py3-none-any.whl → 2.0.5__py3-none-any.whl

label_studio_sdk/projects/metrics/custom/client.py

@@ -0,0 +1,535 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ....core.client_wrapper import SyncClientWrapper
+from ....core.request_options import RequestOptions
+from .types.custom_get_lambda_response import CustomGetLambdaResponse
+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 ....errors.internal_server_error import InternalServerError
+from ....core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CustomClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_lambda(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CustomGetLambdaResponse:
+        """
+        Get the AWS Lambda code for the custom metric configured for this project.
+
+        Parameters
+        ----------
+        id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CustomGetLambdaResponse
+            Lambda code
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.metrics.custom.get_lambda(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/aws-custom-function",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    CustomGetLambdaResponse,
+                    construct_type(
+                        type_=CustomGetLambdaResponse,  # 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 update_lambda(
+        self,
+        id: int,
+        *,
+        code: str,
+        region: typing.Optional[str] = OMIT,
+        role: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Create or update the AWS Lambda function used for custom metrics in this project.
+
+        Parameters
+        ----------
+        id : int
+
+        code : str
+
+        region : typing.Optional[str]
+
+        role : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.metrics.custom.update_lambda(
+            id=1,
+            code="code",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/aws-custom-function",
+            method="POST",
+            json={
+                "code": code,
+                "region": region,
+                "role": role,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # 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 logs(
+        self,
+        id: int,
+        *,
+        end_date: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        start_date: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Dict[str, typing.Optional[typing.Any]]:
+        """
+        Get AWS lambda logs for project, including filtering by start and end dates
+
+        Parameters
+        ----------
+        id : int
+
+        end_date : typing.Optional[str]
+            End date for AWS logs filtering in format %Y-%m-%d
+
+        limit : typing.Optional[int]
+            Limit the number of logs to return
+
+        start_date : typing.Optional[str]
+            Start date for AWS logs filtering in format %Y-%m-%d
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, typing.Optional[typing.Any]]
+            Successful response returns list of AWS lambda logs
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.metrics.custom.logs(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/aws-custom-function-logs",
+            method="GET",
+            params={
+                "end_date": end_date,
+                "limit": limit,
+                "start_date": start_date,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.Dict[str, typing.Optional[typing.Any]],
+                    construct_type(
+                        type_=typing.Dict[str, typing.Optional[typing.Any]],  # 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 check_function(self, id: int, *, code: str, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Validate custom matching function code for the project.
+
+        Parameters
+        ----------
+        id : int
+
+        code : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.metrics.custom.check_function(
+            id=1,
+            code="code",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/check-function",
+            method="POST",
+            json={
+                "code": code,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        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)
+
+
+class AsyncCustomClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_lambda(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CustomGetLambdaResponse:
+        """
+        Get the AWS Lambda code for the custom metric configured for this project.
+
+        Parameters
+        ----------
+        id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CustomGetLambdaResponse
+            Lambda code
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.metrics.custom.get_lambda(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/aws-custom-function",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    CustomGetLambdaResponse,
+                    construct_type(
+                        type_=CustomGetLambdaResponse,  # 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 update_lambda(
+        self,
+        id: int,
+        *,
+        code: str,
+        region: typing.Optional[str] = OMIT,
+        role: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Create or update the AWS Lambda function used for custom metrics in this project.
+
+        Parameters
+        ----------
+        id : int
+
+        code : str
+
+        region : typing.Optional[str]
+
+        role : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.metrics.custom.update_lambda(
+                id=1,
+                code="code",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/aws-custom-function",
+            method="POST",
+            json={
+                "code": code,
+                "region": region,
+                "role": role,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # 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 logs(
+        self,
+        id: int,
+        *,
+        end_date: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        start_date: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Dict[str, typing.Optional[typing.Any]]:
+        """
+        Get AWS lambda logs for project, including filtering by start and end dates
+
+        Parameters
+        ----------
+        id : int
+
+        end_date : typing.Optional[str]
+            End date for AWS logs filtering in format %Y-%m-%d
+
+        limit : typing.Optional[int]
+            Limit the number of logs to return
+
+        start_date : typing.Optional[str]
+            Start date for AWS logs filtering in format %Y-%m-%d
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, typing.Optional[typing.Any]]
+            Successful response returns list of AWS lambda logs
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.metrics.custom.logs(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/aws-custom-function-logs",
+            method="GET",
+            params={
+                "end_date": end_date,
+                "limit": limit,
+                "start_date": start_date,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.Dict[str, typing.Optional[typing.Any]],
+                    construct_type(
+                        type_=typing.Dict[str, typing.Optional[typing.Any]],  # 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 check_function(
+        self, id: int, *, code: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Validate custom matching function code for the project.
+
+        Parameters
+        ----------
+        id : int
+
+        code : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.metrics.custom.check_function(
+                id=1,
+                code="code",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/check-function",
+            method="POST",
+            json={
+                "code": code,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        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)

label_studio_sdk/projects/metrics/custom/types/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .custom_get_lambda_response import CustomGetLambdaResponse
+
+__all__ = ["CustomGetLambdaResponse"]

label_studio_sdk/projects/metrics/custom/types/custom_get_lambda_response.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .....core.unchecked_base_model import UncheckedBaseModel
+from .....core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class CustomGetLambdaResponse(UncheckedBaseModel):
+    code: str
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/projects/stats/__init__.py

@@ -1,5 +1,21 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import StatsIaaResponse, StatsIaaResponseCommonTasks, StatsIaaResponseIaa, StatsIaaResponseStd
+from .types import (
+    StatsIaaResponse,
+    StatsIaaResponseCommonTasks,
+    StatsIaaResponseIaa,
+    StatsIaaResponseStd,
+    StatsTotalAgreementResponse,
+    StatsTotalAgreementResponseOne,
+    StatsTotalAgreementResponseZero,
+)
 
-__all__ = ["StatsIaaResponse", "StatsIaaResponseCommonTasks", "StatsIaaResponseIaa", "StatsIaaResponseStd"]
+__all__ = [
+    "StatsIaaResponse",
+    "StatsIaaResponseCommonTasks",
+    "StatsIaaResponseIaa",
+    "StatsIaaResponseStd",
+    "StatsTotalAgreementResponse",
+    "StatsTotalAgreementResponseOne",
+    "StatsTotalAgreementResponseZero",
+]