client.py

# This file was auto-generated by Fern from our API Definition.

import typing

from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.request_options import RequestOptions
from ..types.annotator_create_response import AnnotatorCreateResponse
from ..types.annotator_response import AnnotatorResponse
from .raw_client import AsyncRawAnnotatorsClient, RawAnnotatorsClient

# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)


class AnnotatorsClient:
    def __init__(self, *, client_wrapper: SyncClientWrapper):
        self._raw_client = RawAnnotatorsClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> RawAnnotatorsClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        RawAnnotatorsClient
        """
        return self._raw_client

    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[AnnotatorResponse]:
        """
        List annotators with job counts and agreement stats

        Parameters
        ----------
        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        typing.List[AnnotatorResponse]
            Successful Response

        Examples
        --------
        from calibrate import Calibrate

        client = Calibrate(
            api_key="YOUR_API_KEY",
        )
        client.annotators.list()
        """
        _response = self._raw_client.list(request_options=request_options)
        return _response.data

    def create(self, *, name: str, request_options: typing.Optional[RequestOptions] = None) -> AnnotatorCreateResponse:
        """
        Create an annotator, a human labeller who can be assigned annotation tasks

        Parameters
        ----------
        name : str
            Annotator name, unique within your workspace

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        AnnotatorCreateResponse
            Successful Response

        Examples
        --------
        from calibrate import Calibrate

        client = Calibrate(
            api_key="YOUR_API_KEY",
        )
        client.annotators.create(
            name="name",
        )
        """
        _response = self._raw_client.create(name=name, request_options=request_options)
        return _response.data

    def update(
        self,
        annotator_uuid: str,
        *,
        name: typing.Optional[str] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> AnnotatorResponse:
        """
        Update an annotator's name

        Parameters
        ----------
        annotator_uuid : str
            Annotator to update

        name : typing.Optional[str]
            New annotator name, unique within your workspace. Omit to leave unchanged

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        AnnotatorResponse
            Successful Response

        Examples
        --------
        from calibrate import Calibrate

        client = Calibrate(
            api_key="YOUR_API_KEY",
        )
        client.annotators.update(
            annotator_uuid="f47ac10b-58cc-4372-a567-0e02b2c3d479",
        )
        """
        _response = self._raw_client.update(annotator_uuid, name=name, request_options=request_options)
        return _response.data


class AsyncAnnotatorsClient:
    def __init__(self, *, client_wrapper: AsyncClientWrapper):
        self._raw_client = AsyncRawAnnotatorsClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> AsyncRawAnnotatorsClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        AsyncRawAnnotatorsClient
        """
        return self._raw_client

    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[AnnotatorResponse]:
        """
        List annotators with job counts and agreement stats

        Parameters
        ----------
        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        typing.List[AnnotatorResponse]
            Successful Response

        Examples
        --------
        import asyncio

        from calibrate import AsyncCalibrate

        client = AsyncCalibrate(
            api_key="YOUR_API_KEY",
        )


        async def main() -> None:
            await client.annotators.list()


        asyncio.run(main())
        """
        _response = await self._raw_client.list(request_options=request_options)
        return _response.data

    async def create(
        self, *, name: str, request_options: typing.Optional[RequestOptions] = None
    ) -> AnnotatorCreateResponse:
        """
        Create an annotator, a human labeller who can be assigned annotation tasks

        Parameters
        ----------
        name : str
            Annotator name, unique within your workspace

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        AnnotatorCreateResponse
            Successful Response

        Examples
        --------
        import asyncio

        from calibrate import AsyncCalibrate

        client = AsyncCalibrate(
            api_key="YOUR_API_KEY",
        )


        async def main() -> None:
            await client.annotators.create(
                name="name",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.create(name=name, request_options=request_options)
        return _response.data

    async def update(
        self,
        annotator_uuid: str,
        *,
        name: typing.Optional[str] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> AnnotatorResponse:
        """
        Update an annotator's name

        Parameters
        ----------
        annotator_uuid : str
            Annotator to update

        name : typing.Optional[str]
            New annotator name, unique within your workspace. Omit to leave unchanged

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        AnnotatorResponse
            Successful Response

        Examples
        --------
        import asyncio

        from calibrate import AsyncCalibrate

        client = AsyncCalibrate(
            api_key="YOUR_API_KEY",
        )


        async def main() -> None:
            await client.annotators.update(
                annotator_uuid="f47ac10b-58cc-4372-a567-0e02b2c3d479",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.update(annotator_uuid, name=name, request_options=request_options)
        return _response.data