Versions Compared

Key

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

...

Name

Type

Description

entity

string

A key (primary identification) of an entity type, for example, iban. See Extraction Entities for possible values.

value

string

A normalized textual representation of the Text/Information provided by the extraction value, for example, iban without spaces between the digits.

box

bounding-box

Optional: Bounding box containing the position of the extraction value on the document.

Code Block
languagejson
//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

candidates

string

Optional: A reference to extraction candidates. See Extraction Entities for possible values.

Code Block
languagejson
//specific extractions

{
  "amountToPay": {
      "entity": "amount",
      "value": "20.00:EUR",
      "box": { ... },
      "candidates": "amounts"
  }
}

...

Available specific extractions

...