AnalysisResultPoller interface

Pacote:

@azure/ai-content-understanding

Um sondador para uma operação de análise.

Extends

PollerLike<AnalysisOperationState, AnalysisResult>

Propriedades

operationId

A ID da operação.

Propriedades herdadas

isDone	É verdade se a empresa de pesquisa já terminou a pesquisa.
operationState	O estado da operação. Pode ser indefinido se o pesquisador ainda não tiver sido submetido.
result	O valor do resultado da operação, independentemente do estado do pesquisador. Pode ser indefinida ou uma forma incompleta do valor final de TResult, dependendo da implementação.
[toStringTag]

Métodos herdados

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	Anexa uma chamada apenas para a rejeição da Promessa.
finally(null | () => void)	Anexa um callback que é invocado quando a Promessa é fechada (cumprida ou rejeitada). O valor resolvido não pode ser modificado a partir do callback.
onProgress((state: AnalysisOperationState) => void)	Invoca o callback fornecido após cada sondagem ser concluída, enviando o estado atual da operação do poller. Ele retorna um método que pode ser usado para parar de receber atualizações na função de retorno de chamada dada.
poll({ abortSignal?: AbortSignalLike })	Retorna uma promessa que será resolvida assim que uma única solicitação de pesquisa terminar. Ele faz isso chamando o método de atualização da operação do Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Retorna uma promessa que será resolvida assim que a operação subjacente for concluída.
serialize()	Retorna uma promessa que pode ser usada para uma versão serializada da operação do poller invocando o método de serialização da operação.
submitted()	Retorna uma promessa que pode ser usada para verificar se o pesquisador foi submetido.
then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	Anexa chamadas de retorno para a resolução e/ou rejeição da Promessa.

Detalhes da propriedade

operationId

Aviso

Essa API foi preterida.

Use operationState?.operationId instead.

A ID da operação.

operationId?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

isDone

É verdade se a empresa de pesquisa já terminou a pesquisa.

isDone: boolean

Valor da propriedade

boolean

Herdado de PollerLike.isDone

operationState

O estado da operação. Pode ser indefinido se o pesquisador ainda não tiver sido submetido.

operationState: undefined | AnalysisOperationState

Valor da propriedade

undefined | AnalysisOperationState

Herdado de PollerLike.operationState

result

O valor do resultado da operação, independentemente do estado do pesquisador. Pode ser indefinida ou uma forma incompleta do valor final de TResult, dependendo da implementação.

result: undefined | AnalysisResult

Valor da propriedade

undefined | AnalysisResult

Herdado de PollerLike.result

[toStringTag]

[toStringTag]: string

Valor da propriedade

string

Herdado de PollerLike.__@toStringTag@334

Detalhes do método herdado

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

Anexa uma chamada apenas para a rejeição da Promessa.

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

Parâmetros

onrejected

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

A chamada para executar quando a Promessa é rejeitada.

Retornos

Promise<AnalysisResult | TResult>

Uma Promessa para a conclusão do retorno.

Herdado de PollerLike.catch

finally(null | () => void)

Anexa um callback que é invocado quando a Promessa é fechada (cumprida ou rejeitada). O valor resolvido não pode ser modificado a partir do callback.

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

Parâmetros

onfinally

null | () => void

A chamada para executar quando a Promessa é cumprida (cumprida ou rejeitada).

Retornos

Promise<AnalysisResult>

Uma Promessa para a conclusão do retorno.

Herdado de PollerLike.finally

onProgress((state: AnalysisOperationState) => void)

Invoca o callback fornecido após cada sondagem ser concluída, enviando o estado atual da operação do poller.

Ele retorna um método que pode ser usado para parar de receber atualizações na função de retorno de chamada dada.

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

Parâmetros

callback

(state: AnalysisOperationState) => void

Retornos

CancelOnProgress

Herdado de PollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

Retorna uma promessa que será resolvida assim que uma única solicitação de pesquisa terminar. Ele faz isso chamando o método de atualização da operação do Poller.

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

Parâmetros

options

{ abortSignal?: AbortSignalLike }

Retornos

Promise<AnalysisOperationState>

Herdado de PollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

Retorna uma promessa que será resolvida assim que a operação subjacente for concluída.

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

Parâmetros

pollOptions

{ abortSignal?: AbortSignalLike }

Retornos

Promise<AnalysisResult>

Herdado de PollerLike.pollUntilDone

serialize()

Retorna uma promessa que pode ser usada para uma versão serializada da operação do poller invocando o método de serialização da operação.

function serialize(): Promise<string>

Retornos

Promise<string>

Herdado de PollerLike.serialize

submitted()

Retorna uma promessa que pode ser usada para verificar se o pesquisador foi submetido.

function submitted(): Promise<void>

Retornos

Promise<void>

Herdado de PollerLike.submitted

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

Anexa chamadas de retorno para a resolução e/ou rejeição da Promessa.

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>

A chamada para executar quando a Promessa for resolvida.

onrejected

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

A chamada para executar quando a Promessa é rejeitada.

Retornos

Promise<TResult1 | TResult2>

Uma Promessa para a conclusão de qualquer callback executado.

Herdado de PollerLike.then