Model Monitoring APIs

Note
These APIs are not officially supported and are subject to change in future releases.

Endpoints

DatasetJob

DataSource

ModelQuality

Model

registerDatasetConfig

PUT

/v2/api/model/{model_id}/register-dataset/{dataset_type}

Description

Dataset registration to a model.

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
dataset_typestringpath
prediction
ground_truth
Body Parameter
NameDescriptionRequired
undefined

Responses
CodeMessageDatatype
200Successfully registered dataset to the Model.
400Bad request input data.
403Unauthorised. The endpoint enforces authorisation.
405Method not allowed.
500Internal server error, check server logs.

getModelById

GET

/v2/api/model

Description

Model Operations.

Parameters
NameDescriptionRequiredTypeInExample
model_idstringquery
Responses
CodeMessageDatatype
200Successfully fetched the Model.
400Bad request input data.
403Unauthorised. The endpoint enforces authorisation.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

registerModelThroughConfig

PUT

/v2/api/model

Description

Model Operations.

Body Parameter
NameDescriptionRequired
undefined

Responses
CodeMessageDatatype
200Successfully registered the Model.
400Bad request input data.
403Unauthorised. The endpoint enforces authorisation.
405Method not allowed.
500Internal server error, check server logs.

deleteModelById

DELETE

/v2/api/model

Description

Model Operations.

Parameters
NameDescriptionRequiredTypeInExample
model_idstringquery
Responses
CodeMessageDatatype
200Successfully deleted the Model.
400Bad request input data.
403Unauthorised. The endpoint enforces authorisation.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

listModels

GET

/v2/api/models

Description

Parameters
NameDescriptionRequiredTypeInExample
pageNumberintegerquery
pageSizeintegerquery
numberOfLastChecksToFetchintegerquery
searchQuerystringquery
modelTypestringquery
Responses
CodeMessageDatatype
200Successfully fetched the Model.
400Bad request input data.
403Unauthorised. The endpoint enforces authorisation.
405Method not allowed.
500Internal server error, check server logs.