Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue
idDONE

Product Version2021 Autumn
Report Note
AssigneeAntje

Resources & Remarks


Modification History

NameDateProduct VersionAction
Antje14 JUL 20212021 Autumncreated
Goran18 OCT 20212021 Autumnupdated



Excerpt

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

...

Note
titleBeta Version

The PREDICT-API service is a component of the Auto ML 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
ML Pipeline
Model Serving for the tenantJSON

Insert excerpt

GET

POST /predict-api/api/

system/statusGET

admin/history/models/{modelId}/performance
POST /predict-api/api/

system/status

admin/history/models/{modelId}/performance
nopaneltrue

/predict-api/system/status

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

Insert excerpt

GET

POST /predict-api/api/system/

status

history/models/{

appName

modelId}/performance

GET

POST /predict-api/api/system/history/

status

models/{

appName

modelId}/performance
nopaneltrue

/predict-api/system/status/{appName}


Object Classification

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

Insert excerpt
GET /predict-api/

predict

api/classification/{objectId}
GET /predict-api/

predict

api/classification/{objectId}
nopaneltrue

/predict-api/predict/classification/{objectId}

POST
as of 2021 Autumn
Retrieve classification prediction for multiple 
object
objectsJSON

Insert excerpt
POST /predict-api/

predict

api/classification
POST /predict-api/

predict

api/classification
nopaneltrue

/predict-api/predict/classification

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

Insert excerpt
POST /predict-api/

predict

api/classification/feedback
POST /predict-api/

predict

api/classification/feedback
nopaneltrue

/predict-api/predict/classification/feedback


Metadata Extraction

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

Insert excerpt
GET /predict-api/

predict

api/extraction/{objectId}
GET /predict-api/

predict

api/extraction/{objectId}
nopaneltrue

/predict-api/predict/extraction/{objectId}

POST
as of 2021 Autumn
Retrieve extraction prediction for multiple 
object
objectsJSON

Insert excerpt

GET

POST /predict-api/

predict

api/extraction

GET

POST /predict-api/

predict

api/extraction
nopaneltrue

/predict-api/predict/extraction

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

Insert excerpt
POST /predict-api/

predict

api/extraction/feedback
POST /predict-api/

predict

api/extraction/feedback
nopaneltrue

/predict-api/predict/extraction/feedback