Extract
output fields, and are only supported for the following file/document types:
PDF
IMG
(jpeg, png, etc)metadata
object for each field. Learn more about Metadata here.
The polygon
and referenceText
fields are only returned if the includeBoundingBoxCitations
option is enabled in the processor config. This can be enabled through the Studio in the Build tab under “Advanced options”.
The shape of the polygon is as follows:
polygon
field represent the coordinates of the bounding box on the image or page.
They indicate the points of the polygon that form the bounding box. You may need to convert these values into a format suitable for your rendering library.
If your rendering library uses a coordinate system based on percentages of the total image or page size, you would need to perform an additional conversion step.
For PDFs, here is an example of how to apply a transform to the value in order to be rendered using react-pdf-viewer
or a similar library:
date
fieldsstring
fieldssignature
fieldsarray
fields (on nested string fields)object
fields (on nested string fields)includeBoundingBoxCitations
option is set to true
in the processor config, you will be able to use bounding boxes for all additional field types. These bounding boxes will have significantly higher coverage.
enum
fieldsnumber
fieldsboolean
fieldsnull
fields - If a field is declaratively null (e.g. an empty form input) this will be returned as a bounding box reference. If there is no declarative indication of null, bounding boxes will not be returned.react-pdf-viewer
or a similar library: