PollerOptions interface

Pakiet:

@azure/ai-form-recognizer

Opcje długotrwałych operacji (sondatorów) w klientach rozpoznawania formularzy.

Rozszerzenie

OperationOptions

Właściwości

onProgress	Opcjonalna procedura obsługi postępu początkowego, która będzie wywoływana, gdy stan poller zostanie zaktualizowany. Ta procedura obsługi zostanie wywołana natychmiast po zainicjowaniu stanu poller.
resumeFrom	Serializowany stan poller. Jeśli zostanie podana, operacja sondowania zostanie wznowiona z danego stanu, a nie uruchomiona tak, jakby była to nowa operacja.
updateIntervalInMs	Czas oczekiwania (w milisekundach) między kolejnymi żądaniami odnoszącymi się do tej samej operacji.

Właściwości dziedziczone

abortSignal	Sygnał, który może służyć do przerwania żądań.
onResponse	Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
requestOptions	Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
serializerOptions	Opcje zastępowania zachowania serializacji/deseralizacji.
tracingOptions	Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

onProgress

Opcjonalna procedura obsługi postępu początkowego, która będzie wywoływana, gdy stan poller zostanie zaktualizowany. Ta procedura obsługi zostanie wywołana natychmiast po zainicjowaniu stanu poller.

onProgress?: (state: TState) => void

Wartość właściwości

(state: TState) => void

resumeFrom

Serializowany stan poller. Jeśli zostanie podana, operacja sondowania zostanie wznowiona z danego stanu, a nie uruchomiona tak, jakby była to nowa operacja.

resumeFrom?: string

Wartość właściwości

string

updateIntervalInMs

Czas oczekiwania (w milisekundach) między kolejnymi żądaniami odnoszącymi się do tej samej operacji.

updateIntervalInMs?: number

Wartość właściwości

number

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

dziedziczone z OperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

RawResponseCallback

dziedziczone z OperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

OperationRequestOptions

dziedziczone z OperationOptions.requestOptions

serializerOptions

Opcje zastępowania zachowania serializacji/deseralizacji.

serializerOptions?: SerializerOptions

Wartość właściwości

SerializerOptions

dziedziczone z OperationOptions.serializerOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone z OperationOptions.tracingOptions