BeginRecognizePrebuiltOptions | @azure/ai-form-recognizer

Options for starting a recognition operation using a prebuilt model.

FormRecognizerOperationOptions & { includeFieldElements?: undefined | false | true } & { contentType?: FormContentType; onProgress?: undefined | ((state: RecognizeFormsOperationState) => void); resumeFrom?: undefined | string; updateIntervalInMs?: undefined | number }
- BeginRecognizePrebuiltOptions

Index

Content type of the input. Supported types are "application/pdf", "image/jpeg", "image/png", "image/tiff", and "image/bmp".

includeFieldElements: undefined | false | true

Specifies whether to include text lines and element references in the result

locale: undefined | string

Locale of the document.

Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US (default if none provided).

onProgress: undefined | ((state: RecognizeFormsOperationState) => void)

Callback to progress events triggered in the Recognize Form Long-Running-Operation (LRO)

resumeFrom: undefined | string

A serialized poller which can be used to resume an existing paused Long-Running-Operation.

updateIntervalInMs: undefined | number

Delay to wait until next poll, in milliseconds