Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BeginRecognizePrebuiltOptions

Package version

Options for starting a recognition operation using a prebuilt model.

Hierarchy

Index

Properties

Optional contentType

contentType: FormContentType

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

Optional includeFieldElements

includeFieldElements: undefined | false | true

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

Optional locale

locale: undefined | string

Locale of the document.

Supported locales include:

  • "en-AU"
  • "en-CA"
  • "en-GB"
  • "en-IN"
  • "en-US" (default if none provided)
see

KnownFormLocale

Optional onProgress

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

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

Optional pages

pages: string[]

Custom page numbers for multi-page documents(PDF/TIFF). If a value is provided, content information will only be provided for the selected pages. A range of pages may be denoted using a hyphen.

For example, to select pages 1, 3 and 5 through 9, set this property to ["1", "3", "5-9"].

Optional resumeFrom

resumeFrom: undefined | string

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

Optional updateIntervalInMs

updateIntervalInMs: undefined | number

Delay to wait until next poll, in milliseconds

Generated using TypeDoc