PollerOptions interface

Package:

@azure/ai-form-recognizer

Options for long-running operations (pollers) in the Form Recognizer clients.

Extends

OperationOptions

Properties

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.
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.
updateIntervalInMs	The amount of time to wait (in milliseconds) between subsequent requests relating to the same operation.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
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.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

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: TState) => void

Property Value

(state: TState) => void

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

updateIntervalInMs

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

updateIntervalInMs?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

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 OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions