# 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.pause import Pause
from ...types.reason_enum import ReasonEnum
from .raw_client import AsyncRawPausesClient, RawPausesClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class PausesClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawPausesClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawPausesClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawPausesClient
"""
return self._raw_client
def list(
self,
project_pk: int,
user_pk: int,
*,
include_deleted: typing.Optional[bool] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Pause]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a list of all pauses.
Parameters
----------
project_pk : int
user_pk : int
include_deleted : typing.Optional[bool]
Include deleted pauses.
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[Pause]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.pauses.list(
project_pk=1,
user_pk=1,
)
"""
_response = self._raw_client.list(
project_pk, user_pk, include_deleted=include_deleted, ordering=ordering, request_options=request_options
)
return _response.data
def create(
self,
project_pk: int,
user_pk: int,
*,
reason: ReasonEnum,
verbose_reason: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Pause:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new pause entry.
Parameters
----------
project_pk : int
user_pk : int
reason : ReasonEnum
Reason for pausing
* `MANUAL` - Manual
* `BEHAVIOR_BASED` - Behavior-based
* `ANNOTATOR_EVALUATION` - Annotator evaluation
* `ANNOTATION_LIMIT` - Annotation limit
* `CUSTOM_SCRIPT` - Custom script
verbose_reason : typing.Optional[str]
Detailed description of why the project is paused, will be readable by paused annotators
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Pause
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.pauses.create(
project_pk=1,
user_pk=1,
reason="MANUAL",
)
"""
_response = self._raw_client.create(
project_pk, user_pk, reason=reason, verbose_reason=verbose_reason, request_options=request_options
)
return _response.data
def get(
self, project_pk: int, user_pk: int, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Pause:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific pause by ID.
Parameters
----------
project_pk : int
user_pk : int
id : str
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Pause
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.pauses.get(
project_pk=1,
user_pk=1,
id="id",
)
"""
_response = self._raw_client.get(project_pk, user_pk, id, request_options=request_options)
return _response.data
def delete(
self, project_pk: int, user_pk: int, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific pause by ID.
Parameters
----------
project_pk : int
user_pk : int
id : 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.pauses.delete(
project_pk=1,
user_pk=1,
id="id",
)
"""
_response = self._raw_client.delete(project_pk, user_pk, id, request_options=request_options)
return _response.data
def update(
self,
project_pk: int,
user_pk: int,
id: str,
*,
reason: typing.Optional[ReasonEnum] = OMIT,
verbose_reason: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Pause:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Partially update a pause entry by ID.
Parameters
----------
project_pk : int
user_pk : int
id : str
reason : typing.Optional[ReasonEnum]
Reason for pausing
* `MANUAL` - Manual
* `BEHAVIOR_BASED` - Behavior-based
* `ANNOTATOR_EVALUATION` - Annotator evaluation
* `ANNOTATION_LIMIT` - Annotation limit
* `CUSTOM_SCRIPT` - Custom script
verbose_reason : typing.Optional[str]
Detailed description of why the project is paused, will be readable by paused annotators
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Pause
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.pauses.update(
project_pk=1,
user_pk=1,
id="id",
)
"""
_response = self._raw_client.update(
project_pk, user_pk, id, reason=reason, verbose_reason=verbose_reason, request_options=request_options
)
return _response.data
class AsyncPausesClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawPausesClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawPausesClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawPausesClient
"""
return self._raw_client
async def list(
self,
project_pk: int,
user_pk: int,
*,
include_deleted: typing.Optional[bool] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Pause]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a list of all pauses.
Parameters
----------
project_pk : int
user_pk : int
include_deleted : typing.Optional[bool]
Include deleted pauses.
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[Pause]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.pauses.list(
project_pk=1,
user_pk=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.list(
project_pk, user_pk, include_deleted=include_deleted, ordering=ordering, request_options=request_options
)
return _response.data
async def create(
self,
project_pk: int,
user_pk: int,
*,
reason: ReasonEnum,
verbose_reason: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Pause:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new pause entry.
Parameters
----------
project_pk : int
user_pk : int
reason : ReasonEnum
Reason for pausing
* `MANUAL` - Manual
* `BEHAVIOR_BASED` - Behavior-based
* `ANNOTATOR_EVALUATION` - Annotator evaluation
* `ANNOTATION_LIMIT` - Annotation limit
* `CUSTOM_SCRIPT` - Custom script
verbose_reason : typing.Optional[str]
Detailed description of why the project is paused, will be readable by paused annotators
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Pause
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.pauses.create(
project_pk=1,
user_pk=1,
reason="MANUAL",
)
asyncio.run(main())
"""
_response = await self._raw_client.create(
project_pk, user_pk, reason=reason, verbose_reason=verbose_reason, request_options=request_options
)
return _response.data
async def get(
self, project_pk: int, user_pk: int, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Pause:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific pause by ID.
Parameters
----------
project_pk : int
user_pk : int
id : str
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Pause
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.pauses.get(
project_pk=1,
user_pk=1,
id="id",
)
asyncio.run(main())
"""
_response = await self._raw_client.get(project_pk, user_pk, id, request_options=request_options)
return _response.data
async def delete(
self, project_pk: int, user_pk: int, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific pause by ID.
Parameters
----------
project_pk : int
user_pk : int
id : 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.pauses.delete(
project_pk=1,
user_pk=1,
id="id",
)
asyncio.run(main())
"""
_response = await self._raw_client.delete(project_pk, user_pk, id, request_options=request_options)
return _response.data
async def update(
self,
project_pk: int,
user_pk: int,
id: str,
*,
reason: typing.Optional[ReasonEnum] = OMIT,
verbose_reason: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Pause:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Partially update a pause entry by ID.
Parameters
----------
project_pk : int
user_pk : int
id : str
reason : typing.Optional[ReasonEnum]
Reason for pausing
* `MANUAL` - Manual
* `BEHAVIOR_BASED` - Behavior-based
* `ANNOTATOR_EVALUATION` - Annotator evaluation
* `ANNOTATION_LIMIT` - Annotation limit
* `CUSTOM_SCRIPT` - Custom script
verbose_reason : typing.Optional[str]
Detailed description of why the project is paused, will be readable by paused annotators
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Pause
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.pauses.update(
project_pk=1,
user_pk=1,
id="id",
)
asyncio.run(main())
"""
_response = await self._raw_client.update(
project_pk, user_pk, id, reason=reason, verbose_reason=verbose_reason, request_options=request_options
)
return _response.data