AnalysisResultPoller interface

Paquet:

@azure/ai-content-understanding

Un sondeur pour une opération d’analyse.

Extends

PollerLike<AnalysisOperationState, AnalysisResult>

Propriétés

operationId

ID d’opération.

Propriétés héritées

isDone	C’est vrai si le sondeur a terminé le sondage.
operationState	État de l’opération. Elle peut être indéfinie si le sondeur n’a pas encore été soumis.
result	La valeur du résultat de l’opération, quel que soit l’état du sondeur. Il peut être indéfini ou une forme incomplète de la valeur finale de TResult selon l’implémentation.
[toStringTag]

Méthodes héritées

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	Joint un rappel uniquement pour le rejet de la Promesse.
finally(null | () => void)	Ajoute un rappel qui est invoqué lorsque la Promesse est conclue (tenue ou rejetée). La valeur résolue ne peut pas être modifiée à partir du rappel.
onProgress((state: AnalysisOperationState) => void)	Invoque le rappel fourni après chaque sondage, envoyant l’état actuel de l’opération du poller. Il retourne une méthode qui peut être utilisée pour arrêter de recevoir des mises à jour sur la fonction de rappel donnée.
poll({ abortSignal?: AbortSignalLike })	Rend une promesse qui se résolvera une fois qu’une seule requête de sondage sera terminée. Il le fait en appelant la méthode de mise à jour de l’opération du poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Rend une promesse qui se résoudra une fois l’opération sous-jacente terminée.
serialize()	Rend une promesse pouvant être utilisée pour une version sérialisée de l’opération du poller en invoquant la méthode de sérialisation de l’opération.
submitted()	Rend une promesse qui pourrait servir à vérifier si le sondeur a été soumis.
then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	Attache des rappels pour la résolution et/ou le rejet de la Promesse.

Détails de la propriété

operationId

Avertissement

Cette API est à présent déconseillée.

Use operationState?.operationId instead.

ID d’opération.

operationId?: string

Valeur de propriété

string

Détails de la propriété héritée

isDone

C’est vrai si le sondeur a terminé le sondage.

isDone: boolean

Valeur de propriété

boolean

Hérité de PollerLike.isDone

operationState

État de l’opération. Elle peut être indéfinie si le sondeur n’a pas encore été soumis.

operationState: undefined | AnalysisOperationState

Valeur de propriété

undefined | AnalysisOperationState

Hérité de PollerLike.operationState

result

La valeur du résultat de l’opération, quel que soit l’état du sondeur. Il peut être indéfini ou une forme incomplète de la valeur finale de TResult selon l’implémentation.

result: undefined | AnalysisResult

Valeur de propriété

undefined | AnalysisResult

Hérité de PollerLike.result

[toStringTag]

[toStringTag]: string

Valeur de propriété

string

Hérité de PollerLike.__@toStringTag@334

Détails de la méthode héritée

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

Joint un rappel uniquement pour le rejet de la Promesse.

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

Paramètres

onrejected

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

Le rappel à l’exécution lorsque la Promesse est rejetée.

Retours

Promise<AnalysisResult | TResult>

Une promesse pour la réalisation du rappel.

Hérité de PollerLike.catch

finally(null | () => void)

Ajoute un rappel qui est invoqué lorsque la Promesse est conclue (tenue ou rejetée). La valeur résolue ne peut pas être modifiée à partir du rappel.

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

Paramètres

onfinally

null | () => void

Le rappel à l’exécution lorsque la Promesse est conclue (tenue ou rejetée).

Retours

Promise<AnalysisResult>

Une promesse pour la réalisation du rappel.

Hérité de PollerLike.finally

onProgress((state: AnalysisOperationState) => void)

Invoque le rappel fourni après chaque sondage, envoyant l’état actuel de l’opération du poller.

Il retourne une méthode qui peut être utilisée pour arrêter de recevoir des mises à jour sur la fonction de rappel donnée.

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

Paramètres

callback

(state: AnalysisOperationState) => void

Retours

CancelOnProgress

Hérité de PollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

Rend une promesse qui se résolvera une fois qu’une seule requête de sondage sera terminée. Il le fait en appelant la méthode de mise à jour de l’opération du poller.

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

Paramètres

options

{ abortSignal?: AbortSignalLike }

Retours

Promise<AnalysisOperationState>

Hérité de PollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

Rend une promesse qui se résoudra une fois l’opération sous-jacente terminée.

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

Paramètres

pollOptions

{ abortSignal?: AbortSignalLike }

Retours

Promise<AnalysisResult>

Hérité de PollerLike.pollUntilDone

serialize()

Rend une promesse pouvant être utilisée pour une version sérialisée de l’opération du poller en invoquant la méthode de sérialisation de l’opération.

function serialize(): Promise<string>

Retours

Promise<string>

Hérité de PollerLike.serialize

submitted()

Rend une promesse qui pourrait servir à vérifier si le sondeur a été soumis.

function submitted(): Promise<void>

Retours

Promise<void>

Hérité de PollerLike.submitted

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

Attache des rappels pour la résolution et/ou le rejet de la Promesse.

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

Paramètres

onfulfilled

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

Le rappel à l’exécution lorsque la Promesse est résolue.

onrejected

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

Le rappel à l’exécution lorsque la Promesse est rejetée.

Retours

Promise<TResult1 | TResult2>

Une promesse pour l’accomplissement de tout rappel exécuté.

Hérité de PollerLike.then