Document - ABBYY Documentation

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	ClassConfidence	Read-only	The confidence values for each class. `null` if the document wasn’t classified.
DocumentId	string	Read-only	The unique document identifier.
DocumentSkillId	string	Read-only	The identifier of the skill applied to the document. If several stages have run, this is the most recently applied skill.
DocumentSkillName	string	Read-only	The name of the skill applied to the document. If several stages have run, this is the most recently applied skill.
Fields	Field[]	Read-only	Fields detected on the document. Populated only after a Document skill runs.
HasSuspiciousSymbols	bool	Read-only	`true` if the document contains at least one field with characters recognized with low confidence.
IsResultClassConfident	bool	Read-only	`true` if the document’s class was determined with confidence.
IsUnknownSkill	bool	Read-only	Whether the document class (and therefore the Document skill) has been determined.
Pages	Page[]	Read-only	The pages of the document.
ResultClass	string	Read-only	The class assigned by the Classification skill. `null` if the document wasn’t classified.
ResultClassId	string	Read-only	The identifier of the class assigned by the Classification skill. `null` if not classified.
RuleErrors	RuleError[]	Read-only	Field extraction validation rule errors.
SourceFiles	SourceFile[]	Read-only	Document source files.

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

​Properties

​Related topics

Properties

Related topics