]jd B d dl mZ d dlZd dlZddlmZmZ ddlm Z ddl
m Z ddl m
Z
ddlmZ dd lmZ dd
lmZ d d lmZmZ ej. r d d
lmZmZ d dlm Z m Z d dl m Z m Z d dl!m"Z"m#Z# ejH ejJ d Z& G d d Z' G d d Z(y) ) annotationsN )AsyncClientWrapperSyncClientWrapper)RequestOptions) DefaultRole)LseOrganization)OrganizationId)OrganizationInvite) Role9E7Enum )AsyncRawOrganizationsClientRawOrganizationsClient)AsyncInvitesClient
InvitesClient)AsyncMemberTagsClientMemberTagsClient)AsyncMembersClient
MembersClient)AsyncPermissionsClientPermissionsClient.c
> e Zd ZddZedd ZddddZddd ddZddddZe e e e e e e e dd dd
Z
e e e e e e e e e e e dd dd Z ed
Z ed Z
ed Zed Zy)OrganizationsClientc l t | | _ || _ d | _ d | _ d | _ d | _ y Nclient_wrapper)r _raw_client_client_wrapper_invites _member_tags_members _permissionsselfr s O/root/env/lib/python3.12/site-packages/label_studio_sdk/organizations/client.py__init__z OrganizationsClient.__init__ s5 1 P - 8<
?C8<
@D c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawOrganizationsClient
r r% s r& with_raw_responsez%OrganizationsClient.with_raw_response# r( Nrequest_optionsc R | j j | }|j S )a
Reset the token used in the invitation link to invite someone to an organization.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
OrganizationInvite
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.organizations.reset_token()
r. r reset_tokendatar% r/ _responses r& r2 z OrganizationsClient.reset_token. s' . $$00 0Q ~~ r( orderingr/ c T | j j || }|j S )ad
Return a list of the organizations you've created or that you have access to.
Parameters
----------
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[OrganizationId]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.organizations.list()
r6 r listr3 r% r7 r/ r5 s r& r: zOrganizationsClient.listH s) < $$))8_)] ~~ r( c T | j j || }|j S )a
Retrieve the settings for a specific organization by ID.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseOrganization
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.organizations.get(
id=1,
)
r. r getr3 r% idr/ r5 s r& r> zOrganizationsClient.geti s) 6 $$((_(M ~~ r( contact_info
created_bycustom_scripts_enabledemail_notification_settings
embed_domainsembed_settingstitletokenr/ c d | 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 organization details including title, embed domains, and Plugins settings.
Parameters
----------
id : int
contact_info : typing.Optional[str]
created_by : typing.Optional[int]
custom_scripts_enabled : typing.Optional[bool]
Plugins
email_notification_settings : typing.Optional[typing.Any]
Email Notification Settings
embed_domains : typing.Optional[typing.Sequence[typing.Dict[str, str]]]
Supported domains
embed_settings : typing.Optional[typing.Any]
Public Verification Key and Public Verification Algorithms configuration
title : typing.Optional[str]
Organization name
token : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseOrganization
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.organizations.update(
id=1,
)
rA r updater3 r% r@ rB rC rD rE rF rG rH rI r/ r5 s r& rL zOrganizationsClient.update sJ F $$++ %!#9(C') + ,
~~ r( &annotator_reviewer_firewall_enabled_atcustom_scripts_enabled_at default_rolerE rF rG external_idextra_data_on_activity_logs#label_stream_navigation_disabled_at organization read_only_quick_view_enabled_atr/ 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 the default role for members of a specific organization.
Parameters
----------
id : int
annotator_reviewer_firewall_enabled_at : typing.Optional[dt.datetime]
Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
custom_scripts_enabled_at : typing.Optional[dt.datetime]
Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).
default_role : typing.Optional[Role9E7Enum]
Default membership role for invited users
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
email_notification_settings : typing.Optional[typing.Any]
Email notification settings for this organization. Controls which email notifications users can receive. Structure: {"notifications_allowed": {"notification_type": bool}}
embed_domains : typing.Optional[typing.Any]
List of objects: {"domain": "example.com"}. Used for CSP header on /embed routes.
embed_settings : typing.Optional[typing.Any]
Embed settings for this organization
external_id : typing.Optional[str]
External ID to uniquely identify this organization
extra_data_on_activity_logs : typing.Optional[bool]
label_stream_navigation_disabled_at : typing.Optional[dt.datetime]
Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
organization : typing.Optional[int]
A unique integer value identifying this organization.
read_only_quick_view_enabled_at : typing.Optional[dt.datetime]
Set to current time to prevent creating or editing annotations in quick view.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DefaultRole
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.organizations.update_default_role(
id=1,
)
rN r update_default_roler3 r% r@ rO rP rQ rE rF rG rR rS rT rU rV r/ r5 s r& rY z'OrganizationsClient.update_default_role sS r $$88 3Y&?%(C')#(C0S%,K + 9
~~ r( c n | j ddlm} || j | _ | j S )Nr
)r r )r invites.clientr r )r% r s r& inviteszOrganizationsClient.invitesB + == 5 )9M9M NDM}} r( c n | j ddlm} || j | _ | j S )Nr
)r r )r! member_tags.clientr r )r% r s r& member_tagsz OrganizationsClient.member_tagsJ s0 $ < 0@T@T UD r( c n | j ddlm} || j | _ | j S )Nr
)r r )r" members.clientr r )r% r s r& memberszOrganizationsClient.membersR r^ r( c n | j ddlm} || j | _ | j S )Nr
)r r )r# permissions.clientr r )r% r s r& permissionsz OrganizationsClient.permissionsZ s0 $ = 1AUAU VD r( )r r )returnr r/ typing.Optional[RequestOptions]rh r r7 typing.Optional[str]r/ rj rh ztyping.List[OrganizationId]r@ intr/ rj rh r r@ rn rB rl rC typing.Optional[int]rD typing.Optional[bool]rE typing.Optional[typing.Any]rF z7typing.Optional[typing.Sequence[typing.Dict[str, str]]]rG rr rH rl rI rl r/ rj rh r r@ rn rO typing.Optional[dt.datetime]rP rt rQ z typing.Optional[Role9E7Enum]rE rr rF rr rG rr rR rl rS rq rT rt rU rp rV rt r/ rj rh r __name__
__module__ __qualname__r' propertyr, r2 r: r> OMITrL rY r] ra rd rg r( r& r r s E QU 6 37ko / Ih $ B RV D .2+/8 e Zd ZddZedd ZddddZddd ddZddddZe e e e e e e e dd dd
Z
e e e e e e e e e e e dd dd Z ed
Z ed Z
ed Zed Zy)AsyncOrganizationsClientc l t | | _ || _ d | _ d | _ d | _ d | _ y r )r r r r r! r" r# r$ s r& r' z!AsyncOrganizationsClient.__init__d s5 6nU - =A
DH=A
EIr( c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawOrganizationsClient
r* r+ s r& r, z*AsyncOrganizationsClient.with_raw_responsel r- r( Nr. c n K | j j | d{ }|j S 7 w)ag
Reset the token used in the invitation link to invite someone to an organization.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
OrganizationInvite
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.organizations.reset_token()
asyncio.run(main())
r. Nr1 r4 s r& r2 z$AsyncOrganizationsClient.reset_tokenw s4 > **666WW ~~ Xs 535r6 c p K | j j || d{ }|j S 7 w)a
Return a list of the organizations you've created or that you have access to.
Parameters
----------
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[OrganizationId]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.organizations.list()
asyncio.run(main())
r6 Nr9 r; s r& r: z AsyncOrganizationsClient.list s8 L **//Sb/cc ~~ d !646c p K | j j || d{ }|j S 7 w)ax
Retrieve the settings for a specific organization by ID.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseOrganization
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.organizations.get(
id=1,
)
asyncio.run(main())
r. Nr= r? s r& r> z AsyncOrganizationsClient.get s7 F **..r?.SS ~~ Tr rA 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 organization details including title, embed domains, and Plugins settings.
Parameters
----------
id : int
contact_info : typing.Optional[str]
created_by : typing.Optional[int]
custom_scripts_enabled : typing.Optional[bool]
Plugins
email_notification_settings : typing.Optional[typing.Any]
Email Notification Settings
embed_domains : typing.Optional[typing.Sequence[typing.Dict[str, str]]]
Supported domains
embed_settings : typing.Optional[typing.Any]
Public Verification Key and Public Verification Algorithms configuration
title : typing.Optional[str]
Organization name
token : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseOrganization
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.organizations.update(
id=1,
)
asyncio.run(main())
rA NrK rM s r& rL z AsyncOrganizationsClient.update sX V **11 %!#9(C') + 2
~~
s )><>rN c K | j j ||||||||| |
| | |
d{ }|j S 7 w)aL
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update the default role for members of a specific organization.
Parameters
----------
id : int
annotator_reviewer_firewall_enabled_at : typing.Optional[dt.datetime]
Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
custom_scripts_enabled_at : typing.Optional[dt.datetime]
Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).
default_role : typing.Optional[Role9E7Enum]
Default membership role for invited users
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
email_notification_settings : typing.Optional[typing.Any]
Email notification settings for this organization. Controls which email notifications users can receive. Structure: {"notifications_allowed": {"notification_type": bool}}
embed_domains : typing.Optional[typing.Any]
List of objects: {"domain": "example.com"}. Used for CSP header on /embed routes.
embed_settings : typing.Optional[typing.Any]
Embed settings for this organization
external_id : typing.Optional[str]
External ID to uniquely identify this organization
extra_data_on_activity_logs : typing.Optional[bool]
label_stream_navigation_disabled_at : typing.Optional[dt.datetime]
Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
organization : typing.Optional[int]
A unique integer value identifying this organization.
read_only_quick_view_enabled_at : typing.Optional[dt.datetime]
Set to current time to prevent creating or editing annotations in quick view.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DefaultRole
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.organizations.update_default_role(
id=1,
)
asyncio.run(main())
rN NrX rZ s r& rY z,AsyncOrganizationsClient.update_default_roleA sa B **>> 3Y&?%(C')#(C0S%,K + ?
~~
s ,A?Ac n | j ddlm} || j | _ | j S )Nr
)r r )r r\ r r )r% r s r& r] z AsyncOrganizationsClient.invites + == : .d>R>R SDM}} r( c n | j ddlm} || j | _ | j S )Nr
)r r )r! r` r r )r% r s r& ra z$AsyncOrganizationsClient.member_tags s0 $ A 5TEYEY ZD r( c n | j ddlm} || j | _ | j S )Nr
)r r )r" rc r r )r% r s r& rd z AsyncOrganizationsClient.members r r( c n | j ddlm} || j | _ | j S )Nr
)r r )r# rf r r )r% r s r& rg z$AsyncOrganizationsClient.permissions s0 $ B 6dFZFZ [D r( )r r )rh r ri rk rm ro rs ru r{ r( r& r} r} c s J W[ F 37ko' /' Ih' $' R X\ $ T .2+/8r sl #
G 1 , 4 2 : + K AKAMv{{6::s#F! F!R
n! n!r(