Versions Compared

Key

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

...

Info

You should send the feedback only on those labels that has been physically seen by the user. Unseen labels should be filtered out.

Request

Give feedback and correct or verify multiple specific labeled extraction patterns with a single PUT or POST request to the document extractions URI.

The labels must correspond to the names of the extraction types e.g. amountToPay. See available specific extractions for possible values.

Headers

Header

Value

Content-Type

application/vnd.gini.v1+json

Body

Key

Type

Description

extractions

object

Feedback on atomic extractions

compoundExtractions

object

Feedback on compound extractions

The boxes are optional. Boxes should only be sent if your use case visualize the document with the locations of the extractions. Thus, the user can confirm the correct location of a extraction.

Response

Status Code

Description

204 (No Content)

The feedback was successfully processed.

404 (Not Found)

The document or the label could not be found.

406 (Not Acceptable)

The request headers were not set correctly.

422 (Unprocessable Entity)

At least one value was not valid regarding entity validation rules of the label.