The Human Feedback API allows you to provide feedback to the extractions from Eagle Doc. This feedback is used to improve the accuracy of the extractions in the future.
We continually refine the algorithm's performance. While the interface retains its current form, there will be no adjustments to the API version. However, distinct version numbers will be evident in the 'version' field of the JSON response.
Server
We currently operate one server in Frankfurt, Germany. This server is supported by a load balancer, allowing it to scale smoothly based on the workload. If you require a dedicated server or specific location, please get in touch with us.
Finance Document Feedback API - version 1 (v1)
This feedback allows the user to give feedback on the extractions of finance documents, so that the future extractions get better.
Click the following box to see the detailed description of this API if the box is not expanded.
Parameters
api-key (header) |
API key which you will receive with your subscription here |
file (form-data) |
File of the receipts or invoices. To be sent in the body as form-data with the key 'file'. If the document has multiple pages, you can attach them all as separate image files (supported image formats include: png, jpg, tif) or as a PDF.
|
corrected (form-data) |
Corrected json file of the extraction. With Eagle Doc OCR APIs, you get your extractions in structured format of JSON. If something goes wrong, you can make corrections on the json file and sent back to Eagle Doc through this API as parameter 'corrected'.
|
Responses
200 |
OK is returned to indicate that the document was processed successfully.
The response contains a list of page segments. Each page segment is an array of two digits, from which the first one indicate the start page of the segment and the second one the end page of the segment.
The result contains a message from Eagle Doc to indicate the status of the operation.
An example result can look like this:
{
"message": "The template is updated successfully."
}
|
403 |
BadCredentialException is used to indicate that for example the API key is not valid.
|
404 |
FileNotFoundException is used to indicate that there is no file found.
|
405 |
MethodNotAllowedException: Access to the API not allowed. There are multiple reasons possible: you reached the agreed quota, your contract expired or another internal error. Please contact us if the error persists.
|
500 |
InternalServerErrorException is used to indicate that something went wrong. Reason is not known.
|