Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idrLANG

Product Version
Report Note
Assignee

Resources & Remarks


Modification History

NameDateProduct VersionAction
Antje15 JUL 20212021 Autumncreated


...

As of Versionproduct version 2021 Autumn | component version 0.3
Request MethodPOST
Response FormatHTTP status code
Description



Excerpt

Sends a feedback to the AI engine ML Pipeline informing about the user decision for a suggested object typeone 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 store stores it. It is important to send the chosen document type back to the AI engine 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:

  • predictionId - id ID returned back by the AI engine when document classification is requestedclassification retrieval endpoints.
  • objectTypeId - objectTypeId user chose for the documentID of the object type selected by the user.

Meaning of HTTP status codes:

HTTP Status CodeDescription
200 OKOK
400 Bad RequestRequest is bad.
404 Not FoundSpecified predictionId was not found.
500 Internal Server ErrorError while storing feedback.

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
Code Block
languageyml
titlerequest body
{
   "properties": {
      "predictionId": {
          "value":473       
      },
      "feedbackData":{
          "objectTypeId": {
              "value": "Rechnung"          
          }
      }
   }
}

Result Example

(1) Successful

200 OK

(2) Not succelful:

400 Not Found

Code Block
languageyml
titleresponse 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..."
}


...