Form Fields

Overview

form_fields() finds every fillable field on each page of a PDF or image: blank lines, empty boxes, tick boxes and signature blanks. Each field has a type, a box and the printed label next to it.

Basic Usage

from datalab_sdk import DatalabClient

client = DatalabClient()

result = client.form_fields("form.pdf")

for page in result.pages:
    for field in page["fields"]:
        print(page["page"], field["field_type"], field["bbox"], field["label"])

Form Fields Options

from datalab_sdk import FormFieldsOptions

options = FormFieldsOptions(page_range="0-2", skip_cache=True)
result = client.form_fields("form.pdf", options=options)

Option	Type	Default	Description
`max_pages`	int	None	Maximum pages to process. Do not combine it with `page_range`.
`page_range`	str	None	Pages to process, for example `"0-2"`
`skip_cache`	bool	`False`	Skip cached results
`webhook_url`	str	None	URL that receives a call when the request completes
`processing_location`	str	None	Residency region, for example `"eu"`

Form Fields Result

Field	Type	Description
`success`	bool	Whether detection succeeded
`status`	str	Processing status
`pages`	list	One dict per page with `page`, `fields` and `error`
`page_count`	int	Number of pages processed
`runtime`	float	Processing time in seconds
`cost_breakdown`	dict	Cost details

Each entry of fields has:

Key	Description
`field_type`	One of `signature`, `initials`, `email`, `name`, `firstName`, `lastName`, `company`, `title`, `date`, `text`, `checkbox`, `radio`
`bbox`	`[x0, y0, x1, y1]` as fractions of the page width and height, origin at the top-left corner
`label`	The printed label, or an empty string

A page with error set was not read, or the model repeated itself and its fields may be incomplete.

Draw the Boxes

Multiply the fractions by the size of the page image:

from PIL import Image, ImageDraw

image = Image.open("page.png")
draw = ImageDraw.Draw(image)
width, height = image.size

for field in result.pages[0]["fields"]:
    x0, y0, x1, y1 = field["bbox"]
    draw.rectangle([x0 * width, y0 * height, x1 * width, y1 * height], outline="red", width=2)

image.save("page_fields.png")

Saving the Result

result.save_output("output/form")  # writes output/form.form_fields.json

From URL

result = client.form_fields(file_url="https://example.com/form.pdf")

Async Usage

import asyncio
from datalab_sdk import AsyncDatalabClient

async def find_fields():
    async with AsyncDatalabClient() as client:
        result = await client.form_fields("form.pdf")
        return result.pages

asyncio.run(find_fields())

CLI

datalab form-fields form.pdf --output_dir output

The command takes a file or a folder, and the same --page_range, --max_pages and --skip_cache options as the other commands.

Next Steps

Form Fields Recipe

The API, the response format and the options.

Form Filling SDK

Fill the fields you found.

CLI

Process files and folders from the command line.

File Management

Upload, list, and manage files in Datalab storage.

Welcome

On-prem

Platform

Overview

Basic Usage

Form Fields Options

Form Fields Result

Draw the Boxes

Saving the Result

From URL

Async Usage

CLI

Next Steps

Form Fields Recipe

Form Filling SDK

CLI

File Management

​Overview

​Basic Usage

​Form Fields Options

​Form Fields Result

​Draw the Boxes

​Saving the Result

​From URL

​Async Usage

​CLI

​Next Steps

Form Fields Recipe

Form Filling SDK

CLI

File Management

Overview

Basic Usage

Form Fields Options

Form Fields Result

Draw the Boxes

Saving the Result

From URL

Async Usage

CLI

Next Steps