AnalysisResultPoller interface

Пакет:: @azure/ai-content-understanding

Опросник для аналитической операции.

Extends: PollerLike<AnalysisOperationState, AnalysisResult>

Свойства

Идентификатор операции.

Унаследованные свойства

isDone	Это верно, если опросщик уже завершил опросы.
operationState	Состояние операции. Он может быть неопределён, если анкета ещё не была подана.
result	Значение результата операции, независимо от состояния опросителя. Он может быть неопределённым или неполным в виде конечного значения TResult в зависимости от реализации.
[toStringTag]

Наследуемые методы

catch<TResult>((reason: any) => TResult \| PromiseLike<TResult> \| null)	Прилагает отклик только на отказ от Обещания.
finally(() => void \| null)	Прикрепляет обратный вызов, который вызывается при выполнении Обещания (исполнении или отклонении). Разрешённое значение нельзя изменить из обратного вызова.
onProgress((state: AnalysisOperationState) => void)	Вызывает предоставленный обратный вызов после завершения каждого голосования, отправляя текущее состояние работы опросчика. Он возвращает метод, который может быть использован для прекращения получения обновлений по заданной функции обратного вызова.
poll({ abortSignal?: AbortSignalLike })	Возвращает обещание, которое будет решено после завершения одного запроса на опрос. Это происходит путём вызова метода обновления операции Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Возвращает обещание, которое разрешается после завершения базовой операции.
serialize()	Возвращает обещание, которое можно использовать для сериализированной версии операции опросчика, вызвав метод сериализации операции.
submitted()	Возвращает обещание, которое можно использовать для проверки, был ли опросник отправлен.
then<TResult1, TResult2>((value: AnalysisResult) => TResult1 \| PromiseLike<TResult1> \| null, (reason: any) => TResult2 \| PromiseLike<TResult2> \| null)	Прилагает обратные запросы для разрешения и/или отказа от Обещания.

Сведения о свойстве

operationId

Предупреждение

Теперь этот API является нерекомендуемым.

Use operationState?.operationId instead.

Идентификатор операции.

operationId?: string

Значение свойства

string

Сведения об унаследованном свойстве

isDone

Это верно, если опросщик уже завершил опросы.

isDone: boolean

Значение свойства

boolean

Унаследованный от PollerLike.isDone

operationState

Состояние операции. Он может быть неопределён, если анкета ещё не была подана.

operationState: AnalysisOperationState | undefined

Значение свойства

AnalysisOperationState | undefined

Унаследованный от PollerLike.operationState

result

Значение результата операции, независимо от состояния опросителя. Он может быть неопределённым или неполным в виде конечного значения TResult в зависимости от реализации.

result: AnalysisResult | undefined

Значение свойства

AnalysisResult | undefined

Унаследованный от PollerLike.result

[toStringTag]

[toStringTag]: string

Значение свойства

string

Унаследовано от ПоллерЛайк. [toStringTag]

Сведения о наследуемом методе

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

Прилагает отклик только на отказ от Обещания.

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

Параметры

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

Призыв к исполнению, когда Обещание отклонено.

Возвращаемое значение

Promise<AnalysisResult | TResult>

Обещание завершить повторный вызов.

Унаследованный от PollerLike.catch

finally(() => void | null)

Прикрепляет обратный вызов, который вызывается при выполнении Обещания (исполнении или отклонении). Разрешённое значение нельзя изменить из обратного вызова.

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

Параметры

onfinally: () => void | null

Призыв к исполнению, когда Обещание будет выполнено (выполнено или отклонено).

Возвращаемое значение

Promise<AnalysisResult>

Обещание завершить повторный вызов.

Унаследованный от Наконец-то PollerLike.

onProgress((state: AnalysisOperationState) => void)

Вызывает предоставленный обратный вызов после завершения каждого голосования, отправляя текущее состояние работы опросчика.

Он возвращает метод, который может быть использован для прекращения получения обновлений по заданной функции обратного вызова.

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

Параметры

callback: (state: AnalysisOperationState) => void

Возвращаемое значение

CancelOnProgress

Унаследованный от PollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

Возвращает обещание, которое будет решено после завершения одного запроса на опрос. Это происходит путём вызова метода обновления операции Poller.

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

Параметры

options: { abortSignal?: AbortSignalLike }

Возвращаемое значение

Promise<AnalysisOperationState>

Унаследованный от PollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

Возвращает обещание, которое разрешается после завершения базовой операции.

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

Параметры

pollOptions: { abortSignal?: AbortSignalLike }

Возвращаемое значение

Promise<AnalysisResult>

Унаследованный от PollerLike.pollUntilDone

serialize()

Возвращает обещание, которое можно использовать для сериализированной версии операции опросчика, вызвав метод сериализации операции.

function serialize(): Promise<string>

Возвращаемое значение

Promise<string>

Унаследованный от PollerLike.serialize

submitted()

Возвращает обещание, которое можно использовать для проверки, был ли опросник отправлен.

function submitted(): Promise<void>

Возвращаемое значение

Promise<void>

Унаследованный от PollerLike.submitted

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

Прилагает обратные запросы для разрешения и/или отказа от Обещания.

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

Параметры

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

Призыв к исполнению, когда Обещание будет разрешено.

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

Призыв к исполнению, когда Обещание отклонено.

Возвращаемое значение

Promise<TResult1 | TResult2>

Обещание завершить любое выполненное обратное обращение.

Унаследованный от PollerLike.then.