]j9 d dl Z d dlZd dlmZ ddlmZ ddlmZmZ ddl m
Z
m Z ddl m
Z
ddlmZ dd lmZ dd
lmZ ej( ej* d Z G d d
Z G d d Zy) N)JSONDecodeError )ApiError)AsyncClientWrapperSyncClientWrapper)AsyncHttpResponse HttpResponse)jsonable_encoder)RequestOptions)construct_type)MaybeExpandedComment.c e Zd ZdefdZdddddddddej e dej e dej e dej e d ej e d
ej e d ej e
d e ej e
fd
Zdeeeeeedddej e dej e dej ej dej e dej e dej ej dej e d ej e
d e e
fdZej& dddddddddej e dej e dej e dej e d
ej e dej e d ej e
d ej( e ej( e fd Zddddedej e d ej e
d e e
fdZddddedej e d ej e
d e d fdZdeeeeeedddedej e dej e dej ej dej e dej e dej ej dej e d ej e
d e e
fdZy) RawCommentsClientclient_wrapperc || _ y N_client_wrapperselfr s N/root/env/lib/python3.12/site-packages/label_studio_sdk/comments/raw_client.py__init__zRawCommentsClient.__init__
- N
annotation
annotatorsdraftexpand_created_byorderingprojectsrequest_optionsr r r r r r! r" returnc Z | j j j dd||||||d| } d|j cxk rdk rin nft j
t j t t t j t |j } t || S |j }
t |j t |j |
# t $ r6 t |j t |j |j w xY w)
a{
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all comments for a specific annotation ID.
Parameters
----------
annotation : typing.Optional[int]
annotators : typing.Optional[str]
draft : typing.Optional[int]
expand_created_by : typing.Optional[bool]
ordering : typing.Optional[str]
Which field to use when ordering the results.
projects : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[typing.List[MaybeExpandedComment]]
List of comments
api/comments/GETr r r r r r! methodparamsr" , type_object_responsedata status_codeheadersbody)r httpx_clientrequestr4 typingcastListr
r jsonr r r dictr5 text r r r r r r r! r" _response_data_response_jsons r listzRawCommentsClient.list s V ((55== ( ( %6 $ $
, >
ti++1c1 KK 45" $kk*> ? ) 0 $YUCC &^^ -N 9#8#8$yGXGXBY`noo ty'<' r" rE rF rG r> c , | j j j ddd|i||||||dddi|t } d| j cxk rd k rGn nDt j t t t | j
}
t | |
S | j } t | j t | j | # t $ r6 t | j t | j | j w xY w)
a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a comment for a specific annotation ID.
Parameters
----------
expand_created_by : typing.Optional[bool]
Expand the created_by field
annotation : typing.Optional[int]
classifications : typing.Optional[typing.Any]
Classifications applied by a reviewer or annotator
draft : typing.Optional[int]
is_resolved : typing.Optional[bool]
True if the comment is resolved
region_ref : typing.Optional[typing.Any]
Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
text : typing.Optional[str]
Reviewer or annotator comment
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[MaybeExpandedComment]
r% POSTr r rE r rF rG r> content-typeapplication/jsonr) r* r< r5 r" omitr+ r, r- r0 r3 )r r7 r8 OMITr4 r9 r: r
r r< r r r r= r5 r> r r r rE r rF rG r> r" r@ rA rB s r createzRawCommentsClient.create^ s d ((55== #%6 )#2 * (
2 ,% >
( ti++1c1 (" 2 ) 0 $YUCC &^^ -N 9#8#8$yGXGXBY`noo ty'<'
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Export comments to CSV file
Parameters
----------
annotation : typing.Optional[int]
annotators : typing.Optional[str]
draft : typing.Optional[int]
expand_created_by : typing.Optional[bool]
projects : typing.Optional[str]
tz : typing.Optional[str]
Timezone in which to export the data. Format IANA timezone name, e.g. "America/New_York"
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[HttpResponse[typing.Iterator[bytes]]]
CSV file with comments
api/comments/export/r& r r r r r! rS r( r# c dj cxk rdk r=n n:j dd nd } t d j | D S j j }t j t j | # t $ r6 t j t j j w xY w)Nr+ r,
chunk_sizec 3 K | ] }| y wr .0_chunks r z._stream.. s 5xf5xs rX r0 r3 ) r4 getr
iter_bytesreadr< r r r= r5 r> _chunk_sizerB r@ r" s r _streamz)RawCommentsClient.export.._stream s i 3 39c9Q`Qlo&9&9,&Mrv +%.5x9K_K_kvK_Kw5x NN$%.^^%5N
9+@+@$yO`O`Jahvww ' "$-$9$94 HYHYCZajaoao s AB B ?C N)r r7 streamr r9 Iteratorbytes
r r r r r r! rS r" re r@ s
` @r exportzRawCommentsClient.export s X
!
!
.
.
5
5 " ( ( %6 $
, 6
x\&//%*@ A
x )O; s 1A9/A-$ A9-A62A9r r" idc & | j j j dt | ddd|i| } d|j cxk rdk rGn nDt j t t t |j }t || S |j }t |j t |j |
# t $ r6 t |j t |j |j
w xY 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 comment by ID for an annotation.
Parameters
----------
id : str
expand_created_by : typing.Optional[bool]
Expand the created_by field
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[MaybeExpandedComment]
r% /r& r r( r+ r, r- r0 r3 )r r7 r8 r
r4 r9 r: r
r r< r r r r= r5 r> r rl r r" r@ rA rB s r r` zRawCommentsClient.get s > ((55== ,R 01 3#%6 ,
>
ti++1c1 (" 2 ) 0 $YUCC &^^ -N 9#8#8$yGXGXBY`noo ty'<'
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a comment by ID
Parameters
----------
id : str
expand_created_by : typing.Optional[bool]
Expand the created_by field
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[None]
r% rn DELETEr r( r+ r, Nr0 r3 ) r r7 r8 r
r4 r r< r r r= r5 r> r rl r r" r@ rB s r deletezRawCommentsClient.delete4 s < ((55== ,R 01 3#%6 ,
>
ti++1c1#YTBB &^^ -N 9#8#8$yGXGXBY`noo ty'<'
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific comment by ID.
Parameters
----------
id : str
expand_created_by : typing.Optional[bool]
Expand the created_by field
annotation : typing.Optional[int]
classifications : typing.Optional[typing.Any]
Classifications applied by a reviewer or annotator
draft : typing.Optional[int]
is_resolved : typing.Optional[bool]
True if the comment is resolved
region_ref : typing.Optional[typing.Any]
Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
text : typing.Optional[str]
Reviewer or annotator comment
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[MaybeExpandedComment]
r% rn PATCHr rJ rK rL rM r+ r, r- r0 r3 )r r7 r8 r
rO r4 r9 r: r
r r< r r r r= r5 r>
r rl r r rE r rF rG r> r" r@ rA rB s
r updatezRawCommentsClient.updateb s, j ((55== ,R 01 3#%6 )#2 * (
2 ,% >
( ti++1c1 (" 2 ) 0 $YUCC &^^ -N 9#8#8$yGXGXBY`noo ty'<'H H \ 48;? 4p 4p "??40 4p
8 4p
* +
4pt 48;? ,p ,p "??40 ,p
8 ,p
d
,pd 48+/7;&*-126%);?Vp Vp "??40 Vp
OOC( Vp 4
Vp s#Vp __T*Vp OOFJJ/Vp ooc"Vp 8Vp
* +Vpr r c e Zd ZdefdZdddddddddej e dej e dej e dej e d ej e d
ej e d ej e
d e ej e
fd
Zdeeeeeedddej e dej e dej ej dej e dej e dej ej dej e d ej e
d e e
fdZej& dddddddddej e dej e dej e dej e d
ej e dej e d ej e
d ej( e ej( e fd Zddddedej e d ej e
d e e
fdZddddedej e d ej e
d e d fdZdeeeeeedddedej e dej e dej ej dej e dej e dej ej dej e d ej e
d e e
fdZy) AsyncRawCommentsClientr c || _ y r r r s r r z AsyncRawCommentsClient.__init__ r r Nr r r r r r r! r" r# c v K | j j j dd||||||d| d{ } d|j cxk rdk rin nft j
t j t t t j t |j } t || S |j }
t |j t |j |
7 # t $ r6 t |j t |j |j
w xY ww) a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all comments for a specific annotation ID.
Parameters
----------
annotation : typing.Optional[int]
annotators : typing.Optional[str]
draft : typing.Optional[int]
expand_created_by : typing.Optional[bool]
ordering : typing.Optional[str]
Which field to use when ordering the results.
projects : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[typing.List[MaybeExpandedComment]]
List of comments
r% r& r' r( Nr+ r, r- r0 r3 )r r7 r8 r4 r9 r: r; r
r r< r r r r= r5 r> r? s r rC zAsyncRawCommentsClient.list s! V ..;;CC ( ( %6 $ $
, D
ti++1c1 KK 45" $kk*> ? ) 0 ))%HH &^^ -N 9#8#8$yGXGXBY`noo5
0 ty'<' c H K | j j j ddd|i||||||dddi|t d{ } d | j cxk rd
k rGn nDt j t t t | j }
t | |
S | j } t | j t | j |
7 # t $ r6 t | j t | j | j
w xY ww)a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a comment for a specific annotation ID.
Parameters
----------
expand_created_by : typing.Optional[bool]
Expand the created_by field
annotation : typing.Optional[int]
classifications : typing.Optional[typing.Any]
Classifications applied by a reviewer or annotator
draft : typing.Optional[int]
is_resolved : typing.Optional[bool]
True if the comment is resolved
region_ref : typing.Optional[typing.Any]
Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
text : typing.Optional[str]
Reviewer or annotator comment
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[MaybeExpandedComment]
r% rI r rJ rK rL rM Nr+ r, r- r0 r3 )r r7 r8 rO r4 r9 r: r
r r< r r r r= r5 r> rP s r rQ z AsyncRawCommentsClient.create s+ d ..;;CC #%6 )#2 * (
2 ,% D
( ti++1c1 (" 2 ) 0 ))%HH &^^ -N 9#8#8$yGXGXBY`nooC
> ty'<'
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Export comments to CSV file
Parameters
----------
annotation : typing.Optional[int]
annotators : typing.Optional[str]
draft : typing.Optional[int]
expand_created_by : typing.Optional[bool]
projects : typing.Optional[str]
tz : typing.Optional[str]
Timezone in which to export the data. Format IANA timezone name, e.g. "America/New_York"
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[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
CSV file with comments
rU r& rV r( Nr# c K dj cxk rdk r=n n:j dd nd } t d j | 2 S j d { j }t j t j | 7 ?# t $ r6 t j t j j w xY ww)Nr+ r, rX c 2 K | 3 d { }| 7
6 y wr rZ r[ s r r^ zAAsyncRawCommentsClient.export.._stream.. s !k!k6&!k!ks r_ r0 r3 ) r4 r` r aiter_bytesareadr< r r r= r5 r> rc s r re z.AsyncRawCommentsClient.export.._stream s i 3 39c9Q`Qlo&9&9,&Mrv 0%.!kY=R=R^i=R=j!k $//+++%.^^%5N
9+@+@$yO`O`Jahvww
,& "$-$9$94 HYHYCZajaoao s; C.AB, C.B, *B*+B, ?+C.*B, ,?C++C.)r r7 rf r r9
AsyncIteratorrh ri s
` @r rj z AsyncRawCommentsClient.export[ s X ''44;; " ( ( %6 $
, <
" "
x#4V5I5I%5P#Q
x / != " " "< "= " " " "sV 5B!BB!0B -B.B 5 B! B
B!B
B! B B B B!rk rl c B K | j j j dt | ddd|i| d{ } d|j cxk rdk rGn nDt j t t t |j }t ||
S |j }t |j t |j | 7 # t $ r6 t |j t |j |j w xY ww) a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific comment by ID for an annotation.
Parameters
----------
id : str
expand_created_by : typing.Optional[bool]
Expand the created_by field
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[MaybeExpandedComment]
r% rn r& r r( Nr+ r, r- r0 r3 )r r7 r8 r
r4 r9 r: r
r r< r r r r= r5 r> ro s r r` zAsyncRawCommentsClient.get s > ..;;CC ,R 01 3#%6 ,
D
ti++1c1 (" 2 ) 0 ))%HH &^^ -N 9#8#8$yGXGXBY`noo+
& ty'<'
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a comment by ID
Parameters
----------
id : str
expand_created_by : typing.Optional[bool]
Expand the created_by field
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[None]
r% rn rq r r( Nr+ r, r0 r3 ) r r7 r8 r
r4 r r< r r r= r5 r> rr s r rs z AsyncRawCommentsClient.delete s < ..;;CC ,R 01 3#%6 ,
D
ti++1c1()$GG &^^ -N 9#8#8$yGXGXBY`noo
ty'<'
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific comment by ID.
Parameters
----------
id : str
expand_created_by : typing.Optional[bool]
Expand the created_by field
annotation : typing.Optional[int]
classifications : typing.Optional[typing.Any]
Classifications applied by a reviewer or annotator
draft : typing.Optional[int]
is_resolved : typing.Optional[bool]
True if the comment is resolved
region_ref : typing.Optional[typing.Any]
Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
text : typing.Optional[str]
Reviewer or annotator comment
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[MaybeExpandedComment]
r% rn ru r rJ rK rL rM Nr+ r, r- r0 r3 )r r7 r8 r
rO r4 r9 r: r
r r< r r r r= r5 r> rv s
r rw z AsyncRawCommentsClient.update s; j ..;;CC ,R 01 3#%6 )#2 * (
2 ,% D
( ti++1c1 (" 2 ) 0 ))%HH &^^ -N 9#8#8$yGXGXBY`nooC
> ty'<'r sZ
( % G @ 4 1 6 ? v{{6::s#ep epP
fp fpr