Interface PredictOptions

Options relating to predictions.

interface PredictOptions {
    allWords?: boolean;
    cropper?: boolean;
    endpoint?: Endpoint;
    fullText?: boolean;
    pageOptions?: PageOptions;
}

Hierarchy

  • BaseOptions
    • PredictOptions

Properties

allWords? cropper? endpoint? fullText? pageOptions?

Properties

OptionalallWords

allWords?: boolean

Whether to include the full text for each page.

This performs a full OCR operation on the server and will increase response time.

Optionalcropper

cropper?: boolean

Whether to include cropper results for each page.

Optionalendpoint

endpoint?: Endpoint

A custom endpoint.

OptionalfullText

fullText?: boolean

Whether to include the full ocr text. Only available on compatible APIs.

OptionalpageOptions

pageOptions?: PageOptions

If set, remove pages from the document as specified. This is done before sending the file to the server and is useful to avoid page limitations.

Settings

Member Visibility

On This Page

Properties