Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Document represents the document currently being processed in a Condition activity.
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

NameTypeAccessDescription
ClassConfidencesClassConfidenceRead-onlyThe confidence values for each class. null if the document wasn’t classified.
DocumentIdstringRead-onlyThe unique document identifier.
DocumentSkillIdstringRead-onlyThe identifier of the skill applied to the document. If several stages have run, this is the most recently applied skill.
DocumentSkillNamestringRead-onlyThe name of the skill applied to the document. If several stages have run, this is the most recently applied skill.
FieldsField[]Read-onlyFields detected on the document. Populated only after a Document skill runs.
HasSuspiciousSymbolsboolRead-onlytrue if the document contains at least one field with characters recognized with low confidence.
IsResultClassConfidentboolRead-onlytrue if the document’s class was determined with confidence.
IsUnknownSkillboolRead-onlyWhether the document class (and therefore the Document skill) has been determined.
PagesPage[]Read-onlyThe pages of the document.
ResultClassstringRead-onlyThe class assigned by the Classification skill. null if the document wasn’t classified.
ResultClassIdstringRead-onlyThe identifier of the class assigned by the Classification skill. null if not classified.
RuleErrorsRuleError[]Read-onlyField extraction validation rule errors.
SourceFilesSourceFile[]Read-onlyDocument source files.
ClassConfidences and IsResultClassConfident are populated only when a Classification skill has been applied.

Transaction

The current processing transaction and its documents.

Field

Properties for reading a document field’s value, type, and OCR metadata.

Page

Properties of a single document page.

SourceFile

Represents a source file of the document being processed.

ClassConfidence

A class-confidence pair returned after a Classification skill runs.

Object model

Full JavaScript object reference for Condition activity scripts.