API ReferencePredictions

Update prediction

Update a prediction. To find the prediction ID, use List predictions.

For information about the prediction format, see the JSON format reference in the Label Studio documentation.

Path parameters

idintegerRequired
Prediction ID

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
taskintegerOptional
Task ID for which the prediction is created
resultlist of maps from strings to anyOptional

Prediction result in JSON format. Read more about the format in the Label Studio documentation.

scoredoubleOptional
Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first.
model_versionstringOptional

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

Response

Updated prediction
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