]jR= d dl Zd dlZddlmZmZ ddlmZ ddlm Z ddl
m Z ddl m
Z
dd lmZmZ dd
lmZ ej& ej( d Z G d d
Z G d d Zy) N )AsyncClientWrapperSyncClientWrapper)RequestOptions)CancelModelRunResponse)ModelRun)ProjectSubsetEnum )AsyncRawRunsClient
RawRunsClient) ListRunsRequestProjectSubset.c e Zd ZdefdZedefd Zdddddddeded e j e d
e j e d e j e d e j e d
e j e
de j e fdZeeeeeeeedd deded ede j e de j e de j e de j ej( d e j e de j e de j e de j e d
e j e
defdZdddededed
e j e
def
dZy)
RunsClientclient_wrapperc & t | | _ y N)r )r _raw_clientselfr s N/root/env/lib/python3.12/site-packages/label_studio_sdk/prompts/runs/client.py__init__zRunsClient.__init__ s (G returnc | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawRunsClient
r r s r with_raw_responsez RunsClient.with_raw_response r Nordering parent_modelprojectproject_subsetrequest_options prompt_id
version_idr r! r" r# r$ c ^ | 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)
Get information (status, metadata, etc) about an existing inference run
Parameters
----------
prompt_id : int
version_id : int
ordering : typing.Optional[str]
Which field to use when ordering the results.
parent_model : typing.Optional[int]
The ID of the parent model for this Inference Run
project : typing.Optional[int]
The ID of the project this Inference Run makes predictions on
project_subset : typing.Optional[ListRunsRequestProjectSubset]
Defines which tasks are operated on (e.g. HasGT will only operate on tasks with a ground truth annotation, but All will operate on all records)
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[ModelRun]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.runs.list(
prompt_id=1,
version_id=1,
)
r r listdata r r% r& r r! r" r# r$ _responses r r) zRunsClient.list! sA t $$)) %) + *
~~ r job_idonly_missing_predictions organizationpredictions_updated_atr# total_correct_predictionstotal_predictions total_tasksr$ r. r/ r0 r1 r2 r3 r4 c
h | 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)
Run a prompt inference.
Parameters
----------
prompt_id : int
version_id : int
project : int
job_id : typing.Optional[str]
Job ID for inference job for a ModelRun e.g. Adala job ID
only_missing_predictions : typing.Optional[bool]
When true, only tasks without successful predictions for this prompt version are submitted for inference.
organization : typing.Optional[int]
predictions_updated_at : typing.Optional[dt.datetime]
project_subset : typing.Optional[ProjectSubsetEnum]
total_correct_predictions : typing.Optional[int]
total_predictions : typing.Optional[int]
total_tasks : typing.Optional[int]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ModelRun
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.runs.create(
prompt_id=1,
version_id=1,
project=1,
)
r" r. r/ r0 r1 r# r2 r3 r4 r$ r creater* r r% r& r" r. r/ r0 r1 r# r2 r3 r4 r$ r, s r r8 zRunsClient.createf sP P $$++ %=%#9)&? /# + ,
~~ r r$ inference_run_idc X | 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)
Cancel the inference run for the given api
Parameters
----------
prompt_id : int
version_id : int
inference_run_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
CancelModelRunResponse
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.prompts.runs.cancel(
prompt_id=1,
version_id=1,
inference_run_id=1,
)
r: r cancelr* r r% r& r; r$ r, s r r> zRunsClient.cancel s0 \ $$++IzCSet+u ~~ r )__name__
__module__ __qualname__r r propertyr r inttypingOptionalstrr
r Listr r) OMITbooldtdatetimer r8 r r> r r r r s H*; H = *.-1(,HL;?C C C
//#& C ooc*
C %C (DEC 8C
X C V (,:>-1?C=A:>26,0;? V V V
V $
V #)//$"7V ooc*V !' <V (9:V $*??3#7V "??3/V __S)V 8 V
V | <@
/ / / / 8
/
/ r r c e Zd ZdefdZedefd Zdddddddeded e j e d
e j e d e j e d e j e d
e j e
de j e fdZeeeeeeeedd deded ede j e de j e de j e de j ej( d e j e de j e de j e de j e d
e j e
defdZdddededed
e j e
def
dZy)AsyncRunsClientr c & t | | _ y r )r r r s r r zAsyncRunsClient.__init__ s -^Lr r c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawRunsClient
r r s r r z!AsyncRunsClient.with_raw_response r r Nr r% r& r r! r" r# r$ c z 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 information (status, metadata, etc) about an existing inference run
Parameters
----------
prompt_id : int
version_id : int
ordering : typing.Optional[str]
Which field to use when ordering the results.
parent_model : typing.Optional[int]
The ID of the parent model for this Inference Run
project : typing.Optional[int]
The ID of the project this Inference Run makes predictions on
project_subset : typing.Optional[ListRunsRequestProjectSubset]
Defines which tasks are operated on (e.g. HasGT will only operate on tasks with a ground truth annotation, but All will operate on all records)
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[ModelRun]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.runs.list(
prompt_id=1,
version_id=1,
)
asyncio.run(main())
r Nr( r+ s r r) zAsyncRunsClient.list sO D **// %) + 0
~~
s &;9;r- r. r/ r0 r1 r2 r3 r4 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)
Run a prompt inference.
Parameters
----------
prompt_id : int
version_id : int
project : int
job_id : typing.Optional[str]
Job ID for inference job for a ModelRun e.g. Adala job ID
only_missing_predictions : typing.Optional[bool]
When true, only tasks without successful predictions for this prompt version are submitted for inference.
organization : typing.Optional[int]
predictions_updated_at : typing.Optional[dt.datetime]
project_subset : typing.Optional[ProjectSubsetEnum]
total_correct_predictions : typing.Optional[int]
total_predictions : typing.Optional[int]
total_tasks : typing.Optional[int]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ModelRun
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.runs.create(
prompt_id=1,
version_id=1,
project=1,
)
asyncio.run(main())
r6 Nr7 r9 s r r8 zAsyncRunsClient.createL s^ ` **11 %=%#9)&? /# + 2
~~
s +A >A r: r; c t 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)
Cancel the inference run for the given api
Parameters
----------
prompt_id : int
version_id : int
inference_run_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
CancelModelRunResponse
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.prompts.runs.cancel(
prompt_id=1,
version_id=1,
inference_run_id=1,
)
asyncio.run(main())
r: Nr= r? s r r> zAsyncRunsClient.cancel sD l **11 z#3_ 2
~~
s #868)r@ rA rB r r rC r r rD rE rF rG r
r rH r r) rI rJ rK rL r r8 r r> rM r r rO rO s M*< M #5 *.-1(,HL;?K K K
//#& K ooc*
K %K (DEK 8K
X K f (,:>-1?C=A:>26,0;? ^ ^ ^
^ $
^ #)//$"7^ ooc*^ !' <^ (9:^ $*??3#7^ "??3/^ __S)^ 8 ^
^ L <@
9 9 9 9 8
9
9 r rO )rL rK rE core.client_wrapperr r core.request_optionsr types.cancel_model_run_responser types.model_runr types.project_subset_enumr
raw_clientr r &types.list_runs_request_project_subsetr
castAnyrI r rO rM r r r^ sS
H 2 E ' : 9 P v{{6::s#[ [ |u u r