PREDICT-API Endpoints

The PREDICT-API endpoints allow for the development of client applications with integrated AI functionality.

>> PREDICT-API Service

Beta Version

The PREDICT-API service is a component of the Artificial Intelligence Platform. This platform is not included in yuuvis® Momentum installations and is available as a beta version only on request.

HTTP Method
as of product version
PurposeResponse FormatDescription

Status Information

GET
as of 2021 Autumn
Retrieve status of Model Serving for the tenantJSON

Returns a JSON structure containing the status (activated or deactivated) of the processes provided by ML pipeline for the tenant.
/predict-api/system/status

GET
as of 2021 Autumn
Retrieve status of Model Serving for specified appJSON

Returns a JSON structure containing the status (activated or deactivated) of the processes provided by the ML pipeline for the app specified by appName within the tenant.
/predict-api/system/status/{appName}


Object Classification

GET
as of 2021 Autumn
Retrieve classification prediction for a single objectJSON

Retrieves a classification prediction for a single object identified by its objectId.
/predict-api/predict/classification/{objectId}

POST
as of 2021 Autumn
Retrieve classification prediction for multiple objectsJSON

Retrieves classification predictions for multiple objects identified by their objectId specified in the JSON request body.
/predict-api/predict/classification

POST
as of 2021 Autumn
Send classification feedback to Model ServingHTTP status code

Sends a feedback to the ML Pipeline informing about the user decision for one of the object types suggested in a prediction.
/predict-api/predict/classification/feedback


Metadata Extraction

GET
as of 2021 Autumn
Retrieve extraction prediction for a single objectJSON

Retrieves a metadata extraction prediction for the binary content file of a single object identified by its objectId.
/predict-api/predict/extraction/{objectId}

POST
as of 2021 Autumn
Retrieve extraction prediction for multiple objectsJSON

Retrieves metadata extraction predictions for the binary content files of multiple objects identified by their objectId specified in the JSON request body.
/predict-api/predict/extraction

POST
as of 2021 Autumn
Send extraction feedback to Model ServingHTTP status code

Sends feedback to the ML Pipeline informing about the user decision for one of the property values suggested in a prediction.
/predict-api/predict/extraction/feedback