Skip to main content
The document currently being processed. Depending on the processing stages that the document has already passed, some of the object properties may return empty values. For example, if no skills have been applied to the document yet, only the DocumentId and SourceFiles properties will be returned. ResultClass will only be returned after a Classification skill has been applied. Fields will be populated once the fields have been extracted.

Properties

NameTypeDescription
ClassConfidencesClassConfidenceModel[], read-onlyThe confidence values for the class. Note: The confidence values are returned for a Classification skill only.
DocumentIdstring, read-onlyThe unique document identifier.
DocumentSkillIdstring, read-onlyThe unique identifier of the Process skill applied to the document.
DocumentSkillNamestring, read-onlyThe name of the Process skill applied to the document.
FieldsField[], read-onlyFields that have been detected on the document. The collection is only populated using documents that the Document skill has been applied to.
IsResultClassConfidentboolReturns true if the class of the document was determined confidently. Note: Classification confidence information is returned for a Classification skill only.
PagesPage[], read-onlyThe pages of the document.
ResultClassstring, read-onlyThe class that the document was classified as by the Classification skill. If the document was not classified, the property will return an empty value.
RuleErrorsRuleError[], read-onlyField extraction validation rule errors.
SourceFilesBinaryFile[], read-onlyDocument source files. If the source file was in JPEG format, all source metadata including the EXIF data will be preserved. This object contains the image before preprocessing.
ExportsResultFilesDocument export results.
RegistrationParametersRecord<string, Parameter>, read-onlyReturns a dictionary of the source file registration parameters for the first page of the document. The keys represent parameter names and the key values represent Parameter objects.

Methods

NameDescription
ToJsonString();Returns the document data as a JSON-formatted string.
GetField(string FieldName);Returns the Field object that contains all information about the specified field.