Skip to main content

​
Prerequisites

The structured extraction feature must be available. Open Admin settings → AI Document Processing → Extraction profiles. Use ai.extractionprofiles.view to inspect profiles and ai.extractionprofiles.manage to maintain them. A profile describes the JSON data an extraction request should return. It is different from the document classification tree, which chooses a document type and suggests indexing keywords. Editing an extraction profile does not automatically assign it to an upload-classification branch.

​
Define a profile

Choose Add profile and configure: Give fields precise descriptions. A field called reference with no explanation is ambiguous when a document contains an invoice number, customer number, and payment reference. A minimal schema could be:
This is a schema example, not a guarantee that an AI model will always extract the right value. Check the actual document and the returned validation results.

The Invoice reference profile declares its expected JSON result and extraction context.

​
Add deterministic checks

The supported validators include: Validator paths refer to the extracted object. Dot paths reach nested fields; an array segment such as items[] applies to its items. Use the parameter names shown in the editor’s help for each validator. Validators improve the evidence for a result; passing a format or checksum check does not establish that a value belongs to the correct person or document.

​
Save and verify

Choose Save changes, then call the structured extraction operation with this profile in your test environment. Include a typical document, a document missing an expected field, and one with inconsistent totals or another intended validation failure. Check page limits against documents whose required information appears near the end. The settings screen edits profiles; it does not itself run an extraction test. Use the consuming integration and the environment’s API contract to verify the result.

​
Change or delete a profile

Review integrations that select a profile by name before renaming or removing it. Delete all removes the entire configured profile collection; requests naming those profiles will fail until the required profiles exist again.

AI agents and shared settings

Configure chat agents, context boundaries, tools, quick prompts, model choices, and request limits.