]jddlZddlZddlmZmZddlmZddlm Z ddl m Z ddl m Z dd lmZmZdd lmZdd lmZej*ej,d ZGd dZGddZy)N)AsyncClientWrapperSyncClientWrapper)RequestOptions) Annotation)LastActionEnum)SelectedItemsRequest)AsyncRawAnnotationsClientRawAnnotationsClient)!CreateBulkAnnotationsResponseItem)DeleteBulkAnnotationsResponse.c*ZeZdZdefdZedefdZdddeje de d eje de fd Zeeeeeeeeeeeeeeeeeedd d ejed eje dejej$dejedeje dejedeje dejedeje deje deje dejejej*eej.fdejedeje dejeje dejedeje dejed eje dej2ef(dZddde d eje defdZddde d eje ddfd Zeeeeeeeedd! de d eje dejedejedeje dejejej*eej.fdeje deje dejed eje defd"Zddd#de d$ejed eje dej2efd%Z eeeeeeeedd! de d eje dejedejedeje dejejej*eej.fdeje deje dejed eje defd&Z!y)'AnnotationsClientclient_wrapperc&t||_yN)r)r _raw_clientselfrs M/root/env/lib/python3.12/site-packages/label_studio_sdk/annotations/client.py__init__zAnnotationsClient.__init__s/~Nreturnc|jS)z Retrieves a raw implementation of this client that returns raw responses. Returns ------- RawAnnotationsClient rrs rwith_raw_responsez#AnnotationsClient.with_raw_responserNrequest_optionsidsprojectr!cV|jj|||}|jS)a Delete multiple annotations by their IDs. The deletion is processed synchronously. Returns the count of deleted annotations in the response. Parameters ---------- ids : typing.Sequence[int] List of annotation IDs to delete project : int request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DeleteBulkAnnotationsResponse Annotations deleted successfully Examples -------- from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) client.annotations.delete_bulk( ids=[1], project=1, ) r"r#r!r delete_bulkdatarr"r#r! _responses rr'zAnnotationsClient.delete_bulk"s-B$$00S'[j0k ~~r bulk_created completed_bydraft_created_at ground_truth import_id last_actionlast_created_by lead_timeparent_annotationparent_predictionr#resultselected_itemstasktasks unique_id updated_by was_cancelledr!r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<cv|jj||||||||| | | | | ||||||}|jS)a Create multiple annotations at once Parameters ---------- bulk_created : typing.Optional[bool] Annotation was created in bulk mode completed_by : typing.Optional[int] draft_created_at : typing.Optional[dt.datetime] Draft creation time ground_truth : typing.Optional[bool] This annotation is a Ground Truth (ground_truth) import_id : typing.Optional[int] Original annotation ID that was at the import step or NULL if this annotation wasn't imported last_action : typing.Optional[LastActionEnum] Action which was performed in the last annotation history item * `prediction` - Created from prediction * `propagated_annotation` - Created from another annotation * `imported` - Imported * `submitted` - Submitted * `updated` - Updated * `skipped` - Skipped * `accepted` - Accepted * `rejected` - Rejected * `fixed_and_accepted` - Fixed and accepted * `deleted_review` - Deleted review last_created_by : typing.Optional[int] User who created the last annotation history item lead_time : typing.Optional[float] How much time it took to annotate the task parent_annotation : typing.Optional[int] Points to the parent annotation from which this annotation was created parent_prediction : typing.Optional[int] Points to the prediction from which this annotation was created project : typing.Optional[int] Project ID for this annotation result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] List of annotation results for the task selected_items : typing.Optional[SelectedItemsRequest] task : typing.Optional[int] Corresponding task for this annotation tasks : typing.Optional[typing.Sequence[int]] unique_id : typing.Optional[str] updated_by : typing.Optional[int] Last user who updated this annotation was_cancelled : typing.Optional[bool] User skipped the task request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.List[CreateBulkAnnotationsResponseItem] Bulk annotations created successfully Examples -------- from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) client.annotations.create_bulk() r+r create_bulkr(rr,r-r.r/r0r1r2r3r4r5r#r6r7r8r9r:r;r<r!r*s rr?zAnnotationsClient.create_bulkFseT$$00%%-%#+//)!'+'1 *~~ridcT|jj||}|jS)a, Retrieve a specific annotation for a task using the annotation result ID. Parameters ---------- id : int request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- Annotation Retrieved annotation Examples -------- from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) client.annotations.get( id=1, ) r rgetr(rrAr!r*s rrDzAnnotationsClient.gets)6$$((_(M ~~rcT|jj||}|jS)a Delete an annotation. This action can't be undone! 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.annotations.delete( id=1, ) r rdeleter(rEs rrHzAnnotationsClient.deletes)4$$++B+P ~~r r-r/r3r#r6r8r;r<r!c d|jj||||||||| |  } | jS)a> Update existing attributes on an annotation. Parameters ---------- id : int completed_by : typing.Optional[int] User ID of the person who created this annotation ground_truth : typing.Optional[bool] This annotation is a Ground Truth lead_time : typing.Optional[float] How much time it took to annotate the task (in seconds) project : typing.Optional[int] Project ID for this annotation result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format) task : typing.Optional[int] Corresponding task for this annotation updated_by : typing.Optional[int] Last user who updated this annotation was_cancelled : typing.Optional[bool] User skipped the task request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- Annotation Updated annotation Examples -------- from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) client.annotations.update( id=1, ground_truth=True, result=[ { "from_name": "bboxes", "image_rotation": 0, "original_height": 1080, "original_width": 1920, "to_name": "image", "type": "rectanglelabels", "value": { "height": 60, "rotation": 0, "values": {"rectanglelabels": ["Person"]}, "width": 50, "x": 20, "y": 30, }, } ], was_cancelled=False, ) rIrupdater( rrAr-r/r3r#r6r8r;r<r!r*s rrLzAnnotationsClient.updatesJh$$++ %%!'+,  ~~rorderingr!rOcV|jj|||}|jS)a~ List all annotations for a task. Parameters ---------- id : int Task ID ordering : typing.Optional[str] Which field to use when ordering the results. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.List[Annotation] Annotation Examples -------- from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) client.annotations.list( id=1, ) rNrlistr(rrArOr!r*s rrRzAnnotationsClient.listds-B$$))"xQ`)a ~~rc d|jj||||||||| |  } | jS)aq Add annotations to a task like an annotator does. The content of the result field depends on your labeling configuration. For example, send the following data as part of your POST request to send an empty annotation with the ID of the user who completed the task: ```json { "result": {}, "was_cancelled": true, "ground_truth": true, "lead_time": 0, "task": 0 "completed_by": 123 } ``` Parameters ---------- id : int Task ID completed_by : typing.Optional[int] User ID of the person who created this annotation ground_truth : typing.Optional[bool] This annotation is a Ground Truth lead_time : typing.Optional[float] How much time it took to annotate the task (in seconds) project : typing.Optional[int] Project ID for this annotation result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format) task : typing.Optional[int] Corresponding task for this annotation updated_by : typing.Optional[int] Last user who updated this annotation was_cancelled : typing.Optional[bool] User skipped the task request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- Annotation Created annotation Examples -------- from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) client.annotations.create( id=1, ground_truth=True, result=[ { "from_name": "bboxes", "image_rotation": 0, "original_height": 1080, "original_width": 1920, "to_name": "image", "type": "rectanglelabels", "value": { "height": 60, "rotation": 0, "values": {"rectanglelabels": ["Person"]}, "width": 50, "x": 20, "y": 30, }, } ], was_cancelled=False, ) rIrcreater(rMs rrVzAnnotationsClient.createsJH$$++ %%!'+,  ~~r)"__name__ __module__ __qualname__rrpropertyr rtypingSequenceintOptionalrrr'OMITbooldtdatetimerfloatDictstrAnyr Listr r?rrDrHrLrRrVrrrrsO*;O #7  nr"ooc*"58"KQ??[iKj" &"N/3-19=.2*.7;04,02626(,QU@D%)7;*.+//3;?+ood+ooc*  !//"++6  ood+ ??3'__^4 -??5)"??3/"??3/% CO0L MN(<= ooc"!"vs34#$??3'%&OOC('(t,)* 8+, 6 7-BRVcv~/NZd<UY&//.2Q]aB.2.2,0(,QU%)+//3;?` `ooc* ` ood+ ` ??5) `%` CO0L MN`ooc"`OOC(`t,` 8` `F<@tx""$*OOC$8"RXRaRabpRq" Z "P.2.2,0(,QU%)+//3;?p pooc* p ood+ p ??5) p%p CO0L MNpooc"pOOC(pt,p 8p prrc*ZeZdZdefdZedefdZdddeje de d eje de fd Zeeeeeeeeeeeeeeeeeedd d ejed eje dejej$dejedeje dejedeje dejedeje deje deje dejejej*eej.fdejedeje dejeje dejedeje dejed eje dej2ef(dZddde d eje defdZddde d eje ddfd Zeeeeeeeedd! de d eje dejedejedeje dejejej*eej.fdeje deje dejed eje defd"Zddd#de d$ejed eje dej2efd%Z eeeeeeeedd! de d eje dejedejedeje dejejej*eej.fdeje deje dejed eje defd&Z!y)'AsyncAnnotationsClientrc&t||_yr)r rrs rrzAsyncAnnotationsClient.__init__s4NSrrc|jS)z Retrieves a raw implementation of this client that returns raw responses. Returns ------- AsyncRawAnnotationsClient rrs rrz(AsyncAnnotationsClient.with_raw_responserrNr r"r#r!crK|jj|||d{}|jS7w)a Delete multiple annotations by their IDs. The deletion is processed synchronously. Returns the count of deleted annotations in the response. Parameters ---------- ids : typing.Sequence[int] List of annotation IDs to delete project : int request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- DeleteBulkAnnotationsResponse Annotations deleted successfully Examples -------- import asyncio from label_studio_sdk import AsyncLabelStudio client = AsyncLabelStudio( api_key="YOUR_API_KEY", ) async def main() -> None: await client.annotations.delete_bulk( ids=[1], project=1, ) asyncio.run(main()) r%Nr&r)s rr'z"AsyncAnnotationsClient.delete_bulk s:R**663ap6qq ~~r "757r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<cK|jj||||||||| | | | | ||||||d{}|jS7w)a Create multiple annotations at once Parameters ---------- bulk_created : typing.Optional[bool] Annotation was created in bulk mode completed_by : typing.Optional[int] draft_created_at : typing.Optional[dt.datetime] Draft creation time ground_truth : typing.Optional[bool] This annotation is a Ground Truth (ground_truth) import_id : typing.Optional[int] Original annotation ID that was at the import step or NULL if this annotation wasn't imported last_action : typing.Optional[LastActionEnum] Action which was performed in the last annotation history item * `prediction` - Created from prediction * `propagated_annotation` - Created from another annotation * `imported` - Imported * `submitted` - Submitted * `updated` - Updated * `skipped` - Skipped * `accepted` - Accepted * `rejected` - Rejected * `fixed_and_accepted` - Fixed and accepted * `deleted_review` - Deleted review last_created_by : typing.Optional[int] User who created the last annotation history item lead_time : typing.Optional[float] How much time it took to annotate the task parent_annotation : typing.Optional[int] Points to the parent annotation from which this annotation was created parent_prediction : typing.Optional[int] Points to the prediction from which this annotation was created project : typing.Optional[int] Project ID for this annotation result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] List of annotation results for the task selected_items : typing.Optional[SelectedItemsRequest] task : typing.Optional[int] Corresponding task for this annotation tasks : typing.Optional[typing.Sequence[int]] unique_id : typing.Optional[str] updated_by : typing.Optional[int] Last user who updated this annotation was_cancelled : typing.Optional[bool] User skipped the task request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.List[CreateBulkAnnotationsResponseItem] Bulk annotations created successfully Examples -------- import asyncio from label_studio_sdk import AsyncLabelStudio client = AsyncLabelStudio( api_key="YOUR_API_KEY", ) async def main() -> None: await client.annotations.create_bulk() asyncio.run(main()) r+Nr>r@s rr?z"AsyncAnnotationsClient.create_bulk6ssd**66%%-%#+//)!'+'7  *~~+ s2AAArAcpK|jj||d{}|jS7w)a Retrieve a specific annotation for a task using the annotation result ID. Parameters ---------- id : int request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- Annotation Retrieved annotation Examples -------- import asyncio from label_studio_sdk import AsyncLabelStudio client = AsyncLabelStudio( api_key="YOUR_API_KEY", ) async def main() -> None: await client.annotations.get( id=1, ) asyncio.run(main()) r NrCrEs rrDzAsyncAnnotationsClient.gets7F**..r?.SS ~~T !646cpK|jj||d{}|jS7w)ag Delete an annotation. This action can't be undone! 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.annotations.delete( id=1, ) asyncio.run(main()) r NrGrEs rrHzAsyncAnnotationsClient.deletes7D**11"o1VV ~~WrqrIc K|jj||||||||| |  d{} | jS7w)a Update existing attributes on an annotation. Parameters ---------- id : int completed_by : typing.Optional[int] User ID of the person who created this annotation ground_truth : typing.Optional[bool] This annotation is a Ground Truth lead_time : typing.Optional[float] How much time it took to annotate the task (in seconds) project : typing.Optional[int] Project ID for this annotation result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format) task : typing.Optional[int] Corresponding task for this annotation updated_by : typing.Optional[int] Last user who updated this annotation was_cancelled : typing.Optional[bool] User skipped the task request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- Annotation Updated annotation Examples -------- import asyncio from label_studio_sdk import AsyncLabelStudio client = AsyncLabelStudio( api_key="YOUR_API_KEY", ) async def main() -> None: await client.annotations.update( id=1, ground_truth=True, result=[ { "from_name": "bboxes", "image_rotation": 0, "original_height": 1080, "original_width": 1920, "to_name": "image", "type": "rectanglelabels", "value": { "height": 60, "rotation": 0, "values": {"rectanglelabels": ["Person"]}, "width": 50, "x": 20, "y": 30, }, } ], was_cancelled=False, ) asyncio.run(main()) rINrKrMs rrLzAsyncAnnotationsClient.update sXx**11 %%!'+2   ~~  )><>rNrOcrK|jj|||d{}|jS7w)a List all annotations for a task. Parameters ---------- id : int Task ID ordering : typing.Optional[str] Which field to use when ordering the results. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.List[Annotation] Annotation Examples -------- import asyncio from label_studio_sdk import AsyncLabelStudio client = AsyncLabelStudio( api_key="YOUR_API_KEY", ) async def main() -> None: await client.annotations.list( id=1, ) asyncio.run(main()) rNNrQrSs rrRzAsyncAnnotationsClient.listts:R**//XWf/gg ~~hrnc K|jj||||||||| |  d{} | jS7w)a7 Add annotations to a task like an annotator does. The content of the result field depends on your labeling configuration. For example, send the following data as part of your POST request to send an empty annotation with the ID of the user who completed the task: ```json { "result": {}, "was_cancelled": true, "ground_truth": true, "lead_time": 0, "task": 0 "completed_by": 123 } ``` Parameters ---------- id : int Task ID completed_by : typing.Optional[int] User ID of the person who created this annotation ground_truth : typing.Optional[bool] This annotation is a Ground Truth lead_time : typing.Optional[float] How much time it took to annotate the task (in seconds) project : typing.Optional[int] Project ID for this annotation result : typing.Optional[typing.Sequence[typing.Dict[str, typing.Any]]] Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format) task : typing.Optional[int] Corresponding task for this annotation updated_by : typing.Optional[int] Last user who updated this annotation was_cancelled : typing.Optional[bool] User skipped the task request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- Annotation Created annotation Examples -------- import asyncio from label_studio_sdk import AsyncLabelStudio client = AsyncLabelStudio( api_key="YOUR_API_KEY", ) async def main() -> None: await client.annotations.create( id=1, ground_truth=True, result=[ { "from_name": "bboxes", "image_rotation": 0, "original_height": 1080, "original_width": 1920, "to_name": "image", "type": "rectanglelabels", "value": { "height": 60, "rotation": 0, "values": {"rectanglelabels": ["Person"]}, "width": 50, "x": 20, "y": 30, }, } ], was_cancelled=False, ) asyncio.run(main()) rINrUrMs rrVzAsyncAnnotationsClient.createsXX**11 %%!'+2   ~~  rt)"rWrXrYrrrZr rr[r\r]r^rrr'r_r`rarbrrcrdrerfr rgr r?rrDrHrLrRrVrhrrrjrjsT*<T #<  nr*ooc**58*KQ??[iKj* &*^/3-19=.2*.7;04,02626(,QU@D%)7;*.+//3;?+Good+Gooc* G !//"++6 G ood+ G??3'G__^4G -G??5)G"??3/G"??3/G%G CO0L MNG(<=G ooc"!G"vs34#G$??3'%G&OOC('G(t,)G* 8+G, 6 7-GRX\$C$V__^5T$`j$L[_#s#8W#cg#R.2.2,0(,QU%)+//3;?h hooc* h ood+ h ??5) h%h CO0L MNhooc"hOOC(ht,h 8h hV<@tx**$*OOC$8*RXRaRabpRq* Z *`.2.2,0(,QU%)+//3;?x xooc* x ood+ x ??5) x%x CO0L MNxooc"xOOC(xt,x 8x xrrj)rbrar[core.client_wrapperrrcore.request_optionsrtypes.annotationrtypes.last_action_enumrtypes.selected_items_requestr raw_clientr r +types.create_bulk_annotations_response_itemr &types.delete_bulk_annotations_responsercastrfr_rrjrhrrrsV G1)3?GZQv{{6::s#eeP]]r