Class DocumentDataExtractionResult

Contains the result of running the document data extractor.

Example

Since the instance of the class contains objects backed by native resources (e.g. images) and implements AsyncDisposable it's highly recommended to use the await using syntax when an instance is created or is received from an API:

await using instance = await getDocumentDataExtractionResultFromAnApi();

Alternatively, one can explicitly call release method to release the native resources or use autorelease convenience function. If neither is used, the resource will be released when the instance is garbage collected which is not recommended.

Implements

  • AsyncDisposable

Constructors

Properties

croppedImage: null | ImageRef = null

Crop of the document if it was detected.

document: null | GenericDocument

The extracted document.

documentDetectionResult: DocumentDetectionResult

Result of the document detection in the input image.

The status of the extraction process.

Methods

  • Returns Promise<void>

  • Returns Promise<void>