PollerOptions interface

Paket:

@azure/ai-form-recognizer

Optionen für lange ausgeführte Vorgänge (Poller) in den Formularerkennungsclients.

Extends

OperationOptions

Eigenschaften

onProgress	Ein optionaler anfänglicher Statushandler, der aufgerufen wird, wenn der Abrufstatus aktualisiert wird. Dieser Handler wird einmal aufgerufen, nachdem der Abfragezustand initialisiert wurde.
resumeFrom	Ein serialisierter Umfragezustand. Wenn angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt zu starten, als ob es sich um einen neuen Vorgang handelt.
updateIntervalInMs	Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onResponse	Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
serializerOptions	Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

onProgress

Ein optionaler anfänglicher Statushandler, der aufgerufen wird, wenn der Abrufstatus aktualisiert wird. Dieser Handler wird einmal aufgerufen, nachdem der Abfragezustand initialisiert wurde.

onProgress?: (state: TState) => void

Eigenschaftswert

(state: TState) => void

resumeFrom

Ein serialisierter Umfragezustand. Wenn angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt zu starten, als ob es sich um einen neuen Vorgang handelt.

resumeFrom?: string

Eigenschaftswert

string

updateIntervalInMs

Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang.

updateIntervalInMs?: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

von OperationOptions.abortSignal geerbt

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

von OperationOptions.onResponse geerbt

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Von OperationOptions.requestOptions geerbt

serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

von OperationOptions.serializerOptions geerbt

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

von OperationOptions.tracingOptions geerbt