Page Comparison

After the classification is done and the predicted document types are shown to the user, the user decides which one is the actual correct type and store stores it. It is important to send the chosen document type back to the AI engine 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:

• predictionId - id  – ID returned back by the AI engine when document classification is requestedobjectTypeId - objectTypeId user chose for the documentclassification retrieval endpoints.
• feedbackData.objectTypeId.value – ID of the object type selected by the user.

Meaning of HTTP status codes:

HTTP Status Code	Description
200 OK	OK
400 Bad Request	Request is bad.
404 Not Found

Schema is not defined for these parameters. 

Specified predictionId was not found.
500 Internal Server Error	Error while

getting status information

storing feedback.

If an error is thrown, it will be a JSON structure is returned as response body.

/predict-api/api/classification/feedback

{
   "properties": {
      "predictionId": {
          "value":473       
      },
      "feedbackData":{
          "objectTypeId": {
              "value": "Rechnung"          
          }
      }
   }
}

(1) Successful

200 OK

(2) Not succelful:

400 Not FoundBad Request

{
    "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..."
}