Submit Feedback on Extractions

Feedback is approved or corrected extraction values that are submitted by you back to the extraction system.

You should always submit the feedback on extractions. The feedback that is correctly submitted enables Gini to measure the extraction quality in order to provide the best possible user experience. Moreover, it helps us continuously improve the extraction system and perform valuable data analytics for you.

Gini employs various machine learning techniques in order to learn from feedback automatically. Therefore, it is equally important for Gini to receive both feedback on correct and incorrect extractions.

Ways of submitting feedback

There are currently two ways to submit the feedback.

The first and the most common one is to submit the complete feedback in one request. This is the easiest way if your frontend (application) displays the extractions on a screen in an editable form. A user can modify the extractions before pressing the confirmation button.

The second (rarely used) way is where the final approvement signal (button click) is not possible. In such case, send the feedback on one label per request.

Types of feedback

There are three different types of feedback:

• positive feedback (preferred): the extraction was correct and confirmed by the user without modification.

• complementary feedback: the extraction system extracted nothing, for example, the response doesn't contain the requested label. The user manually entered the correct value.

• negative feedback: the extraction was incomplete or erroneous. The user manually corrected the extraction.

• informative feedback: the extraction was changed for another reason, for example, if a line item is returned, the quantity extraction gets feedback "0" and a return reason.

The Gini Pay API allows you to submit feedback on multiple extractions for a single document with a single request. It is strongly recommended that you submit your feedback in this way for two reasons. On the one hand, the total number of round trips is reduced to one and the feedback is handled internally as a batch. Therefore, the update is more efficient for multiple extractions compared to submitting the feedback with each separate request. On the other hand, Gini's machine learning training techniques can benefit from the feedback on multiple extractions since Gini is aware of the fact that single parts of the submitted feedback belong together.

Request

Headers

Body

Response

Test Example

In order to test the integration of the feedback functionality, we offer a PDF test document with the expected outcome in a JSON format. This document can be used for an integration test of Gini’s Pay API in general. Furthermore, we provide a query for sending feedback where all fields are correct except for the amountToPay. After sending this feedback, we show you how to ensure that the feedback with your confirmation and correction for the field values was successful.

• Sending the test document to the Gini Pay API. See Submit Files.

• Requesting the results. See Retrieve Extractions.

• You should get a JSON like in the example.

• Correcting the document with the following JSON. Here we change the amountToPay from "995.00:EUR" to "950.00:EUR" and confirm the other field values (iban, bic, paymentRecipient, paymentReference).

{
   "feedback": {
       "amountToPay": {
           "value": "950.00:EUR"
       },
       "iban": {
           "value": "DE68130300000017850360"
       },
       "bic": {
           "value": "BYLADEM1001"
       },
       "paymentPurpose": {
           "value": "RE-20170512-02"
       },
       "paymentRecipient": {
           "value": "Fahrrad Rückenwind"
       }
   }
}

Submit Feedback on Invalid Extractions

Request

Response