API ReferencePredictions

Update prediction

PATCH

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

Request

This endpoint expects an object.
task
integerOptional
Task ID for which the prediction is created
result
list of maps from strings to anyOptional

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

score
doubleOptional
Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first.
model_version
stringOptional
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

This endpoint returns an object
result
list of maps from strings to any
List of prediction results for the task
task
integer
id
integerOptional
model_version
stringOptional
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_ago
stringOptionalDefaults to
Delta time from creation time
score
doubleOptional
Prediction score
cluster
integerOptional
Cluster for the current prediction
neighbors
map from strings to anyOptional
Array of task IDs of the closest neighbors
mislabeling
doubleOptional
Related task mislabeling score
created_at
datetimeOptional
updated_at
datetimeOptional
model
integerOptional
An ML Backend instance that created the prediction.
model_run
integerOptional
A run of a ModelVersion that created the prediction.
project
integerOptional
Built with