AnalysisResultPoller interface

Paket:

@azure/ai-content-understanding

Extends

PollerLike<OperationState<AnalysisResult>, AnalysisResult>

Eigenschaften

operationId

Die Vorgangs-ID

Geerbte Eigenschaften

isDone	Das stimmt, wenn der Poller die Umfrage abgeschlossen hat.
operationState	Der Status des Vorgangs. Sie kann undefiniert sein, wenn der Poller noch nicht eingereicht wurde.
result	Der Ergebniswert der Operation, unabhängig vom Zustand des Pollers. Je nach Implementierung kann sie undefiniert oder eine unvollständige Form des endgültigen TResult-Werts sein.
[toStringTag]

Geerbte Methoden

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	Fügt einen Rückruf nur für die Ablehnung des Versprechens bei.
finally(null | () => void)	Fügt einen Callback hinzu, der ausgelöst wird, wenn das Versprechen erfüllt (erfüllt oder abgelehnt) ist. Der aufgelöste Wert kann nicht aus dem Callback geändert werden.
onProgress((state: OperationState<AnalysisResult>) => void)	Ruft den bereitgestellten Callback nach Abschluss jedes Polings auf und sendet den aktuellen Zustand der Operation des Pollers. Es gibt eine Methode zurück, mit der man keine Updates mehr für die jeweilige Rückruffunktion erhalten kann.
poll({ abortSignal?: AbortSignalLike })	Gibt ein Versprechen zurück, das gelöst wird, sobald eine einzelne Abfrageanfrage abgeschlossen ist. Dies geschieht, indem die Aktualisierungsmethode der Poller-Operation aufgerufen wird.
pollUntilDone({ abortSignal?: AbortSignalLike })	Gibt ein Versprechen zurück, das aufgelöst wird, sobald die zugrunde liegende Operation abgeschlossen ist.
serialize()	Gibt ein Versprechen zurück, das für eine serialisierte Version der Operation des Pollers verwendet werden könnte, indem die Serialisierungsmethode der Operation aufgerufen wird.
submitted()	Gibt ein Versprechen zurück, das verwendet werden könnte, um zu überprüfen, ob der Poller eingereicht wurde.
then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	Fügt Rückrufe für die Auflösung und/oder Ablehnung des Versprechens bei.

Details zur Eigenschaft

operationId

Die Vorgangs-ID

operationId?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

isDone

Das stimmt, wenn der Poller die Umfrage abgeschlossen hat.

isDone: boolean

Eigenschaftswert

boolean

Geerbt von PollerLike.isDone

operationState

Der Status des Vorgangs. Sie kann undefiniert sein, wenn der Poller noch nicht eingereicht wurde.

operationState: undefined | OperationState<AnalysisResult>

Eigenschaftswert

undefined | OperationState<AnalysisResult>

Geerbt von PollerLike.operationState

result

Der Ergebniswert der Operation, unabhängig vom Zustand des Pollers. Je nach Implementierung kann sie undefiniert oder eine unvollständige Form des endgültigen TResult-Werts sein.

result: undefined | AnalysisResult

Eigenschaftswert

undefined | AnalysisResult

Geerbt von PollerLike.Ergebnis

[toStringTag]

[toStringTag]: string

Eigenschaftswert

string

Geerbt von PollerLike.__@toStringTag@401

Details zur geerbten Methode

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Fügt einen Rückruf nur für die Ablehnung des Versprechens bei.

function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<AnalysisResult | TResult>

Parameter

onrejected

null | (reason: any) => TResult | PromiseLike<TResult>

Der Callback, der ausgeführt wird, wenn das Versprechen abgelehnt wird.

Gibt zurück

Promise<AnalysisResult | TResult>

Ein Versprechen für den Abschluss des Rückrufs.

Geerbt von PollerLike.catch

finally(null | () => void)

Fügt einen Callback hinzu, der ausgelöst wird, wenn das Versprechen erfüllt (erfüllt oder abgelehnt) ist. Der aufgelöste Wert kann nicht aus dem Callback geändert werden.

function finally(onfinally?: null | () => void): Promise<AnalysisResult>

Parameter

onfinally

null | () => void

Der Callback, der ausgeführt wird, wenn das Versprechen erfüllt (erfüllt oder abgelehnt) ist.

Gibt zurück

Promise<AnalysisResult>

Ein Versprechen für den Abschluss des Rückrufs.

Geerbt von PollerLike.finally

onProgress((state: OperationState<AnalysisResult>) => void)

Ruft den bereitgestellten Callback nach Abschluss jedes Polings auf und sendet den aktuellen Zustand der Operation des Pollers.

Es gibt eine Methode zurück, mit der man keine Updates mehr für die jeweilige Rückruffunktion erhalten kann.

function onProgress(callback: (state: OperationState<AnalysisResult>) => void): CancelOnProgress

Parameter

callback

(state: OperationState<AnalysisResult>) => void

Gibt zurück

CancelOnProgress

Geerbt von PollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

Gibt ein Versprechen zurück, das gelöst wird, sobald eine einzelne Abfrageanfrage abgeschlossen ist. Dies geschieht, indem die Aktualisierungsmethode der Poller-Operation aufgerufen wird.

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

Parameter

options

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<OperationState<AnalysisResult>>

Geerbt von PollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

Gibt ein Versprechen zurück, das aufgelöst wird, sobald die zugrunde liegende Operation abgeschlossen ist.

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

Parameter

pollOptions

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<AnalysisResult>

Geerbt von PollerLike.pollUntilDone

serialize()

Gibt ein Versprechen zurück, das für eine serialisierte Version der Operation des Pollers verwendet werden könnte, indem die Serialisierungsmethode der Operation aufgerufen wird.

function serialize(): Promise<string>

Gibt zurück

Promise<string>

Geerbt von PollerLike.serialize

submitted()

Gibt ein Versprechen zurück, das verwendet werden könnte, um zu überprüfen, ob der Poller eingereicht wurde.

function submitted(): Promise<void>

Gibt zurück

Promise<void>

Geerbt von PollerLike.eingereicht

then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Fügt Rückrufe für die Auflösung und/oder Ablehnung des Versprechens bei.

function then<TResult1, TResult2>(onfulfilled?: null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

Parameter

onfulfilled

null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>

Der Rückruf, der ausgeführt wird, wenn das Versprechen aufgelöst ist.

onrejected

null | (reason: any) => TResult2 | PromiseLike<TResult2>

Der Callback, der ausgeführt wird, wenn das Versprechen abgelehnt wird.

Gibt zurück

Promise<TResult1 | TResult2>

Ein Versprechen für den Abschluss des jeweiligen Callbacks.

Geerbt von PollerLike.then