API ReferencePredictions

List predictions

Get a list of all predictions. You can optionally filter these by task or by project. If you want to filter, you will need the project ID and/or task ID. Both of these can be found in the Label Studio URL when viewing a task, or you can use List all projects and Get tasks list.

The terms “predictions” and pre-annotations” are used interchangeably.

Predictions can be imported directly into Label Studio or generated by a connected ML backend.

To import predictions via the API, see Create prediction.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Query parameters

taskintegerOptional
Filter predictions by task ID
projectintegerOptional
Filter predictions by project ID

Response

Predictions list
resultlist of maps from strings to any
List of prediction results for the task
taskinteger
idinteger or null
model_versionstring or null

Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface

created_agostring or null>=1 characterDefaults to
Delta time from creation time
scoredouble or null
Prediction score
clusterinteger or null
Cluster for the current prediction
neighborsmap from strings to any or null
Array of task IDs of the closest neighbors
mislabelingdouble or null
Related task mislabeling score
created_atdatetime or null
updated_atdatetime or null
modelinteger or null
An ML Backend instance that created the prediction.
model_runinteger or null
A run of a ModelVersion that created the prediction.
projectinteger or null