]jp d dl Zd dlZddlmZmZ ddlmZ ddlm Z ddl
m Z ddl m
Z
ddlmZ dd lmZ dd
lmZ dd lmZ dd lmZ d
dlmZmZ d
dlm Z ej: ej< d Z G d d Z G d d Z!y) N )AsyncClientWrapperSyncClientWrapper)RequestOptions)ConvertedFormatRequest)Export)!LseAnnotationFilterOptionsRequest)LseExportCreate)LseTaskFilterOptionsRequest)SerializationOptionsRequest)
Status7BfEnum)UserSimpleRequest )AsyncRawExportsClientRawExportsClient)ConvertExportsResponse.c e Zd ZdefdZedefd Zdddddddede j e d e j e d
e j e d e j e j e e j e f d e j e de j e fd
Zddded e j e de j& e fdZddddede j e d e j e de j& e fdZeeeeeeeeeedd dede j e de j e j e de j e j4 de j e de j e j: de j e de j e de j e d e j e d e j e d e j e de!fd Z"ddded ed e j e defd Z#ddded ed e j e ddfd!Z$edd"ded ed
e d e j e d e j e de%f d#Z&ddd$ded ed
e j e d e j e de j e f
d%Z'y)&
ExportsClientclient_wrapperc & t | | _ y N)r )r _raw_clientselfr s R/root/env/lib/python3.12/site-packages/label_studio_sdk/projects/exports/client.py__init__zExportsClient.__init__ s +>J returnc | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawExportsClient
r r s r with_raw_responsez ExportsClient.with_raw_response r Ndownload_all_tasksdownload_resources export_typeidsrequest_optionsidr% r& r' r( r) c # K | j j |||||| 5 }|j E d{ ddd y7
# 1 sw Y yxY ww)a9
This endpoint is deprecated in Enterprise. Use the async export API instead:
POST /api/projects/{id}/exports/ (see [Create new export](/api#operation/api_projects_exports_create)).
In Label Studio Enterprise, this endpoint will always return a 404 Not Found response with instructions to use the async export API.
Note: if you have a large project it's recommended to use
export snapshots, this easy export endpoint might have timeouts.
Export annotated tasks as a file in a specific format.
For example, to export JSON annotations for a project to a file called `annotations.json`,
run the following from the command line:
```bash
curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON -H 'Authorization: Token abc123' --output 'annotations.json'
```
To export all tasks, including skipped tasks and others without annotations, run the following from the command line:
```bash
curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON&download_all_tasks=true -H 'Authorization: Token abc123' --output 'annotations.json'
```
To export specific tasks with IDs of 123 and 345, run the following from the command line:
```bash
curl -X GET 'http://localhost:8000/api/projects/{id}/export?ids[]=123&ids[]=345' -H 'Authorization: Token abc123' --output 'annotations.json'
```
Parameters
----------
id : int
A unique integer value identifying this project.
download_all_tasks : typing.Optional[bool]
If true, download all tasks regardless of status. If false, download only annotated tasks.
download_resources : typing.Optional[bool]
If true, download all resource files such as images, audio, and others relevant to the tasks.
export_type : typing.Optional[str]
Selected export format (JSON by default)
ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
Specify a list of task IDs to retrieve only the details for those tasks.
request_options : typing.Optional[RequestOptions]
Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
Returns
-------
typing.Iterator[bytes]
Exported data
r$ Nr
download_syncdata)r r* r% r& r' r( r) rs r r- zExportsClient.download_sync& se x
+
+ 1 1# +
,
vv
s+ "AAAA AAA
Ar) c T | j j || }|j S )a
This endpoint is deprecated in Enterprise. Use the async export API instead:
POST /api/projects/{{id}}/exports/ (see [Create new export](/api#operation/api_projects_exports_create)).
In Label Studio Enterprise, this endpoint will always return a 404 Not Found response with instructions to use the async export API.
Retrieve the available export formats for the current project by ID.
Parameters
----------
id : int
A unique integer value identifying this project.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[str]
Export formats
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.exports.list_formats(
id=1,
)
r0 r list_formatsr. r r* r) _responses r r3 zExportsClient.list_formatsl s* D $$11"o1V ~~ r orderingr) r7 c V | j j ||| }|j S )a
Returns a list of exported files for a specific project by ID.
Parameters
----------
id : int
A unique integer value identifying this project.
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[Export]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.exports.list(
id=1,
)
r6 r listr. r r* r7 r) r5 s r r: zExportsClient.list s- B $$))"xQ`)a ~~ r annotation_filter_optionsconverted_formatscounters
created_by finished_atmd5serialization_optionsstatustask_filter_optionstitler) r= r> r? r@ rA rB rC rD rE rF c h | j j ||||||||| |
| | }
|
j S )a
Create a new export request to start a background task and generate an export file for a specific project by ID.
Parameters
----------
id : int
A unique integer value identifying this project.
annotation_filter_options : typing.Optional[LseAnnotationFilterOptionsRequest]
converted_formats : typing.Optional[typing.Sequence[ConvertedFormatRequest]]
counters : typing.Optional[typing.Any]
created_by : typing.Optional[UserSimpleRequest]
finished_at : typing.Optional[dt.datetime]
Complete or fail time
md5 : typing.Optional[str]
serialization_options : typing.Optional[SerializationOptionsRequest]
status : typing.Optional[Status7BfEnum]
task_filter_options : typing.Optional[LseTaskFilterOptionsRequest]
title : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseExportCreate
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.exports.create(
id=1,
)
r< r creater. r r* r= r> r? r@ rA rB rC rD rE rF r) r5 s r rI zExportsClient.create sP @ $$++ &? / !#"7 3 + ,
~~ r export_pkc V | j j ||| }|j S )a
Retrieve information about an export file by export ID for a specific project.
Parameters
----------
id : int
A unique integer value identifying this project.
export_pk : int
Primary key identifying the export file.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Export
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.exports.get(
id=1,
export_pk=1,
)
r0 r getr. r r* rK r) r5 s r rN zExportsClient.get s, @ $$((Y(X ~~ r c V | j j ||| }|j S )a
Delete an export file by specified export ID.
Parameters
----------
id : int
A unique integer value identifying this project.
export_pk : int
Primary key identifying the export file.
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.exports.delete(
id=1,
export_pk=1,
)
r0 r deleter. rO s r rR zExportsClient.delete( s+ > $$++B ?+[ ~~ r r& r) c Z | j j ||||| }|j S )ai
Convert export snapshot to selected format
Parameters
----------
id : int
A unique integer value identifying this project.
export_pk : int
Primary key identifying the export file.
export_type : str
Export file format.
download_resources : typing.Optional[bool]
Download resources in converter.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ConvertExportsResponse
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.projects.exports.convert(
id=1,
export_pk=1,
export_type="export_type",
)
r' r& r) r convertr. r r* rK r' r& r) r5 s r rW zExportsClient.convertJ s; ^ $$,, # 1 + -
~~ r r' r) c # K | j j |||| 5 }|j E d{ ddd y7
# 1 sw Y yxY ww)a7
Download an export file in the specified format for a specific project. Specify the project ID with the `id`
parameter in the path and the ID of the export file you want to download using the `export_pk` parameter
in the path.
Get the `export_pk` from the response of the request to [Create new export](/api#operation/api_projects_exports_create)
or after [listing export files](/api#operation/api_projects_exports_list).
Parameters
----------
id : int
A unique integer value identifying this project.
export_pk : int
Primary key identifying the export file.
export_type : typing.Optional[str]
Selected export format
request_options : typing.Optional[RequestOptions]
Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
Returns
-------
typing.Iterator[bytes]
Export file
rY Nr downloadr. )r r* rK r' r) r/ s r r\ zExportsClient.download sT J
&
&r9+_n
&
o stvv s+ AAA A A AA A)(__name__
__module__ __qualname__r r propertyr r" inttypingOptionalboolstrUnionSequencer Iteratorbytesr- Listr3 r r: OMITr r Anyr dtdatetimer r
r r
rI rN rR r rW r\ r r r r s K*; K #3 5948,0HL;?D D #OOD 1 D
#OOD 1 D __S)
D __V\\#vs/C*C D
ED 8D
D L [_ # s # 8W # cicncnorcs # L <@tx" " $*OOC$8" RXRaRabpRq" V " P Y]VZ049=48$(NR15LP&*;? N N $*??3T#U N
"??6??;Q+RS N //&**-
N OO$56N __R[[1N __S
!N &/J KN
.N $__-H IN s#N 8 N
N ` bf ! c ! c ! v~?^ ! jp ! F ei &//R`Ba mq P 59;?6 6 6
6 #OOD 1
6 86
6 z -1;?
& & &
__S) & 8
&
& r r c e Zd ZdefdZedefd Zdddddddede j e d e j e d
e j e d e j e j e e j e f d e j e de j e fd
Zddded e j e de j& e fdZddddede j e d e j e de j& e fdZeeeeeeeeeedd dede j e de j e j e de j e j4 de j e de j e j: de j e de j e de j e d e j e d e j e d e j e de!fd Z"ddded ed e j e defd Z#ddded ed e j e ddfd!Z$edd"ded ed
e d e j e d e j e de%f d#Z&ddd$ded ed
e j e d e j e de j e f
d%Z'y)&AsyncExportsClientr c & t | | _ y r )r r r s r r zAsyncExportsClient.__init__ s 0Or r c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawExportsClient
r r! s r r" z$AsyncExportsClient.with_raw_response r# r Nr$ r* r% r& r' r( r) c K | j j |||||| 4 d{ }|j 2 3 d{ }| 7 7 6 ddd d{ 7 y# 1 d{ 7 sw Y yxY ww)a>
This endpoint is deprecated in Enterprise. Use the async export API instead:
POST /api/projects/{id}/exports/ (see [Create new export](/api#operation/api_projects_exports_create)).
In Label Studio Enterprise, this endpoint will always return a 404 Not Found response with instructions to use the async export API.
Note: if you have a large project it's recommended to use
export snapshots, this easy export endpoint might have timeouts.
Export annotated tasks as a file in a specific format.
For example, to export JSON annotations for a project to a file called `annotations.json`,
run the following from the command line:
```bash
curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON -H 'Authorization: Token abc123' --output 'annotations.json'
```
To export all tasks, including skipped tasks and others without annotations, run the following from the command line:
```bash
curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON&download_all_tasks=true -H 'Authorization: Token abc123' --output 'annotations.json'
```
To export specific tasks with IDs of 123 and 345, run the following from the command line:
```bash
curl -X GET 'http://localhost:8000/api/projects/{id}/export?ids[]=123&ids[]=345' -H 'Authorization: Token abc123' --output 'annotations.json'
```
Parameters
----------
id : int
A unique integer value identifying this project.
download_all_tasks : typing.Optional[bool]
If true, download all tasks regardless of status. If false, download only annotated tasks.
download_resources : typing.Optional[bool]
If true, download all resource files such as images, audio, and others relevant to the tasks.
export_type : typing.Optional[str]
Selected export format (JSON by default)
ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
Specify a list of task IDs to retrieve only the details for those tasks.
request_options : typing.Optional[RequestOptions]
Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
Returns
-------
typing.AsyncIterator[bytes]
Exported data
r$ Nr, ) r r* r% r& r' r( r) r/ _chunks r r- z AsyncExportsClient.download_sync s x ##11 1 1# +
2
!
f
se &A4AA4
A A A
A A A4
A A
A4AA4 A1%A( &A1-A4r0 c p K | j j || d{ }|j S 7 w)a_
This endpoint is deprecated in Enterprise. Use the async export API instead:
POST /api/projects/{{id}}/exports/ (see [Create new export](/api#operation/api_projects_exports_create)).
In Label Studio Enterprise, this endpoint will always return a 404 Not Found response with instructions to use the async export API.
Retrieve the available export formats for the current project by ID.
Parameters
----------
id : int
A unique integer value identifying this project.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[str]
Export formats
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.exports.list_formats(
id=1,
)
asyncio.run(main())
r0 Nr2 r4 s r r3 z AsyncExportsClient.list_formats s7 X **77O7\\ ~~ ]s !646r6 r7 c r K | j j ||| d{ }|j S 7 w)a&
Returns a list of exported files for a specific project by ID.
Parameters
----------
id : int
A unique integer value identifying this project.
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[Export]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.exports.list(
id=1,
)
asyncio.run(main())
r6 Nr9 r; s r r: zAsyncExportsClient.list0 s: R **//XWf/gg ~~ h "757r< r= r> r? r@ rA rB rC rD rE rF c K | j j ||||||||| |
| | d{ }
|
j S 7 w)au
Create a new export request to start a background task and generate an export file for a specific project by ID.
Parameters
----------
id : int
A unique integer value identifying this project.
annotation_filter_options : typing.Optional[LseAnnotationFilterOptionsRequest]
converted_formats : typing.Optional[typing.Sequence[ConvertedFormatRequest]]
counters : typing.Optional[typing.Any]
created_by : typing.Optional[UserSimpleRequest]
finished_at : typing.Optional[dt.datetime]
Complete or fail time
md5 : typing.Optional[str]
serialization_options : typing.Optional[SerializationOptionsRequest]
status : typing.Optional[Status7BfEnum]
task_filter_options : typing.Optional[LseTaskFilterOptionsRequest]
title : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
LseExportCreate
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.exports.create(
id=1,
)
asyncio.run(main())
r< NrH rJ s r rI zAsyncExportsClient.create\ s^ P **11 &? / !#"7 3 + 2
~~
s +A >A rK c r K | j j ||| d{ }|j S 7 w)a0
Retrieve information about an export file by export ID for a specific project.
Parameters
----------
id : int
A unique integer value identifying this project.
export_pk : int
Primary key identifying the export file.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Export
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.exports.get(
id=1,
export_pk=1,
)
asyncio.run(main())
r0 NrM rO s r rN zAsyncExportsClient.get s9 P **..r9o.^^ ~~ _rx c r K | j j ||| d{ }|j S 7 w)a
Delete an export file by specified export ID.
Parameters
----------
id : int
A unique integer value identifying this project.
export_pk : int
Primary key identifying the export file.
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.exports.delete(
id=1,
export_pk=1,
)
asyncio.run(main())
r0 NrQ rO s r rR zAsyncExportsClient.delete s: N **11"iQ`1aa ~~ brx rS c v K | j j ||||| d{ }|j S 7 w)a
Convert export snapshot to selected format
Parameters
----------
id : int
A unique integer value identifying this project.
export_pk : int
Primary key identifying the export file.
export_type : str
Export file format.
download_resources : typing.Optional[bool]
Download resources in converter.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ConvertExportsResponse
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.projects.exports.convert(
id=1,
export_pk=1,
export_type="export_type",
)
asyncio.run(main())
rU NrV rX s r rW zAsyncExportsClient.convert sI n **22 # 1 + 3
~~
s $979rY c K | j j |||| 4 d{ }|j 2 3 d{ }| 7 7 6 ddd d{ 7 y# 1 d{ 7 sw Y yxY ww)a<
Download an export file in the specified format for a specific project. Specify the project ID with the `id`
parameter in the path and the ID of the export file you want to download using the `export_pk` parameter
in the path.
Get the `export_pk` from the response of the request to [Create new export](/api#operation/api_projects_exports_create)
or after [listing export files](/api#operation/api_projects_exports_list).
Parameters
----------
id : int
A unique integer value identifying this project.
export_pk : int
Primary key identifying the export file.
export_type : typing.Optional[str]
Selected export format
request_options : typing.Optional[RequestOptions]
Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
Returns
-------
typing.AsyncIterator[bytes]
Export file
rY Nr[ )r r* rK r' r) r/ ru s r r\ zAsyncExportsClient.downloadI sw J ##,, {O -
!
f
sd $A2AA2
A A
AA
A A2A
A A2AA2 A/#A& $A/+A2)(r] r^ r_ r r r` r r" ra rb rc rd re rf rg r
AsyncIteratorri r- rj r3 r r: rk r r rl r rm rn r r
r r
rI rN rR r rW r\ ro r r rq rq s P*< P #8 5948,0HL;?E E #OOD 1 E
#OOD 1 E __S)
E __V\\#vs/C*C D
EE 8E
e $E P NR- - +1??>+J- S - ` <@tx* * $*OOC$8* RXRaRabpRq* V * ` Y]VZ049=48$(NR15LP&*;? V V $*??3T#U V
"??6??;Q+RS V //&**-
V OO$56V __R[[1V __S
!V &/J KV
.V $__-H IV s#V 8 V
V p hl ) C ) C ) V__UcEd ) pv ) V ko ( s ( s ( XfHg ( sw ( ` 59;?> > >
> #OOD 1
> 8>
> J -1;?
) ) )
__S) ) 8
)
e $) r rq )"rn rm rb core.client_wrapperr r core.request_optionsr types.converted_format_requestr types.exportr +types.lse_annotation_filter_options_requestr types.lse_export_creater
%types.lse_task_filter_options_requestr #types.serialization_options_requestr types.status7bf_enumr
types.user_simple_requestr
raw_clientr r types.convert_exports_responser castrl rk r rq ro r r r sb
H 2 D " \ 6 P N 1 : ? B v{{6::s#Q Q h G G r