Skip to main content

Blueprint Generator

Updated this week

Overview

The Blueprint Generator allows users to create custom document processing templates by uploading documents and defining data extraction fields through an intuitive visual interface. Users can draw boxes around specific areas of documents to identify and extract key information using OCR technology.

Accessing the Blueprint Generator

  1. Navigate to Inbox β†’ Any Docs

  2. Click on Blueprints to view the blueprint management interface

Blueprint Types

The system supports two types of blueprints:

  • VERYFI Blueprints: Read-only blueprints that cannot be modified

  • User Blueprints: Custom blueprints created and managed by users

Creating a New Blueprint

Step 1: Initialize Blueprint Creation

  1. Click Add Blueprint to open the blueprint creator

  2. The system will display a file uploader interface

Step 2: Upload Document

Supported file formats:

  • JPEG

  • PNG

  • PDF (including multi-page documents)

Upload your document by selecting the appropriate file type and choosing your file.

Step 3: Configure Blueprint Settings

Basic Information

  • Name: Provide a descriptive name for your blueprint

  • Type: Select the appropriate blueprint type from available options

Field Creation

  1. Draw Selection Box: Click and drag to draw a box around the text area you want to extract

  2. Automatic Text Recognition: The system uses OCR to automatically detect and populate text from the selected region

  3. Configure Field Properties:

    • Text: Review and edit the automatically detected text

    • JSON Field Name: Enter a unique key name for this field

      • Must be lowercase alphanumeric characters

      • Spaces are automatically converted to underscores

      • Uppercase letters are automatically converted to lowercase

    • Type: Select from available field types

    • Description: Add optional description for the field

  4. Click Save to add the field to your blueprint

Step 4: Field Management

Editing Fields

  • Visual Editing: Click on any drawn box to edit field properties

  • Table Editing: Click directly into table cells to modify values inline

  • Field List: View all fields in the fields table at the bottom of the interface

Field Requirements

  • JSON field names must be unique across all fields

  • All key names follow lowercase alphanumeric format with underscores

Working with Groups

Groups allow you to organize related fields into logical collections, which affects the JSON output structure.

Creating Groups

  1. Click Add Group

  2. Configure group properties:

    • JSON Key: Unique identifier for the group

    • Type: Choose between:

      • Object: Creates a single object containing grouped fields

      • List of Objects: Creates an array of objects

Group Requirements

  • Each group must contain at least one field

  • Groups without fields will display a warning icon

Assigning Fields to Groups

Method 1: Direct assignment

  1. Click on a field box

  2. Select group from the dropdown menu (appears when groups exist)

Method 2: Move existing field

  1. Click the menu icon for any field

  2. Select Move to Group

  3. Choose the target group from the modal

Group Management

  • Expand/Collapse: Click the folder icon to show/hide group contents

  • Visual Indicators: Alert icons indicate groups needing fields, folder icons show properly configured groups

Multi-Page PDF Support

For PDF documents with multiple pages:

Navigation

  • Page Footer: Use the navigation controls at the bottom right

  • Page Jumping: Enter a specific page number and press Enter or click away to jump directly

  • Page-Specific Fields: Fields are associated with specific pages where they were created

Page Management

  • Each page maintains its own set of field boxes

  • Navigate between pages to see relevant field overlays

  • Fields created on one page won't appear on others

Saving and Managing Blueprints

Saving Your Blueprint

  1. Enter a descriptive name for your blueprint

  2. Click Save to create the blueprint

  3. The blueprint will appear in the blueprints list with your specified name and type

Viewing Saved Blueprints

  1. Scroll down to the blueprints list

  2. Click View on any blueprint to open it

  3. The system will automatically:

    • Display the original document

    • Draw all saved field boxes

    • Show group organization

    • Expand grouped fields for easy viewing

Editing Existing Blueprints

  1. Open a blueprint using the View option

  2. Make necessary changes to fields or groups

  3. Click Save to update the blueprint

  4. Changes are immediately reflected in the blueprint list

Best Practices

Field Naming

  • Use descriptive, lowercase names

  • Avoid spaces (use underscores instead)

  • Ensure uniqueness across all fields

  • Follow consistent naming conventions

Box Drawing

  • Draw boxes precisely around target text

  • Ensure boxes fully encompass the text area

  • Verify OCR accuracy and adjust as needed

Group Organization

  • Group related fields logically

  • Consider your desired JSON output structure

  • Use descriptive group names

Document Quality

  • Use clear, high-resolution images

  • Ensure text is legible and not skewed

  • For PDFs, verify all pages are properly oriented

Troubleshooting

Common Issues

  • Missing text recognition: Redraw boxes more precisely around text

  • Invalid field names: Check for uppercase letters or special characters

  • Group warnings: Ensure each group has at least one assigned field

  • Page navigation: Use the footer controls for multi-page PDFs

Did this answer your question?