Document

The Document object — properties and methods for reading the document being processed, including fields, pages, classification results, and source files.

Document represents the document currently being processed in a Custom activity script — its fields, pages, classification results, source files, and export results.

Depending on which processing stages have completed, some properties may return empty values. For example, only DocumentId and SourceFiles are populated before any skill is applied. ResultClass is populated after a Classification skill runs. Fields is populated after extraction.

Properties

Name	Type	Access	Description
ClassConfidences	ClassConfidenceModel[]	Read-only	The confidence values for each class.
DocumentId	string	Read-only	The unique document identifier.
DocumentSkillId	string	Read-only	The unique identifier of the Document skill applied to the document.
DocumentSkillName	string	Read-only	The name of the Document skill applied to the document.
Fields	Field[]	Read-only	Fields detected on the document. Populated only after a Document skill runs.
IsResultClassConfident	bool	Read-only	true if the document’s class was determined with confidence.
Pages	Page[]	Read-only	The pages of the document.
ResultClass	string	Read-only	The class assigned by the Classification skill. Empty if the document wasn’t classified.
RuleErrors	RuleError[]	Read-only	Field extraction validation rule errors.
SourceFiles	BinaryFile[]	Read-only	Document source files. Contains the image before preprocessing. Source metadata (including EXIF data) is preserved for JPEGs.
Exports	ResultFiles	Read-write	Document export results.
RegistrationParameters	Record<string, Parameter>	Read-only	Dictionary of the source file’s registration parameters for the first page — keys are parameter names, values are Parameter objects.

ClassConfidences and IsResultClassConfident are populated only when a Classification skill has been applied.

Methods

ToJsonString

string ToJsonString();

Returns the document data as a JSON-formatted string.

GetField

Field GetField(string fieldName);

Returns the Field object for the named field.

Related topics

• Transaction
• Field
• Page
• BinaryFile
• Object model
• Custom activity