API ReferencePromptsRuns

Get inference run info

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Get information (status, metadata, etc) about an existing inference run

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

prompt_idintegerRequired
version_idintegerRequired

Query parameters

orderingstringOptional
Which field to use when ordering the results.
parent_modelintegerOptional
The ID of the parent model for this Inference Run
projectintegerOptional
The ID of the project this Inference Run makes predictions on
project_subsetenumOptional

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)

Allowed values:

Response

created_atdatetime
idinteger
parent_modelinteger
projectinteger
statusenum
* `Pending` - Pending * `InProgress` - InProgress * `Completed` - Completed * `Failed` - Failed * `Canceled` - Canceled
Allowed values:
completed_atdatetime or null
created_byinteger or null
job_idstring or null<=255 characters
Job ID for inference job for a ModelRun e.g. Adala job ID
organizationinteger or null
predictions_updated_atdatetime or null
project_subsetenum or null
  • All - All
  • HasGT - HasGT
  • Sample - Sample
Allowed values:
total_correct_predictionsinteger or null>=-2147483648<=2147483647
total_predictionsinteger or null>=-2147483648<=2147483647
total_tasksinteger or null>=-2147483648<=2147483647
triggered_atdatetime or null