As of Version | product version 2021 Autumn | component version 0.3 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
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 classification is done and predicted document types are shown to the user, the user decides which one is the actual type and stores it. It is important to inform ML Pipeline about this decision in order to improve future predictions by calling this feedback endpoint. In the JSON request body, following parameters are expected:
Meaning of HTTP status codes:
If an error is thrown, it will be a JSON structure returned as response body. | ||||||||||
Request Header | Content-Type: application/json X-ID-TENANT-NAME: tenant_name | ||||||||||
Request Example | /predict-api/predict/classification/feedback request body { "properties": { "predictionId": { "value":473 }, "feedbackData":{ "objectTypeId": { "value": "Rechnung" } } } }
| ||||||||||
Result Example | (1) Successful 200 OK (2) Not succelful: 400 Bad Request response body { "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..." } |
General
Content
Integrations