View Source

Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version	2021 Autumn
Report Note
Assignee	Antje

Resources & Remarks

Modification History

Add a new line to this table and fill it whenever you edit the page.

Name	Date	Product Version	Action
Antje	14 JUL 2021	2021 Autumn	created
Goran	18 OCT 2021	2021 Autumn	updated
Antje	25 NOV 2022	2022 Winter	remove beta version label, update endpoint descriptions

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

>> PREDICT-API Service

All endpoints are available via the Swagger UI https://<host>/predict-api/swagger-ui.html.

HTTP Method as of product version	Purpose	Response Format	Description
	Object Classification
POST as of 2022 Winter	Retrieve classification prediction for multiple objects	JSON	/predict-api/api/classification
GET as of 2022 Winter	Retrieve classification prediction for a single object	JSON	/predict-api/api/classification/{objectId}
POST as of 2022 Winter	Send classification feedback to Model Serving	HTTP status code	/predict-api/api/classification/feedback
POST as of 2022 Winter	Retrieve classification prediction for text	JSON	POST /predict-api/api/classification/text
	Metadata Extraction
POST as of 2022 Winter	Retrieve extraction prediction for multiple objects	JSON	/predict-api/api/extraction
GET as of 2022 Winter	Retrieve extraction prediction for a single object	JSON	/predict-api/api/extraction/{objectId}
POST as of 2022 Winter	Send extraction feedback to Model Serving	HTTP status code	/predict-api/api/extraction/feedback
POST as of 2022 Winter	Retrieve extraction prediction for a content file	JSON	/predict-api/api/extraction/file
	Metadata Extraction
GET as of 2022 Winter	Retrieve all records	JSON	/predict-api/api/admin/dictionaries/{dictionaryId}
DELETE as of 2022 Winter	Delete all records	HTTP status code	/predict-api/api/admin/dictionaries/{dictionaryId}
POST as of 2022 Winter	Create multiple records	JSON	/predict-api/api/admin/dictionaries/{dictionaryId}/batchupdate
POST as of 2022 Winter	Create single record	JSON	/predict-api/api/admin/dictionaries/{dictionaryId}/entries
POST as of 2022 Winter	Update specified record	JSON	/predict-api/api/admin/dictionaries/{dictionaryId}/entries/{entryId}
	Status Information
GET as of 2022 Winter	Retrieve information on tenant models	JSON	/predict-api/api/admin/history/models
POST as of 2022 Winter	Retrieve history request logs of the current tenant	JSON	/predict-api/api/admin/history/models/{modelId}/performance-logs
GET as of 2022 Winter	Retrieve information on system context models	JSON	/predict-api/api/system/history/models
POST as of 2022 Winter	Retrieve history logs of system context	JSON	/predict-api/api/system/history/models/{modelId}/performance-logs

Object Classification

Metadata Extraction

Metadata Extraction

Status Information