Freigeben über

SimplePollerLike interface

Paket:
@azure-rest/ai-document-intelligence

Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann.

Methoden

getOperationId()

Gibt die ID des Vorgangs zurück.
getOperationState()

Gibt den Status des Vorgangs zurück.
getResult()

Gibt den Ergebniswert des Vorgangs unabhängig vom Zustand des Pollers zurück. Es kann abhängig von der Implementierung eine nicht definierte oder unvollständige Form des endgültigen TResult-Werts zurückgeben.
isDone()

Gibt true zurück, wenn der Abrufer die Abfrage abgeschlossen hat.
isStopped()

Gibt true zurück, wenn der Abrufer beendet wird.
onProgress((state: TState) => void)

Ruft den bereitgestellten Rückruf auf, nachdem jede Abfrage abgeschlossen wurde, und sendet den aktuellen Status des Abrufvorgangs.

Es gibt eine Methode zurück, die verwendet werden kann, um den Empfang von Updates für die angegebene Rückruffunktion zu beenden.
poll({ abortSignal?: AbortSignalLike })

Gibt eine Zusage zurück, die aufgelöst wird, sobald eine einzelne Abfrageanforderung abgeschlossen ist. Dazu rufen Sie die Updatemethode des Poller-Vorgangs auf.
pollUntilDone({ abortSignal?: AbortSignalLike })

Gibt eine Zusage zurück, die nach Abschluss des zugrunde liegenden Vorgangs aufgelöst wird.
serialize()

Gibt eine Zusage zurück, die für serialisierte Version des Pollers-Vorgangs verwendet werden kann, indem die Serialisierungsmethode des Vorgangs abgerufen wird.
stopPolling()

Verhindert, dass der Poller die Abfrage fortsetzt. Bitte beachten Sie, dass die clientseitige Abfrage nur beendet wird.
submitted()

Warten Sie, bis der Abrufer gesendet wird.
toString()

Gibt eine Zeichenfolgendarstellung des Abfragevorgangs zurück. Ähnlich wie beim Serialisieren, gibt aber eine Zeichenfolge zurück.

Details zur Methode

getOperationId()

Gibt die ID des Vorgangs zurück.

function getOperationId(): string

Gibt zurück

string

getOperationState()

Gibt den Status des Vorgangs zurück.

function getOperationState(): TState

Gibt zurück

TState

getResult()

Gibt den Ergebniswert des Vorgangs unabhängig vom Zustand des Pollers zurück. Es kann abhängig von der Implementierung eine nicht definierte oder unvollständige Form des endgültigen TResult-Werts zurückgeben.

function getResult(): undefined | TResult

Gibt zurück

undefined | TResult

isDone()

Gibt true zurück, wenn der Abrufer die Abfrage abgeschlossen hat.

function isDone(): boolean

Gibt zurück

boolean

isStopped()

Warnung

Diese API ist nun veraltet.

Use abortSignal status to track this instead.

Gibt true zurück, wenn der Abrufer beendet wird.

function isStopped(): boolean

Gibt zurück

boolean

onProgress((state: TState) => void)

Ruft den bereitgestellten Rückruf auf, nachdem jede Abfrage abgeschlossen wurde, und sendet den aktuellen Status des Abrufvorgangs.

Es gibt eine Methode zurück, die verwendet werden kann, um den Empfang von Updates für die angegebene Rückruffunktion zu beenden.

function onProgress(callback: (state: TState) => void): CancelOnProgress

Parameter

callback

(state: TState) => void

Gibt zurück

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Gibt eine Zusage zurück, die aufgelöst wird, sobald eine einzelne Abfrageanforderung abgeschlossen ist. Dazu rufen Sie die Updatemethode des Poller-Vorgangs auf.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>

Parameter

options

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Gibt eine Zusage zurück, die nach Abschluss des zugrunde liegenden Vorgangs aufgelöst wird.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

Parameter

pollOptions

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<TResult>

serialize()

Gibt eine Zusage zurück, die für serialisierte Version des Pollers-Vorgangs verwendet werden kann, indem die Serialisierungsmethode des Vorgangs abgerufen wird.

function serialize(): Promise<string>

Gibt zurück

Promise<string>

stopPolling()

Warnung

Diese API ist nun veraltet.

Use abortSignal to stop polling instead.

Verhindert, dass der Poller die Abfrage fortsetzt. Bitte beachten Sie, dass die clientseitige Abfrage nur beendet wird.

function stopPolling()

submitted()

Warten Sie, bis der Abrufer gesendet wird.

function submitted(): Promise<void>

Gibt zurück

Promise<void>

toString()

Warnung

Diese API ist nun veraltet.

Use serialize() instead.

Gibt eine Zeichenfolgendarstellung des Abfragevorgangs zurück. Ähnlich wie beim Serialisieren, gibt aber eine Zeichenfolge zurück.

function toString(): string

Gibt zurück

string