Add an Image field
Click Add Image in the toolbar. A new Image field appears in the data form.An Image field cannot have more than one region. To extract multiple images, enable Allow multiple items and add one image per instance.
General properties
| Property | Description |
|---|---|
| Field name | Unique within the skill. Cannot contain: . , / : * ? " < > |. Maximum length: 90 characters. |
| Required field | If enabled and the field is empty after extraction, the document goes to manual review with a rule error. |
| Allow multiple items | Whether the field can have multiple instances (for example, extracting signatures from each party on an agreement as separate images). |
Access extracted images
During data export, Vantage extracts each image using its region coordinates and saves it as a JPG. You can access extracted images the same way as other extracted data:- Vantage API — Retrieve extracted images alongside other field values.
- Custom activity or Output activity scripts — The Field object exposes
Value(the filename) andImage(the binary contents). - Shared folder export (Output activity) — The JSON export includes the image filename in each image field’s
valuekey. Image files are placed in a subfolder named after the JSON file.
File naming
During export, Vantage names each image file based on the field and its position in the skill hierarchy:| Field configuration | Filename |
|---|---|
Top-level field Signature | Signature.jpg |
Multiple instances of Signature | Signature_1.jpg, Signature_2.jpg |
Field nested in Group1 > Group2 as Signature | Group1_Group2_Signature.jpg |
If the resulting filename would exceed 256 characters (including separators, instance numbers, and the
.jpg extension), Vantage falls back to Field_{guid}.jpg, where {guid} is the GUID of the image field.