Page Properties | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Table of Contents |
---|
...
Name | Type | Description |
---|---|---|
|
| Key A key (primary identification) of an entity type (e.g. |
|
| A normalized textual representation of the Text/Information provided by the extraction value (e.g. , for example, iban without spaces between the digits). |
| bounding-box | (Optional) bounding : Bounding box containing the position of the extraction value on the document. |
Code Block | ||
---|---|---|
| ||
//document extraction { "entity": "amount", "value": "20.00:EUR", "box": { ... } } |
...
Specific extractions
A specific extraction assigns a semantic property to the extraction. It also has an additional candidates
field:
Name | Type | Description |
---|---|---|
|
| (Optional): A reference to extraction candidates. See available extraction candidates for possible values. Extraction Entities for possible values. |
Code Block | ||
---|---|---|
| ||
//specific extractions
{
"amountToPay": {
"entity": "amount",
"value": "20.00:EUR",
"box": { ... },
"candidates": "amounts"
}
} |
...
Available specific extractions
Name | Description | Entity | Candidates |
---|---|---|---|
| The amount which yet to be paid. | amounts | |
| The bic of a payment recipient. | bics | |
| The document type of a given document. | n/a | |
| The IBAN of a document sender. | ibans | |
| The payment purpose text | n/a | |
| The payment recipient, beneficiary of a money transfer activity | paymentRecipients | |
| The payment reference. | n/a |
We differentiate between paymentPurpose and paymentReferences on remittance slips only (Verwendungszweck vs. Zahlungsreferenz).
On invoices, you only find the paymentPurpose field.