DocumentAnalysisPollOperationState interface

パッケージ:

@azure/ai-form-recognizer

分析操作の状態。最終的にはモデルに対応する結果の型が生成されます。

Extends

@azure/core-lro.PollOperationState<Result>

プロパティ

createdOn	操作が作成された日付と時刻。
lastUpdatedOn	操作 & 状態が最後に変更された日時。
modelId	結果の生成に分析操作で使用されるモデル ID。
operationLocation	操作の URL。
status	操作の状態。 つぎのいずれかです。 "notStarted" "running" "succeeded" "failed"

継承されたプロパティ

error	操作でエラーが発生した場合は存在します。
isCancelled	True の 場合は、操作が取り消されました。
isCompleted	操作が完了した場合は True です。
isStarted	True を指定すると、操作が開始されます。
result	予期される型の結果として操作が終了した場合は存在します。

プロパティの詳細

createdOn

操作が作成された日付と時刻。

createdOn: Date

プロパティ値

Date

lastUpdatedOn

操作 & 状態が最後に変更された日時。

lastUpdatedOn: Date

プロパティ値

Date

modelId

結果の生成に分析操作で使用されるモデル ID。

modelId: string

プロパティ値

string

operationLocation

操作の URL。

operationLocation: string

プロパティ値

string

status

操作の状態。 つぎのいずれかです。

• "notStarted"
• "running"
• "succeeded"
• "failed"

status: AnalyzeResultOperationStatus

プロパティ値

AnalyzeResultOperationStatus

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

error

操作でエラーが発生した場合は存在します。

error?: Error

プロパティ値

Error

継承元 PollOperationState.error

isCancelled

True の 場合は、操作が取り消されました。

isCancelled?: boolean

プロパティ値

boolean

継承元 PollOperationState.isCancelled

isCompleted

操作が完了した場合は True です。

isCompleted?: boolean

プロパティ値

boolean

継承元 PollOperationState.isCompleted

isStarted

True を指定すると、操作が開始されます。

isStarted?: boolean

プロパティ値

boolean

継承元 PollOperationState.isStarted

result

予期される型の結果として操作が終了した場合は存在します。

result?: Result

プロパティ値

Result

継承元 PollOperationState.result