Key Value Extraction

Requirements

These packages are required to use these features in production. Trial keys have unlimited access to all features

Package: Smart Data ExtractionModule: Data ExtractionLive demo

Apryse's Key-Value Extraction engine helps you automatically identify and extract meaningful key-value pairs from PDFs — even when the document is unstructured or doesn't contain form fields. Whether you're processing invoices, resumes, or complex reports, KVE saves hours of manual tagging by turning documents into structured JSON.

NEW FEATURE

New in 11.8!

Exclusive to the Apryse SDK, Key-Value Extraction also supports pulling data from CAD and other technical drawing title blocks.

How It Works

The engine scans each page for likely key terms (e.g., labels, field names, categories) and maps them to associated values (e.g., specific data, answers, identifiers). This hyponymic relationship allows KVE to structure data from real-world documents without templates or prior annotation.

JSON Output Specification

Refer to the following specifications to learn more about the output JSON format:

• JSON Specification for Generic Key-Value Extraction

Extract key-value pairs as JSON file

Specify the name of the input PDF file and the name of the output JSON file, then select the Generic Key Value engine:

C#

DataExtractionModule.ExtractData("newsletter.pdf", "newsletter.json", DataExtractionModule.DataExtractionEngine.e_generic_key_value);

C++

DataExtractionModule::ExtractData("newsletter.pdf", "newsletter.json", DataExtractionModule::e_GenericKeyValue);

Go

DataExtractionModuleExtractData("newsletter.pdf", "newsletter.json", DataExtractionModuleE_GenericKeyValue)

Java

DataExtractionModule.extractData("newsletter.pdf", "newsletter.json", DataExtractionModule.DataExtractionEngine.e_generic_key_value);

JavaScript

await PDFNet.DataExtractionModule.extractData("newsletter.pdf", "newsletter.json", PDFNet.DataExtractionModule.DataExtractionEngine.e_GenericKeyValue);

PHP

DataExtractionModule::ExtractData("newsletter.pdf", "newsletter.json", DataExtractionModule::e_GenericKeyValue);

Python

DataExtractionModule.ExtractData("newsletter.pdf", "newsletter.json", DataExtractionModule.e_GenericKeyValue)

Ruby

DataExtractionModule.ExtractData("newsletter.pdf", "newsletter.json", DataExtractionModule::E_GenericKeyValue)

VB

DataExtractionModule.ExtractData("newsletter.pdf", "newsletter.json", DataExtractionModule.DataExtractionEngine.e_generic_key_value)

Extract key-value pairs as JSON string

Specify the name of the input PDF file, then select the Generic Key Value engine:

C#

string json = DataExtractionModule.ExtractData("newsletter.pdf", DataExtractionModule.DataExtractionEngine.e_generic_key_value);

C++

UString json = DataExtractionModule::ExtractData("newsletter.pdf", DataExtractionModule::e_GenericKeyValue);

Go

json := DataExtractionModuleExtractData("newsletter.pdf", DataExtractionModuleE_GenericKeyValue).(string)

Java

String json = DataExtractionModule.extractData("newsletter.pdf", DataExtractionModule.DataExtractionEngine.e_generic_key_value);

JavaScript

const json = await PDFNet.DataExtractionModule.extractDataAsString('newsletter.pdf', PDFNet.DataExtractionModule.DataExtractionEngine.e_GenericKeyValue);

PHP

$json = DataExtractionModule::ExtractData("newsletter.pdf", DataExtractionModule::e_GenericKeyValue);

Python

json = DataExtractionModule.ExtractData("newsletter.pdf", DataExtractionModule.e_GenericKeyValue)

Ruby

json = DataExtractionModule.ExtractData("newsletter.pdf", DataExtractionModule::E_GenericKeyValue)

VB

Dim json As String = DataExtractionModule.ExtractData("newsletter.pdf", DataExtractionModule.DataExtractionEngine.e_generic_key_value)

Optional Configurations

Select OCR Language

Password-Protected PDFs

Page Range

Region of Interest

Detect Empty Fields

Use Key-Value Extraction engine with DetectAndAddFormFieldsToPDF

By default, DetectAndAddFormFieldsToPDF uses the Form Field Detection engine. You can force the function to use the Form Field Key-Value Extraction engine using the "Form Extraction Engine" option.

C#

PDFDoc doc = new PDFDoc("formfields.pdf");
DataExtractionOptions options = new DataExtractionOptions();
options.SetFormExtractionEngine("FormKeyValue");
DataExtractionModule.DetectAndAddFormFieldsToPDF(doc, options);

C++

PDFDoc doc("formfields.pdf");
DataExtractionOptions options;
options.SetFormExtractionEngine("FormKeyValue");
DataExtractionModule::DetectAndAddFormFieldsToPDF(doc, &options);

Go

doc = NewPDFDoc("formfields.pdf")
options := NewDataExtractionOptions()
options.SetFormExtractionEngine("FormKeyValue")
DataExtractionModuleDetectAndAddFormFieldsToPDF(doc, options)

Java

PDFDoc doc = new PDFDoc("formfields.pdf");
DataExtractionOptions options = new DataExtractionOptions();
options.setFormExtractionEngine("FormKeyValue");
DataExtractionModule.detectAndAddFormFieldsToPDF(doc, options);

JavaScript

const doc = await PDFNet.PDFDoc.createFromFilePath("formfields.pdf");
const options = new PDFNet.DataExtractionModule.DataExtractionOptions();
options.setFormExtractionEngine('FormKeyValue');
await PDFNet.DataExtractionModule.detectAndAddFormFieldsToPDF(doc, options);

PHP

$doc = new PDFDoc("formfields.pdf");
$options = new DataExtractionOptions();
$options->SetFormExtractionEngine("FormKeyValue");
DataExtractionModule::DetectAndAddFormFieldsToPDF($doc, $options);

Python

doc = PDFDoc("formfields.pdf")
options = DataExtractionOptions()
options.SetFormExtractionEngine("FormKeyValue")
DataExtractionModule.DetectAndAddFormFieldsToPDF(doc, options)

Ruby

doc = PDFDoc.new("formfields.pdf")
options = DataExtractionOptions.new()
options.SetFormExtractionEngine("FormKeyValue")
DataExtractionModule.DetectAndAddFormFieldsToPDF(doc, options)

VB

Dim doc as PDFDoc = New PDFDoc("formfields.pdf")
Dim options = New DataExtractionOptions()
options.SetFormExtractionEngine("FormKeyValue")
DataExtractionModule.DetectAndAddFormFieldsToPDF(doc, options)

NOTE

This option only has an effect on the `DetectAndAddFormFieldsToPDF` function. Passing this option to `ExtractData` will have no effect, as the `engine` parameter will take precedence.