...
| Page Properties | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
Resources & Remarks Modification History
|
| Excerpt |
|---|
The PREDICT-API endpoints allow for the development of client applications with integrated AI functionality. |
...
| title | Beta Version |
|---|
...
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 | GET||||||||||||||||||||||||
| POST as of | 2021 Autumn2022 Winter | Retrieve | status of Model Serving for the tenantclassification prediction for multiple objects | JSON |
| admin/history/models/{modelId}/performance
| admin/history/models/{modelId}/performance
/predict-api/ | systemapi/ | statusclassification | |||||||||||||||
| GET as of 2021 Autumn2022 Winter | Retrieve status of Model Serving for specified appclassification 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 | GET
/predict-api/systemapi/statusclassification/{appName} | Object Classification | ||||||||||||||||||||
| POST as of | 2021 Autumn2022 Winter | Retrieve classification prediction for | a single objecttext | JSON |
| GET
| {objectId}
| GET
| {objectId}
POST /predict-api/ | predictapi/classification/ | {objectId}text | |||||||||||||
Metadata Extraction | ||||||||||||||||||||||||
| POST as of 2021 Autumn2022 Winter | Retrieve classificationextraction 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 2021 Autumn2022 Winter | Send classification 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/ | classificationextraction/ | feedbackfile | |||||||||||||||||||
Metadata Extraction | ||||||||||||||||||||||||
| GET as of | 2021 Autumn2022 Winter | Retrieve | extraction prediction for a single objectall records | JSON |
| extraction
| objectId
| extraction/{objectId}
/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 |
| /extraction
| objectId
| as of 2021 AutumnRetrieve extraction prediction for multiple objects/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 |
| extraction
| /extraction
/predict-api/api/admin/history/models/{modelId}/performance-logs | |||||||||||||||||||
| GET as of 2022 Winter | Retrieve information on system context models | JSON |
| /extraction
/predict-api/api/system/history/models | ||||||||||||||||||||
| POST as of | 2021 AutumnSend extraction feedback to Model Serving | HTTP status code2022 Winter | Retrieve history logs of system context | JSON |
| /extraction/feedback
| /extraction/feedback
/predict-api/ | predict/extraction/feedbackapi/system/history/models/{modelId}/performance-logs | ||||||||||||||||