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.
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
idintegerOptional
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

created_agostringOptional>=1 characterDefaults to

Delta time from creation time

scoredoubleOptional

Prediction score

clusterintegerOptional

Cluster for the current prediction

neighborsmap from strings to anyOptional

Array of task IDs of the closest neighbors

mislabelingdoubleOptional

Related task mislabeling score

created_atdatetimeOptional
updated_atdatetimeOptional
modelintegerOptional

An ML Backend instance that created the prediction.

model_runintegerOptional

A run of a ModelVersion that created the prediction.

projectintegerOptional
Built with