ExtractedObject
| Property | Type | Description |
|---|---|---|
Id | String | The ID of the extracted object. |
Concept | String | The name of the concept that describes the structure of the object. |
ConceptId | String | The ID of the concept that describes the structure of the object. |
Annotations | Annotation [] | Extracted object metadata: location of the object on the image, recognition confidence, uncertainly recognized characters, etc. |
Fields | ExtractedFieldList [] | The extracted fields. |
Annotation
| Property | Type | Description |
|---|---|---|
Source | Enum {None / Text / Image} | The source of the extracted data (either Text or Image). If the document contains a text layer, this text layer will be the source of the extracted data. Otherwise, the image will be the source of the extracted data. “None” will indicate an unknown source. |
ImageRegions | ImageRegion [] | The coordinates of the field region. |
TextRanges | TextRange [] | The boundaries of the text in the text layer. Note: This property is not implemented. |
RawValue | String | The extracted value (prior to normalization or verification). |
Confidence | Integer | The confidence level of the extracted value. |
UncertainCharacters | UncertainCharacter [] | Information about uncertainly recognized characters. |
VerificationErrors | VerificationError [] | The list of errors generated by the verification rules. |
ImageRegion
| Property | Type | Description |
|---|---|---|
Page | String | The ID of the page in the source document. |
Rects | Integer [] | The region of the field on the page. The region is represented by an array of four coordinates. |
TextRange
| Property | Type | Description |
|---|---|---|
Begin | Integer | The start of the value. |
End | Integer | The end of the value. |
ExtractedFieldList
| Property | Type | Description |
|---|---|---|
Name | String | The name of the field. |
List | ExtractedField | The extracted value. |
ExtractedField
| Property | Type | Description |
|---|---|---|
Id | String | The ID of the field. |
Annotation | Annotation [] | Additional information about the field. |
Value | ExtractedObject / String / Boolean | The extracted value. |
isVerified | Boolean | Indicates whether the extracted value has been verified. |
NeedVerification | Boolean | Indicates whether the extracted value requires verification. |