POST /predict-api/api/classification/feedback
As of Version | product version 2022 Winter | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Request Method | POST | ||||||||||
Response Format | HTTP status code | ||||||||||
Description | Sends a feedback to the ML Pipeline informing about the user decision for one of the object types suggested in a prediction. After the classification is done and the predicted document types are shown to the user, the user decides which one is the correct type and stores it. It is important to inform the ML Pipeline about this decision in order to improve future predictions by calling this feedback endpoint. In the JSON request body, the following parameters are expected:
Meaning of HTTP status codes:
If an error is thrown, a JSON structure is returned as response body. | ||||||||||
Request Header | Content-Type: application/json X-ID-TENANT-NAME: tenant_name | ||||||||||
Request Example | /predict-api/api/classification/feedback { "properties": { "predictionId": { "value":473 }, "feedbackData":{ "objectTypeId": { "value": "Rechnung" } } } }
| ||||||||||
Result Example | (1) Successful
(2) Not succelful:
{ "statusCode": 400, "timestamp": "2020-12-25T09:42:33.386+00:00", "message": "JSON parse error: Unrecognized field \"objectTyyyyypeId\" (class com.os.ai.predict.domain.classification.ClassificationFeedbackRequestData), not marked as ignorable..." } |