AnalysisResultPoller interface

パッケージ:

@azure/ai-content-understanding

Extends

PollerLike<OperationState<AnalysisResult>, AnalysisResult>

プロパティ

operationId

操作の ID

継承されたプロパティ

isDone	投票者が投票を終えた場合は真実です。
operationState	操作の状態。 ポーラーがまだ提出されていない場合は、未定義のままになることがあります。
result	ポーラーの状態に関わらず、操作の結果値です。 実装によっては、未定義のものや最終的なTResult値の不完全な形である場合があります。
[toStringTag]

継承されたメソッド

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	約束の拒否だけにコールバックを付ける。
finally(null | () => void)	約束が成立(履行または拒否)された際に呼び起こされるコールバックを付けます。 解決された値はコールバックから変更できません。
onProgress((state: OperationState<AnalysisResult>) => void)	各ポーリング終了後に提供されたコールバックを呼び出し、ポーラーの現在の状態を送信します。 与えられたコールバック関数の更新を停止するためのメソッドを返します。
poll({ abortSignal?: AbortSignalLike })	単一のポーリングリクエストが完了すると解決する約束を返します。 これはポーラーの演算の更新メソッドを呼び出しることで行われます。
pollUntilDone({ abortSignal?: AbortSignalLike })	基礎操作が完了すると解決される約束を返します。
serialize()	操作のシリアライズメソッドを呼び出して、ポーラーの操作のシリアル化バージョンに使える約束を返します。
submitted()	ポーラーが提出されているかどうかを確認するために使える約束を返します。
then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	Promiseの解決や拒否のためのコールバックを添付します。

プロパティの詳細

operationId

操作の ID

operationId?: string

プロパティ値

string

継承されたプロパティの詳細

isDone

投票者が投票を終えた場合は真実です。

isDone: boolean

プロパティ値

boolean

継承者 PollerLike.isDone(投票好き)が終わった

operationState

操作の状態。 ポーラーがまだ提出されていない場合は、未定義のままになることがあります。

operationState: undefined | OperationState<AnalysisResult>

プロパティ値

undefined | OperationState<AnalysisResult>

継承者 PollerLike.operationState

result

ポーラーの状態に関わらず、操作の結果値です。 実装によっては、未定義のものや最終的なTResult値の不完全な形である場合があります。

result: undefined | AnalysisResult

プロパティ値

undefined | AnalysisResult

継承者 PollerLike.結果

[toStringTag]

[toStringTag]: string

プロパティ値

string

継承者 PollerLike.__@toStringTag@401

継承済みメソッドの詳細

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

約束の拒否だけにコールバックを付ける。

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

パラメーター

onrejected

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

約束が拒否されたときに実行するためのコールバック。

戻り値

Promise<AnalysisResult | TResult>

コールバックの完了に対する約束。

継承者 PollerLike.catch

finally(null | () => void)

約束が成立(履行または拒否)された際に呼び起こされるコールバックを付けます。 解決された値はコールバックから変更できません。

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

パラメーター

onfinally

null | () => void

Promiseが決済された(履行または拒否)後にコールバックを実行します。

戻り値

Promise<AnalysisResult>

コールバックの完了に対する約束。

継承者 PollerLike。ついに

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

各ポーリング終了後に提供されたコールバックを呼び出し、ポーラーの現在の状態を送信します。

与えられたコールバック関数の更新を停止するためのメソッドを返します。

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

パラメーター

callback

(state: OperationState<AnalysisResult>) => void

戻り値

CancelOnProgress

継承者 PollerLike.onProgress(調査結果の洪水

poll({ abortSignal?: AbortSignalLike })

単一のポーリングリクエストが完了すると解決する約束を返します。 これはポーラーの演算の更新メソッドを呼び出しることで行われます。

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

パラメーター

options

{ abortSignal?: AbortSignalLike }

戻り値

Promise<OperationState<AnalysisResult>>

継承者 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.subredded(投稿)です。

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

Promiseの解決や拒否のためのコールバックを添付します。

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

パラメーター

onfulfilled

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

Promiseが解決されたときに実行するためのコールバック。

onrejected

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

約束が拒否されたときに実行するためのコールバック。

戻り値

Promise<TResult1 | TResult2>

実行されたコールバックの完了に対する約束。

継承者 PollerLike.then.then