]j8k 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)
LseProject)ProjectTemplate ) AsyncRawProjectTemplatesClientRawProjectTemplatesClient.c ( e Zd ZdefdZedefd Zddddej e
dej e dej e
fd Zeeeeeeeeeedd
d e
d ed
ej ej" dej e dej e
dej e
dej e dej ej" dej e dej ej" dej e dej ej" dej e de
f dZdddedej e de
fdZdddedej e ddfdZeeeeeeeeeeeedd
ded
ej ej" dej e dej e
dej e
d ej e
dej e d ej e dej ej" dej e dej ej" dej e dej ej" dej e de
f d Zedd ded e
d edej e
dej e def d!Zy)"ProjectTemplatesClientclient_wrapperc & t | | _ y N)r )r _raw_clientselfr s S/root/env/lib/python3.12/site-packages/label_studio_sdk/project_templates/client.py__init__z ProjectTemplatesClient.__init__ s 4NS returnc | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawProjectTemplatesClient
r r s r with_raw_responsez(ProjectTemplatesClient.with_raw_response r Norderingrequest_optionsr r c T | j j || }|j S )aF
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a list of all project templates for an organization.
Parameters
----------
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[ProjectTemplate]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.project_templates.list()
r r listdatar r r _responses r r" zProjectTemplatesClient.list s* D $$))8_)] ~~ r assignment_settings
created_by
custom_script description organizationproject_settingsrequire_comment_on_skipreview_settings&show_unused_data_columns_to_annotatorstagsr name
project_idr' r( r) r* r+ r, r- r. r/ r0 c
j | j j ||||||||| |
| | |
}|j S )aY
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a project template for an organization.
Parameters
----------
name : str
project_id : int
assignment_settings : typing.Optional[typing.Any]
general dict serialized assignment settings
created_by : typing.Optional[int]
custom_script : typing.Optional[str]
custom script (Plugin) for projects created from this template
description : typing.Optional[str]
organization : typing.Optional[int]
project_settings : typing.Optional[typing.Any]
general dict serialized project settings
require_comment_on_skip : typing.Optional[bool]
flag to require comment on skip
review_settings : typing.Optional[typing.Any]
general dict serialized review settings
show_unused_data_columns_to_annotators : typing.Optional[bool]
tags : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ProjectTemplate
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.project_templates.create(
name="name",
project_id=1,
)
r1 r2 r' r( r) r* r+ r, r- r. r/ r0 r r creater# r r1 r2 r' r( r) r* r+ r, r- r. r/ r0 r r% s r r6 z ProjectTemplatesClient.createC sS Z $$++! 3!'#% -$; +3Y + ,
~~ r r idc T | 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 a specific project template by ID for an organization.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ProjectTemplate
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.project_templates.get(
id=1,
)
r8 r getr# r r9 r r% s r r< zProjectTemplatesClient.get s* B $$((_(M ~~ r c T | 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)
Delete a specific project template by ID for an organization.
Parameters
----------
id : int
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.project_templates.delete(
id=1,
)
r8 r deleter# r= s r r@ z ProjectTemplatesClient.delete s* @ $$++B+P ~~ r
r' r( r) r* r1 r+ r2 r, r- r. r/ r0 r c
l | 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 details of a specific project template by ID for an organization.
Parameters
----------
id : int
assignment_settings : typing.Optional[typing.Any]
general dict serialized assignment settings
created_by : typing.Optional[int]
custom_script : typing.Optional[str]
custom script (Plugin) for projects created from this template
description : typing.Optional[str]
name : typing.Optional[str]
organization : typing.Optional[int]
project_id : typing.Optional[int]
project_settings : typing.Optional[typing.Any]
general dict serialized project settings
require_comment_on_skip : typing.Optional[bool]
flag to require comment on skip
review_settings : typing.Optional[typing.Any]
general dict serialized review settings
show_unused_data_columns_to_annotators : typing.Optional[bool]
tags : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ProjectTemplate
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.project_templates.update(
id=1,
)
rA r updater# r r9 r' r( r) r* r1 r+ r2 r, r- r. r/ r0 r r% s r rD z ProjectTemplatesClient.update sV ^ $$++ 3!'#%! -$; +3Y + ,
~~ r r* r title workspace_idc 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 project from a specific project template by ID for an organization.
Parameters
----------
id : int
title : str
The title of the project to be created from the template.
workspace_id : int
A unique integer value identifying the workspace in which to create the project.
description : typing.Optional[str]
A description for the project.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseProject
Project created successfully
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.project_templates.create_project_from_template(
id=1,
title="title",
workspace_id=1,
)
rG rH r* r r create_project_from_templater# r r9 rG rH r* r r% s r rL z3ProjectTemplatesClient.create_project_from_templateI s9 h $$AA e,Kap B
~~ r )__name__
__module__ __qualname__r r propertyr r typingOptionalstrr Listr r" OMITintAnyboolr6 r< r@ rD r rL r r r
r
s T*; T #< 37ko# !??3/# IO YgIh# _ %# T <@+/.2,0-18<9=7;HL,0;? \ \ \
$__VZZ 8 \ OOC(
\ s+\ __S)\ ooc*\ !//&**5\ "( !6\ 4\ 170E\ oofjj) \ 8 \
!\ | RV " c " v~/N " Zi " H UY ! ! &//.2Q ! ]a ! N <@+/.2,0%)-1+/8<9=7;HL,0;?!_ _ $__VZZ 8 _
OOC( _ s+
_ __S)_ ooc"_ ooc*_ OOC(_ !//&**5_ "( !6_ 4_ 170E _ oofjj) _ 8!_ "
#_ N -1;?7 7 7
7 __S)
7 87
7 r r
c ( e Zd ZdefdZedefd Zddddej e
dej e dej e
fd Zeeeeeeeeeedd
d e
d ed
ej ej" dej e dej e
dej e
dej e dej ej" dej e dej ej" dej e dej ej" dej e de
f dZdddedej e de
fdZdddedej e ddfdZeeeeeeeeeeeedd
ded
ej ej" dej e dej e
dej e
d ej e
dej e d ej e dej ej" dej e dej ej" dej e dej ej" dej e de
f d Zedd ded e
d edej e
dej e def d!Zy)"AsyncProjectTemplatesClientr c & t | | _ y r )r
r r s r r z$AsyncProjectTemplatesClient.__init__ s 9 Xr r c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawProjectTemplatesClient
r r s r r z-AsyncProjectTemplatesClient.with_raw_response r r Nr r r c p 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)
Get a list of all project templates for an organization.
Parameters
----------
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[ProjectTemplate]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.project_templates.list()
asyncio.run(main())
r Nr! r$ s r r" z AsyncProjectTemplatesClient.list s8 T **//Sb/cc ~~ d !646r& r1 r2 r' r( r) r* r+ r, r- r. r/ r0 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)
Create a project template for an organization.
Parameters
----------
name : str
project_id : int
assignment_settings : typing.Optional[typing.Any]
general dict serialized assignment settings
created_by : typing.Optional[int]
custom_script : typing.Optional[str]
custom script (Plugin) for projects created from this template
description : typing.Optional[str]
organization : typing.Optional[int]
project_settings : typing.Optional[typing.Any]
general dict serialized project settings
require_comment_on_skip : typing.Optional[bool]
flag to require comment on skip
review_settings : typing.Optional[typing.Any]
general dict serialized review settings
show_unused_data_columns_to_annotators : typing.Optional[bool]
tags : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ProjectTemplate
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.project_templates.create(
name="name",
project_id=1,
)
asyncio.run(main())
r4 Nr5 r7 s r r6 z"AsyncProjectTemplatesClient.create sa j **11! 3!'#% -$; +3Y + 2
~~
s ,A?Ar8 r9 c p 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)
Get a specific project template by ID for an organization.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ProjectTemplate
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.project_templates.get(
id=1,
)
asyncio.run(main())
r8 Nr; r= s r r< z AsyncProjectTemplatesClient.get% s7 R **..r?.SS ~~ Tr` c p K | j j || d{ }|j S 7 w)at
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific project template by ID for an organization.
Parameters
----------
id : int
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.project_templates.delete(
id=1,
)
asyncio.run(main())
r8 Nr? r= s r r@ z"AsyncProjectTemplatesClient.deleteQ s7 P **11"o1VV ~~ Wr` 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 the details of a specific project template by ID for an organization.
Parameters
----------
id : int
assignment_settings : typing.Optional[typing.Any]
general dict serialized assignment settings
created_by : typing.Optional[int]
custom_script : typing.Optional[str]
custom script (Plugin) for projects created from this template
description : typing.Optional[str]
name : typing.Optional[str]
organization : typing.Optional[int]
project_id : typing.Optional[int]
project_settings : typing.Optional[typing.Any]
general dict serialized project settings
require_comment_on_skip : typing.Optional[bool]
flag to require comment on skip
review_settings : typing.Optional[typing.Any]
general dict serialized review settings
show_unused_data_columns_to_annotators : typing.Optional[bool]
tags : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ProjectTemplate
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.project_templates.update(
id=1,
)
asyncio.run(main())
rA NrC rE s r rD z"AsyncProjectTemplatesClient.update| sd n **11 3!'#%! -$; +3Y + 2
~~ !
s -AA ArF rG rH c v K | j j ||||| d{ }|j S 7 w)a2
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a project from a specific project template by ID for an organization.
Parameters
----------
id : int
title : str
The title of the project to be created from the template.
workspace_id : int
A unique integer value identifying the workspace in which to create the project.
description : typing.Optional[str]
A description for the project.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseProject
Project created successfully
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.project_templates.create_project_from_template(
id=1,
title="title",
workspace_id=1,
)
asyncio.run(main())
rJ NrK rM s r rL z8AsyncProjectTemplatesClient.create_project_from_template sG x **GG e,Kap H
~~
s $979)rN rO rP r r rQ r
r rR rS rT r rU r r" rV rW rX rY r6 r< r@ rD r rL rZ r r r\ r\ s Y*< Y #A 37ko+ !??3/+ IO YgIh+ _ %+ d <@+/.2,0-18<9=7;HL,0;? d d d
$__VZZ 8 d OOC(
d s+d __S)d ooc*d !//&**5d "( !6d 4d 170Ed oofjj) d 8 d
!d L X\ * C * V__^5T * `o * X [_ ) s ) 8W ) cg ) ^ <@+/.2,0%)-1+/8<9=7;HL,0;?!g g $__VZZ 8 g
OOC( g s+
g __S)g ooc"g ooc*g OOC(g !//&**5g "( !6g 4g 170E g oofjj) g 8!g "
#g ^ -1;?? ? ?
? __S)
? 8?
? r r\ )rR core.client_wrapperr r core.request_optionsr types.lse_projectr types.project_templater
raw_clientr
r castrX rV r
r\ rZ r r rl sJ G 1 * 4 Q v{{6::s#q q h a a r