BeginRecognizeCustomFormsOptions | @azure/ai-form-recognizer

Options for starting the custom form recognition operation.

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

Index

contentType: Exclude<FormContentType, "image/bmp">

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

"image/bmp" is not supported for custom form analysis.

includeFieldElements: undefined | false | true

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

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