AnalysisResultPoller interface

Paquete:

@azure/ai-content-understanding

Extends

PollerLike<OperationState<AnalysisResult>, AnalysisResult>

Propiedades

operationId

El identificador de la operación

Propiedades heredadas

isDone	Es cierto si el encuestador ha terminado de sondear.
operationState	Estado de la operación. Puede ser indefinida si el encuestador aún no ha sido presentado.
result	El valor del resultado de la operación, independientemente del estado del encuestador. Puede ser indefinida o una forma incompleta del valor final de TResult, dependiendo de la implementación.
[toStringTag]

Métodos heredados

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	Adjunta una llamada de regreso solo para el rechazo de la Promesa.
finally(null | () => void)	Adjunta una llamada de regreso que se invoca cuando la Promesa se resuelve (cumplida o rechazada). El valor resuelto no puede modificarse desde la callback.
onProgress((state: OperationState<AnalysisResult>) => void)	Invoca la callback proporcionada tras completar cada sondeo, enviando el estado actual de la operación del poller. Devuelve un método que puede usarse para dejar de recibir actualizaciones en la función de callback dada.
poll({ abortSignal?: AbortSignalLike })	Devuelve una promesa que se resolverá una vez que termine una sola solicitud de encuesta. Lo hace llamando al método de actualización de la operación del Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Devuelve una promesa que se resolverá una vez completada la operación subyacente.
serialize()	Devuelve una promesa que podría usarse para una versión serializada de la operación del poller invocando el método de serialización de la operación.
submitted()	Devuelve una promesa que podría usarse para comprobar si el encuestador ha sido presentado.
then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	Adjunta callbacks para la resolución y/o rechazo de la Promesa.

Detalles de las propiedades

operationId

El identificador de la operación

operationId?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

isDone

Es cierto si el encuestador ha terminado de sondear.

isDone: boolean

Valor de propiedad

boolean

Heredado de PollerLike.isDone

operationState

Estado de la operación. Puede ser indefinida si el encuestador aún no ha sido presentado.

operationState: undefined | OperationState<AnalysisResult>

Valor de propiedad

undefined | OperationState<AnalysisResult>

Heredado de PollerLike.operationState

result

El valor del resultado de la operación, independientemente del estado del encuestador. Puede ser indefinida o una forma incompleta del valor final de TResult, dependiendo de la implementación.

result: undefined | AnalysisResult

Valor de propiedad

undefined | AnalysisResult

Heredado de PollerLike.result

[toStringTag]

[toStringTag]: string

Valor de propiedad

string

Heredado de PollerLike.__@toStringTag@401

Detalles de los métodos heredados

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

Adjunta una llamada de regreso solo para el rechazo de la Promesa.

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

Parámetros

onrejected

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

La llamada a ejecutar cuando la Promesa es rechazada.

Devoluciones

Promise<AnalysisResult | TResult>

Una promesa para completar la llamada de regreso.

Heredado de PollerLike.catch

finally(null | () => void)

Adjunta una llamada de regreso que se invoca cuando la Promesa se resuelve (cumplida o rechazada). El valor resuelto no puede modificarse desde la callback.

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

Parámetros

onfinally

null | () => void

La llamada para ejecutar cuando la Promesa se resuelve (cumplida o rechazada).

Devoluciones

Promise<AnalysisResult>

Una promesa para completar la llamada de regreso.

Heredado de PollerLike.finally

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

Invoca la callback proporcionada tras completar cada sondeo, enviando el estado actual de la operación del poller.

Devuelve un método que puede usarse para dejar de recibir actualizaciones en la función de callback dada.

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

Parámetros

callback

(state: OperationState<AnalysisResult>) => void

Devoluciones

CancelOnProgress

Heredado de PollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

Devuelve una promesa que se resolverá una vez que termine una sola solicitud de encuesta. Lo hace llamando al método de actualización de la operación del Poller.

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

Parámetros

options

{ abortSignal?: AbortSignalLike }

Devoluciones

Promise<OperationState<AnalysisResult>>

Heredado de PollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

Devuelve una promesa que se resolverá una vez completada la operación subyacente.

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

Parámetros

pollOptions

{ abortSignal?: AbortSignalLike }

Devoluciones

Promise<AnalysisResult>

Heredado de PollerLike.pollUntilDone

serialize()

Devuelve una promesa que podría usarse para una versión serializada de la operación del poller invocando el método de serialización de la operación.

function serialize(): Promise<string>

Devoluciones

Promise<string>

Heredado de PollerLike.serialize

submitted()

Devuelve una promesa que podría usarse para comprobar si el encuestador ha sido presentado.

function submitted(): Promise<void>

Devoluciones

Promise<void>

Heredado de PollerLike.submitted

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

Adjunta callbacks para la resolución y/o rechazo de la Promesa.

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

Parámetros

onfulfilled

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

La llamada para ejecutar cuando se resuelva la Promesa.

onrejected

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

La llamada a ejecutar cuando la Promesa es rechazada.

Devoluciones

Promise<TResult1 | TResult2>

Una Promesa para la finalización de cualquier callback que se ejecute.

Heredado de PollerLike.then