Key Value Extraction

NEW FEATURE

New in 11.3!

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.

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.

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:

1DataExtractionModule.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:

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

Optional Configurations:

Select OCR Language

Password-Protected PDFs

Page Range

Region of Interest

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.

1PDFDoc doc = new PDFDoc("formfields.pdf");
2DataExtractionOptions options = new DataExtractionOptions();
3options.SetFormExtractionEngine("FormKeyValue");
4DataExtractionModule.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.

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales