Class DocumentClassifier

API for document classification.

Required licence feature(s): DocumentClassification.

Index

Methods

destroy run create

Methods

destroy

destroy(): Promise<void>
Frees up any resources associated with this object. No other methods may be called on this object after destroy has been called.

Returns Promise<void>

run

run(image, consumeImage?): Promise<DocumentClassifierRunResponse>
Classify the document in the given image.
Parameters
- image: Image
  The image to classify.
- Optional consumeImage: Config.ConsumeType
  Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.
Returns Promise<DocumentClassifierRunResponse>
The result of document classification.

`Static` create

create(workerBridge, configuration): Promise<DocumentClassifier>
Parameters
- workerBridge: WorkerBridge
- configuration: {
  crop?: boolean;
  }
  - Optional Readonly crop?: boolean
    If true, image will be scanned for a valid document first.
    Default Value
    true;
Returns Promise<DocumentClassifier>

Generated using TypeDoc