AnalyzeDocumentOptions interface

Package:

@azure/ai-form-recognizer

Options for the document analysis operation.

Extends

OperationOptions,PollerOptions<DocumentAnalysisPollOperationState<Result>>

Properties

features	A list of features to enable in the model. Enabling features may incur additional costs, so be sure to consult the service documentation to understand the nature of the features and any added costs associated with using them. For more information about the features available in Form Recognizer, see the service documentation: https://aka.ms/azsdk/formrecognizer/features
locale	Locale hint for text recognition and document analysis. The value may specify only the two-letter language code or a BCP-47 language tag indicating both language and region. Examples: "en-US" (US English) "fr" (French - no region)
pages	A list of page ranges (1-indexed) within the input document to analyze, separated by commas Examples: "1", "3-5", "1,3-5"

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onProgress	An optional initial progress handler that will be called when the poller state updates. This handler will be called once immediately after the poller state is initialized.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
resumeFrom	A serialized poller state. If provided, the polling operation will be resumed from the given state instead of started as if it were a new operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.
updateIntervalInMs	The amount of time to wait (in milliseconds) between subsequent requests relating to the same operation.

Property Details

features

A list of features to enable in the model. Enabling features may incur additional costs, so be sure to consult the service documentation to understand the nature of the features and any added costs associated with using them.

For more information about the features available in Form Recognizer, see the service documentation: https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

Property Value

FormRecognizerFeature[]

locale

Locale hint for text recognition and document analysis.

The value may specify only the two-letter language code or a BCP-47 language tag indicating both language and region.

Examples:

• "en-US" (US English)
• "fr" (French - no region)

locale?: string

Property Value

string

pages

A list of page ranges (1-indexed) within the input document to analyze, separated by commas

Examples: "1", "3-5", "1,3-5"

pages?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From PollerOptions.abortSignal

onProgress

An optional initial progress handler that will be called when the poller state updates. This handler will be called once immediately after the poller state is initialized.

onProgress?: (state: DocumentAnalysisPollOperationState<Result>) => void

Property Value

(state: DocumentAnalysisPollOperationState<Result>) => void

Inherited From PollerOptions.onProgress

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From PollerOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From PollerOptions.requestOptions

resumeFrom

A serialized poller state. If provided, the polling operation will be resumed from the given state instead of started as if it were a new operation.

resumeFrom?: string

Property Value

string

Inherited From PollerOptions.resumeFrom

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From PollerOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From PollerOptions.tracingOptions

updateIntervalInMs

The amount of time to wait (in milliseconds) between subsequent requests relating to the same operation.

updateIntervalInMs?: number

Property Value

number

Inherited From PollerOptions.updateIntervalInMs