]j d dl Zd dlZddlmZmZ ddlmZ ddlm Z ddl
m Z ddl m
Z
ddlmZ d d
lmZmZ d d lmZ d d lmZ ej. ej0 d
Z G d d Z G d d Zy) N )AsyncClientWrapperSyncClientWrapper)RequestOptions)Hotkeys)LseUser)
LseUserApi)
WhoAmIUser )AsyncRawUsersClientRawUsersClient)GetTokenUsersResponse)ResetTokenUsersResponse.c e Zd ZdefdZedefd Zdddej e
de fdZ e
e
e
e
e
e
e
e
e
e
e
e
dd
d
ej e d ej e d ej ej d
ej ej$ dej ej dej e dej e dej e dej e dej e dej e dej e dej e
de f dZdddej e
defdZe
ddd ej ej. eej f dej e
defdZdddej e
defdZdddej e
defdZ dddej e
de fd Z ddd d ej e dej e
dej> e fd Z e
e
e
e
e
e
e
e
e
dd
d ej e d!ej e d"ej e dej e d#ej e d$ej e dej e dej e dej e dej e
de!fd%Z"ddd#edej e
de!fd&Z#ddd#edej e
ddfd'Z$e
e
e
e
e
e
e
e
e
dd(
d#ed ej e d!ej e d"ej e dej e d)ej e d$ej e dej e dej e dej e dej e
de!fd*Z%y)+ UsersClientclient_wrapperc & t | | _ y N)r )r
_raw_clientselfr s G/root/env/lib/python3.12/site-packages/label_studio_sdk/users/client.py__init__zUsersClient.__init__ s ) H returnc | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawUsersClient
r r s r with_raw_responsez UsersClient.with_raw_response r Nrequest_optionsr" c R | 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)
Get info about the currently authenticated user.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUserApi
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.get_current_user()
r! r get_current_userdatar r" _responses r r% z UsersClient.get_current_user# s' : $$55o5V ~~ r
active_organizationallow_newsletterscustom_hotkeys date_joinedemail_notification_settings
first_nameis_email_verified last_nameonboarding_statepasswordphoneusernamer" r* r+ r, r- r. r/ r0 r1 r2 r3 r4 r5 c
j | 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)
Update details for the currently authenticated user.
Parameters
----------
active_organization : typing.Optional[int]
allow_newsletters : typing.Optional[bool]
Allow sending newsletters to user
custom_hotkeys : typing.Optional[typing.Any]
Custom keyboard shortcuts configuration for the user interface
date_joined : typing.Optional[dt.datetime]
email_notification_settings : typing.Optional[typing.Any]
first_name : typing.Optional[str]
is_email_verified : typing.Optional[bool]
last_name : typing.Optional[str]
onboarding_state : typing.Optional[str]
password : typing.Optional[str]
phone : typing.Optional[str]
username : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUserApi
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.update_current_user()
r) r update_current_userr& r r* r+ r, r- r. r/ r0 r1 r2 r3 r4 r5 r" r( s r r8 z UsersClient.update_current_userC sS N $$88 3 /)#(C! / - + 9
~~ r c R | j j | }|j S )a
Retrieve the custom hotkeys configuration for the current user.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Hotkeys
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.get_hotkeys()
r! r get_hotkeysr& r' s r r< zUsersClient.get_hotkeys ' . $$00 0Q ~~ r r, r" c T | j j || }|j S )a
Update the custom hotkeys configuration for the current user.
Parameters
----------
custom_hotkeys : typing.Optional[typing.Dict[str, typing.Any]]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Hotkeys
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.update_hotkeys()
r> r update_hotkeysr& r r, r" r( s r rA zUsersClient.update_hotkeys s* < $$33>cr3s ~~ r c R | j j | }|j S )a
Reset the user token for the current user.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ResetTokenUsersResponse
User token response
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.reset_token()
r! r reset_tokenr& r' s r rE zUsersClient.reset_token r= r c R | j j | }|j S )a
Get a user token to authenticate to the API as the current user.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetTokenUsersResponse
User token response
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.get_token()
r! r get_tokenr& r' s r rH zUsersClient.get_token s' . $$...O ~~ r c R | j j | }|j S )a
Retrieve details of the account that you are using to access the API.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
WhoAmIUser
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.whoami()
r! r whoamir& r' s r rK zUsersClient.whoami
s' . $$++O+L ~~ r orderingr" rM c T | j j || }|j S )a6
List the users that exist on the Label Studio server.
Parameters
----------
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[LseUserApi]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.list()
rL r listr& r rM r" r( s r rP zUsersClient.list$ s) 8 $$))8_)] ~~ r
r+ avataremailr/ idinitialsr1 r4 r5 r" rS rT rU rV c
d | j j ||||||||| |
} | j S )aO
Create a user in Label Studio.
Parameters
----------
allow_newsletters : typing.Optional[bool]
Whether the user allows newsletters
avatar : typing.Optional[str]
Avatar URL of the user
email : typing.Optional[str]
Email of the user
first_name : typing.Optional[str]
First name of the user
id : typing.Optional[int]
User ID
initials : typing.Optional[str]
Initials of the user
last_name : typing.Optional[str]
Last name of the user
phone : typing.Optional[str]
Phone number of the user
username : typing.Optional[str]
Username of the user
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUser
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.create()
rR r creater& r r+ rS rT r/ rU rV r1 r4 r5 r" r( s r rY zUsersClient.createC sJ ~ $$++ /! + ,
~~ r c T | j j || }|j S )a
Get info about a specific Label Studio user, based on the user ID.
Parameters
----------
id : int
User ID
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUser
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.get(
id=1,
)
r! r getr& r rU r" r( s r r] zUsersClient.get s) 8 $$((_(M ~~ r c T | j j || }|j S )a
Delete a specific Label Studio user. Only available in community edition.
Use caution when deleting a user, as this can cause issues such as breaking the "Annotated by" filter or leaving orphaned records.
Parameters
----------
id : int
User ID
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.users.delete(
id=1,
)
r! r deleter& r^ s r ra zUsersClient.delete s) : $$++B+P ~~ r
r+ rS rT r/ update_users_request_idrV r1 r4 r5 r" rc c
f | j j ||||||||| |
| } | j S )a
Update details for a specific user, such as their name or contact information, in Label Studio.
Parameters
----------
id : int
User ID
allow_newsletters : typing.Optional[bool]
Whether the user allows newsletters
avatar : typing.Optional[str]
Avatar URL of the user
email : typing.Optional[str]
Email of the user
first_name : typing.Optional[str]
First name of the user
update_users_request_id : typing.Optional[int]
User ID
initials : typing.Optional[str]
Initials of the user
last_name : typing.Optional[str]
Last name of the user
phone : typing.Optional[str]
Phone number of the user
username : typing.Optional[str]
Username of the user
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUser
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.users.update(
id=1,
)
rb r updater&
r rU r+ rS rT r/ rc rV r1 r4 r5 r" r( s
r rf zUsersClient.update sM N $$++ /!$; + ,
~~ r )&__name__
__module__ __qualname__r r propertyr
r typingOptionalr r r% OMITintboolAnydtdatetimestrr8 r r< DictrA r rE r rH r
rK ListrP r rY r] ra rf r r r r s I*; I > VZ 6??>3R ^h F 59376:48CG+/37*.15)-&*)-;? V $__S 1V "??40 V
3 V __R[[1
V &,__VZZ%@V OOC(V "??40V ??3'V !//#.V //#&V s#V //#& V 8 V
!V p QU foon.M Y` : IM;? CO(DE 8
B QU foon.M Yp 4 OS FOON,K Wl 4 LP )H T^ 6 37ko !??3/ IO YgIh Z D 48'+&*+/#')-*.&*)-;?K "??40K $ K
s# K OOC(
K
OOC K //#&K ??3'K s#K //#&K 8K
K Z RV c v~/N Za > UY &//.2Q ]a H 48'+&*+/8<)-*.&*)-;?T T "??40 T
$ T s#
T OOC(T "( !5T //#&T ??3'T s#T //#&T 8T
T r r c e Zd ZdefdZedefd Zdddej e
de fdZ e
e
e
e
e
e
e
e
e
e
e
e
dd
d
ej e d ej e d ej ej d
ej ej$ dej ej dej e dej e dej e dej e dej e dej e dej e dej e
de f dZdddej e
defdZe
ddd ej ej. eej f dej e
defdZdddej e
defdZdddej e
defdZ dddej e
de fd Z ddd d ej e dej e
dej> e fd Z e
e
e
e
e
e
e
e
e
dd
d ej e d!ej e d"ej e dej e d#ej e d$ej e dej e dej e dej e dej e
de!fd%Z"ddd#edej e
de!fd&Z#ddd#edej e
ddfd'Z$e
e
e
e
e
e
e
e
e
dd(
d#ed ej e d!ej e d"ej e dej e d)ej e d$ej e dej e dej e dej e dej e
de!fd*Z%y)+AsyncUsersClientr c & t | | _ y r )r r r s r r zAsyncUsersClient.__init__' s .nMr r c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawUsersClient
r r s r r z"AsyncUsersClient.with_raw_response* r r Nr! r" c n K | j j | d{ }|j S 7 w)a7
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get info about the currently authenticated user.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUserApi
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.get_current_user()
asyncio.run(main())
r! Nr$ r' s r r% z!AsyncUsersClient.get_current_user5 s5 J **;;O;\\ ~~ ] 535r) r* r+ r, r- r. r/ r0 r1 r2 r3 r4 r5 c
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)
Update details for the currently authenticated user.
Parameters
----------
active_organization : typing.Optional[int]
allow_newsletters : typing.Optional[bool]
Allow sending newsletters to user
custom_hotkeys : typing.Optional[typing.Any]
Custom keyboard shortcuts configuration for the user interface
date_joined : typing.Optional[dt.datetime]
email_notification_settings : typing.Optional[typing.Any]
first_name : typing.Optional[str]
is_email_verified : typing.Optional[bool]
last_name : typing.Optional[str]
onboarding_state : typing.Optional[str]
password : typing.Optional[str]
phone : typing.Optional[str]
username : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUserApi
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.update_current_user()
asyncio.run(main())
r) Nr7 r9 s r r8 z$AsyncUsersClient.update_current_user] sa ^ **>> 3 /)#(C! / - + ?
~~
s ,A?Ac n K | j j | d{ }|j S 7 w)aB
Retrieve the custom hotkeys configuration for the current user.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Hotkeys
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.get_hotkeys()
asyncio.run(main())
r! Nr; r' s r r< z AsyncUsersClient.get_hotkeys 4 > **666WW ~~ Xr} r> c p K | j j || d{ }|j S 7 w)a
Update the custom hotkeys configuration for the current user.
Parameters
----------
custom_hotkeys : typing.Optional[typing.Dict[str, typing.Any]]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Hotkeys
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.update_hotkeys()
asyncio.run(main())
r> Nr@ rB s r rA z AsyncUsersClient.update_hotkeys s? L **99)? :
~~
!646c n K | j j | d{ }|j S 7 w)a\
Reset the user token for the current user.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ResetTokenUsersResponse
User token response
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.reset_token()
asyncio.run(main())
r! NrD r' s r rE z AsyncUsersClient.reset_token
r r} c n K | j j | d{ }|j S 7 w)an
Get a user token to authenticate to the API as the current user.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetTokenUsersResponse
User token response
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.get_token()
asyncio.run(main())
r! NrG r' s r rH zAsyncUsersClient.get_token, s4 > **44_4UU ~~ Vr} c n K | j j | d{ }|j S 7 w)aF
Retrieve details of the account that you are using to access the API.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
WhoAmIUser
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.whoami()
asyncio.run(main())
r! NrJ r' s r rK zAsyncUsersClient.whoamiN s4 > **11/1RR ~~ Sr} rL rM c p K | j j || d{ }|j S 7 w)a
List the users that exist on the Label Studio server.
Parameters
----------
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[LseUserApi]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.list()
asyncio.run(main())
rL NrO rQ s r rP zAsyncUsersClient.listp s8 H **//Sb/cc ~~ dr rR rS rT rU rV c
K | j j ||||||||| |
d{ } | j S 7 w)a
Create a user in Label Studio.
Parameters
----------
allow_newsletters : typing.Optional[bool]
Whether the user allows newsletters
avatar : typing.Optional[str]
Avatar URL of the user
email : typing.Optional[str]
Email of the user
first_name : typing.Optional[str]
First name of the user
id : typing.Optional[int]
User ID
initials : typing.Optional[str]
Initials of the user
last_name : typing.Optional[str]
Last name of the user
phone : typing.Optional[str]
Phone number of the user
username : typing.Optional[str]
Username of the user
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUser
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.create()
asyncio.run(main())
rR NrX rZ s r rY zAsyncUsersClient.create sX N **11 /! + 2
~~
s )><>c p K | j j || d{ }|j S 7 w)a
Get info about a specific Label Studio user, based on the user ID.
Parameters
----------
id : int
User ID
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUser
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.get(
id=1,
)
asyncio.run(main())
r! Nr\ r^ s r r] zAsyncUsersClient.get s7 H **..r?.SS ~~ Tr c p K | j j || d{ }|j S 7 w)a+
Delete a specific Label Studio user. Only available in community edition.
Use caution when deleting a user, as this can cause issues such as breaking the "Annotated by" filter or leaving orphaned records.
Parameters
----------
id : int
User ID
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.users.delete(
id=1,
)
asyncio.run(main())
r! Nr` r^ s r ra zAsyncUsersClient.delete s7 J **11"o1VV ~~ Wr rb rc c
K | j j ||||||||| |
| d{ } | j S 7 w)af
Update details for a specific user, such as their name or contact information, in Label Studio.
Parameters
----------
id : int
User ID
allow_newsletters : typing.Optional[bool]
Whether the user allows newsletters
avatar : typing.Optional[str]
Avatar URL of the user
email : typing.Optional[str]
Email of the user
first_name : typing.Optional[str]
First name of the user
update_users_request_id : typing.Optional[int]
User ID
initials : typing.Optional[str]
Initials of the user
last_name : typing.Optional[str]
Last name of the user
phone : typing.Optional[str]
Phone number of the user
username : typing.Optional[str]
Username of the user
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseUser
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.users.update(
id=1,
)
asyncio.run(main())
rb Nre rg s
r rf zAsyncUsersClient.update; s[ ^ **11 /!$; + 2
~~
s *?=?)&rh ri rj r r rk r r rl rm r r r% rn ro rp rq rr rs rt r8 r r< ru rA r rE r rH r
rK rv rP r rY r] ra rf rw r r ry ry & s N*< N #6 \` & 9X & dn & V 59376:48CG+/37*.15)-&*)-;? ^ $__S 1^ "??40 ^
3 ^ __R[[1
^ &,__VZZ%@^ OOC(^ "??40^ ??3'^ !//#.^ //#&^ s#^ //#& ^ 8 ^
!^ @ W[ FOON4S _f J IM;? ) CO(DE) 8 )
) V W[ FOON4S _v D UY &//.2Q ]r D RV v~/N Zd F 37ko% !??3/% IO YgIh% Z % T 48'+&*+/#')-*.&*)-;?S "??40S $ S
s# S OOC(
S
OOC S //#&S ??3'S s#S //#&S 8S
S j X\ % C % V__^5T % `g % N [_ & s & 8W & cg & X 48'+&*+/8<)-*.&*)-;?\ \ "??40 \
$ \ s#
\ OOC(\ "( !5\ //#&\ ??3'\ s#\ //#&\ 8\
\ r ry ) rs rr rl core.client_wrapperr r core.request_optionsr
types.hotkeysr types.lse_userr types.lse_user_apir types.who_am_i_userr
raw_clientr r
types.get_token_users_responser types.reset_token_users_responser castrq rn r ry rw r r r sY
G 1 # $ + , ; A E v{{6::s#O O dq q r