]jJ d dl Z ddlmZmZ ddlmZ ddlmZ ddlm Z ddl
m Z m Z e j e j d Z G d
d Z G d d
Zy) N )AsyncClientWrapperSyncClientWrapper)RequestOptions)Pause)
ReasonEnum )AsyncRawPausesClientRawPausesClient.c e Zd ZdefdZedefd Zdddddeded e j e d
e j e d e j e
de j e f d Zedd
dededede j e d e j e
def dZdddedede d e j e
def
dZdddedede d e j e
ddf
dZeedddedede de j e de j e d e j e
defdZy) PausesClientclient_wrapperc & t | | _ y N)r )r _raw_clientselfr s Q/root/env/lib/python3.12/site-packages/label_studio_sdk/projects/pauses/client.py__init__zPausesClient.__init__ s *.I returnc | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawPausesClient
r r s r with_raw_responsez PausesClient.with_raw_response r Ninclude_deletedorderingrequest_options
project_pkuser_pkr r r c Z | j j ||||| }|j S )a
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,
)
r r listdatar r! r" r r r _responses r r% zPausesClient.list s8 d $$)) 8et *
~~ r verbose_reasonr reasonr* c Z | j j ||||| }|j S )a
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",
)
r+ r* r r creater& r r! r" r+ r* r r( s r r/ zPausesClient.createU s8 r $$++ ~_n ,
~~ r r idc X | j j |||| }|j S )aC
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",
)
r1 r getr& r r! r" r2 r r( s r r5 zPausesClient.get s/ R $$((WbRa(b ~~ r c X | j j |||| }|j S )aB
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",
)
r1 r deleter& r6 s r r9 zPausesClient.delete s/ P $$++JUd+e ~~ r r- c \ | j j |||||| }|j S )a
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",
)
r- r updater& r r! r" r2 r+ r* r r( s r r< zPausesClient.update s: x $$++ F>cr ,
~~ r )__name__
__module__ __qualname__r r propertyr r inttypingOptionalboolstrr Listr r% OMITr r/ r5 r9 r< r r r
r
s J*; J ? 26)-;?5 5 5
. 5 //#&
5 85
U 5 z 04;?< < <
< ,
< 8<
< ~ mq* * (+* 14* JP//ZhJi* * Z mq) ) (+) 14) JP//ZhJi)
) b /3/3;?? ? ?
?
+
? ,? 8?
? r r
c e Zd ZdefdZedefd Zdddddeded e j e d
e j e d e j e
de j e f d Zedd
dededede j e d e j e
def dZdddedede d e j e
def
dZdddedede d e j e
ddf
dZeedddedede de j e de j e d e j e
defdZy)AsyncPausesClientr c & t | | _ y r )r
r r s r r zAsyncPausesClient.__init__- s /~Nr r c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawPausesClient
r r s r r z#AsyncPausesClient.with_raw_response0 r r Nr r! r" r r r c v K | j j ||||| d{ }|j S 7 w)aZ
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())
r Nr$ r' s r r% zAsyncPausesClient.list; sF t **// 8et 0
~~
$979r) r+ r* c v K | j j ||||| d{ }|j S 7 w)ar
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())
r- Nr. r0 s r r/ zAsyncPausesClient.createz sF B **11 ~_n 2
~~
rO r1 r2 c t K | j j |||| d{ }|j S 7 w)a
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())
r1 Nr4 r6 s r r5 zAsyncPausesClient.get s< b **..z7BXg.hh ~~ i #868c t K | j j |||| d{ }|j S 7 w)a
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())
r1 Nr8 r6 s r r9 zAsyncPausesClient.delete s< ` **11*gr[j1kk ~~ lrR r- c x K | j j |||||| d{ }|j S 7 w)a
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())
r- Nr; r= s r r< zAsyncPausesClient.update' sH H **11 F>cr 2
~~
s %:8:)r> r? r@ r r rA r
r rB rC rD rE rF r rG r r% rH r r/ r5 r9 r< rI r r rK rK , s O*< O #7 26)-;?= = =
. = //#&
= 8=
U = J 04;?D D D
D ,
D 8D
D N mq2 2 (+2 142 JP//ZhJi2 2 j mq1 1 (+1 141 JP//ZhJi1
1 r /3/3;?G G G
G
+
G ,G 8G
G r rK )rC core.client_wrapperr r core.request_optionsr types.pauser types.reason_enumr
raw_clientr
r castAnyrH r
rK rI r r r\ sJ H 2 + = v{{6::s#Z Z zB B r