Predictions

Create prediction

Changed on

Create a prediction for a specific task.

post/api/predictions/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/predictions/
  • Auth
    API key in header Authorization

Request body

clusterinteger nullable

Cluster for the current prediction

mislabelingnumber double

Related task mislabeling score

modelinteger nullable

An ML Backend instance that created the prediction.

model_runinteger nullable

A run of a ModelVersion that created the prediction.

model_versionstring

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

neighborsunknown
projectinteger nullable
resultobject[] required

List of prediction results for the task

scorenumber double nullable

Prediction score

taskinteger required

Response

Created prediction

clusterinteger nullable

Cluster for the current prediction

created_agostring required

Delta time from creation time

created_atstring date-time required
idinteger required
mislabelingnumber double

Related task mislabeling score

modelinteger nullable

An ML Backend instance that created the prediction.

model_runinteger nullable

A run of a ModelVersion that created the prediction.

model_versionstring

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

neighborsunknown
projectinteger nullable
resultobject[] required

List of prediction results for the task

scorenumber double nullable

Prediction score

taskinteger required
updated_atstring date-time required

Changes

  • e1ba2ecdbabbRevision changes
    • breaking

      request body became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property format changed from no format to double

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/x-www-form-urlencoded to the request body

    • info

      added the media type multipart/form-data to the request body

    • info

      the request property became nullable