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	Retrieves classification predictions for multiple objects identified by their `objectId` specified in the JSON request body. /predict-api/api/classification
GET as of 2022 Winter	Retrieve classification prediction for a single object	JSON	Retrieves a classification prediction for a single object identified by its `objectId`. /predict-api/api/classification/{objectId}
POST as of 2022 Winter	Send classification feedback to Model Serving	HTTP 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/api/classification/feedback
POST as of 2022 Winter	Retrieve classification prediction for text	JSON	Retrieves classification predictions based on a plain text, e.g., a text rendition of a binary content file. POST /predict-api/api/classification/text
	Metadata Extraction
POST as of 2022 Winter	Retrieve extraction prediction for multiple objects	JSON	Retrieves metadata extraction predictions for the binary content files of multiple objects identified by their `objectId` specified in the JSON request body. /predict-api/api/extraction
GET as of 2022 Winter	Retrieve extraction prediction for a single object	JSON	Retrieves a metadata extraction prediction for the binary content file of a single object identified by its `objectId`. /predict-api/api/extraction/{objectId}
POST as of 2022 Winter	Send extraction feedback to Model Serving	HTTP 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/api/extraction/feedback
POST as of 2022 Winter	Retrieve extraction prediction for a content file	JSON	Retrieves an extraction prediction for the binary content file that is passed in the request body. /predict-api/api/extraction/file
	Metadata Extraction
GET as of 2022 Winter	Retrieve all records	JSON	Retrieves all record from the Elasticsearch dictionary identified by its `dictionaryId`. /predict-api/api/admin/dictionaries/{dictionaryId}
DELETE as of 2022 Winter	Delete all records	HTTP status code	Deletes the records in the Elasticsearch dictionary identified by its `dictionaryId`. /predict-api/api/admin/dictionaries/{dictionaryId}
POST as of 2022 Winter	Create multiple records	JSON	Saves the records specified in a CSV file in the Elasticsearch dictionary identified by its `dictionaryId`. /predict-api/api/admin/dictionaries/{dictionaryId}/batchupdate
POST as of 2022 Winter	Create single record	JSON	Saves a record specified in the JSON request body in the Elasticsearch dictionary identified by its `dictionaryId`. /predict-api/api/admin/dictionaries/{dictionaryId}/entries
POST as of 2022 Winter	Update specified record	JSON	Update a record specified by its `entryId` with the data passed in the JSON request body in the Elasticsearch dictionary identified by its `dictionaryId`. /predict-api/api/admin/dictionaries/{dictionaryId}/entries/{entryId}
	Status Information
GET as of 2022 Winter	Retrieve information on tenant models	JSON	Retrieve information on models that are already used by the currently active tenant. /predict-api/api/admin/history/models
POST as of 2022 Winter	Retrieve history request logs of the current tenant	JSON	Retrieve the tenant history request logs by the parameters specified in the JSON request body for the model identified by `modelId`. /predict-api/api/admin/history/models/{modelId}/performance-logs
GET as of 2022 Winter	Retrieve information on system context models	JSON	Retrieves information on the system context models already used in any tenant. /predict-api/api/system/history/models
POST as of 2022 Winter	Retrieve history logs of system context	JSON	Retrieve the system context history request logs by the parameters specified in the JSON request body for the model identified by `modelId`. /predict-api/api/system/history/models/{modelId}/performance-logs

Browser not supported