AnalysisResultPoller interface

Pakket:

@azure/ai-content-understanding

Een peiler voor een analyse-operatie.

Uitbreiding

PollerLike<AnalysisOperationState, AnalysisResult>

Eigenschappen

operationId

De bewerkings-id.

Overgenomen eigenschappen

isDone	Dat is waar als de peiler klaar is met peilen.
operationState	De status van de bewerking. Het kan niet worden gedefinieerd als de poller nog niet is ingediend.
result	De resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan ongedefinieerd of een onvolledige vorm zijn van de uiteindelijke TResult-waarde, afhankelijk van de implementatie.
[toStringTag]

Overgenomen methoden

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	Voegt een terugroep toe voor alleen de afwijzing van de Belofte.
finally(null | () => void)	Voegt een callback toe die wordt opgeroepen wanneer de Belofte is vastgelegd (vervuld of afgewezen). De opgeloste waarde kan niet worden aangepast vanuit de callback.
onProgress((state: AnalysisOperationState) => void)	Roept de meegeleverde callback aan nadat elke polling is voltooid, waarbij de huidige status van de poller-operatie wordt verzonden. Het geeft een methode terug die kan worden gebruikt om te voorkomen dat updates worden ontvangen over de betreffende callback-functie.
poll({ abortSignal?: AbortSignalLike })	Geeft een belofte terug die wordt opgelost zodra een enkel pollingverzoek is afgerond. Dit gebeurt door de update-methode van de Poller-operatie aan te roepen.
pollUntilDone({ abortSignal?: AbortSignalLike })	Geeft een belofte terug die wordt opgelost zodra de onderliggende bewerking is voltooid.
serialize()	Geeft een belofte terug die gebruikt kan worden voor een geserialiseerde versie van de poller-operatie door de serialisatiemethode van de operatie aan te roepen.
submitted()	Geeft een belofte terug die gebruikt kan worden om te controleren of de poller is ingediend.
then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	Voegt callbacks toe voor de oplossing en/of afwijzing van de Belofte.

Eigenschapdetails

operationId

Waarschuwing

Deze API is nu afgeschaft.

Use operationState?.operationId instead.

De bewerkings-id.

operationId?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

isDone

Dat is waar als de peiler klaar is met peilen.

isDone: boolean

Waarde van eigenschap

boolean

Geërfd van PollerLike.isDone

operationState

De status van de bewerking. Het kan niet worden gedefinieerd als de poller nog niet is ingediend.

operationState: undefined | AnalysisOperationState

Waarde van eigenschap

undefined | AnalysisOperationState

Geërfd van PollerLike.operationState

result

De resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan ongedefinieerd of een onvolledige vorm zijn van de uiteindelijke TResult-waarde, afhankelijk van de implementatie.

result: undefined | AnalysisResult

Waarde van eigenschap

undefined | AnalysisResult

Geërfd van PollerLike.resultaat

[toStringTag]

[toStringTag]: string

Waarde van eigenschap

string

Geërfd van PollerLike.__@toStringTag@334

Details overgenomen methode

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

Voegt een terugroep toe voor alleen de afwijzing van de Belofte.

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

Parameters

onrejected

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

De callback om uit te voeren wanneer de Belofte wordt afgewezen.

Retouren

Promise<AnalysisResult | TResult>

Een belofte voor het voltooien van de callback.

Geërfd van PollerLike.catch

finally(null | () => void)

Voegt een callback toe die wordt opgeroepen wanneer de Belofte is vastgelegd (vervuld of afgewezen). De opgeloste waarde kan niet worden aangepast vanuit de callback.

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

Parameters

onfinally

null | () => void

De callback om uit te voeren wanneer de Belofte is verbonden (vervuld of afgewezen).

Retouren

Promise<AnalysisResult>

Een belofte voor het voltooien van de callback.

Geërfd van PollerLike.eindelijk

onProgress((state: AnalysisOperationState) => void)

Roept de meegeleverde callback aan nadat elke polling is voltooid, waarbij de huidige status van de poller-operatie wordt verzonden.

Het geeft een methode terug die kan worden gebruikt om te voorkomen dat updates worden ontvangen over de betreffende callback-functie.

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

Parameters

callback

(state: AnalysisOperationState) => void

Retouren

CancelOnProgress

Geërfd van PollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

Geeft een belofte terug die wordt opgelost zodra een enkel pollingverzoek is afgerond. Dit gebeurt door de update-methode van de Poller-operatie aan te roepen.

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

Parameters

options

{ abortSignal?: AbortSignalLike }

Retouren

Promise<AnalysisOperationState>

Geërfd van PollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

Geeft een belofte terug die wordt opgelost zodra de onderliggende bewerking is voltooid.

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

Parameters

pollOptions

{ abortSignal?: AbortSignalLike }

Retouren

Promise<AnalysisResult>

Geërfd van PollerLike.pollUntilDone

serialize()

Geeft een belofte terug die gebruikt kan worden voor een geserialiseerde versie van de poller-operatie door de serialisatiemethode van de operatie aan te roepen.

function serialize(): Promise<string>

Retouren

Promise<string>

Geërfd van PollerLike.serialize

submitted()

Geeft een belofte terug die gebruikt kan worden om te controleren of de poller is ingediend.

function submitted(): Promise<void>

Retouren

Promise<void>

Geërfd van PollerLike.ingediend

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

Voegt callbacks toe voor de oplossing en/of afwijzing van de Belofte.

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

Parameters

onfulfilled

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

De callback om uit te voeren wanneer de Belofte is afgerond.

onrejected

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

De callback om uit te voeren wanneer de Belofte wordt afgewezen.

Retouren

Promise<TResult1 | TResult2>

Een belofte voor het voltooien van welke callback dan ook wordt uitgevoerd.

Geërfd van PollerLike.then