DocumentModelOperationState interface

套件:

@azure/ai-form-recognizer

模型建立作業的狀態。

Extends

@azure/core-lro.PollOperationState<DocumentModelDetails>,ModelAdministrationOperationStateCommon

繼承的屬性

apiVersion	用來定型此模型的 API 版本。
createdOn	作業建立的日期和時間。
error	如果作業發生任何錯誤，將會存在。
isCancelled	如果作業已取消，則為 True。
isCompleted	如果作業已完成，則為 True。
isStarted	如果作業已啟動，則為 True。
lastUpdatedOn	上次修改作業狀態的日期 & 時間。
operationId	此作業的唯一標識碼。
percentCompleted	介於 0 到 100 之間的數位，表示作業的進度。
result	如果作業以預期類型的結果結束，將會存在。
status	作業的狀態。 其中一個： “notStarted” “running” “succeeded” “failed” “canceled”
tags	與模型相關聯的其他使用者定義索引鍵/值組做為元數據。

繼承的屬性詳細資料

apiVersion

用來定型此模型的 API 版本。

apiVersion?: string

屬性值

string

繼承自ModelAdministrationOperationStateCommon.apiVersion

createdOn

作業建立的日期和時間。

createdOn: Date

屬性值

Date

繼承自ModelAdministrationOperationStateCommon.createdOn

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

lastUpdatedOn

上次修改作業狀態的日期 & 時間。

lastUpdatedOn: Date

屬性值

Date

繼承自ModelAdministrationOperationStateCommon.lastUpdatedOn

operationId

此作業的唯一標識碼。

operationId: string

屬性值

string

繼承自ModelAdministrationOperationStateCommon.operationId

percentCompleted

介於 0 到 100 之間的數位，表示作業的進度。

percentCompleted: number

屬性值

number

繼承自ModelAdministrationOperationStateCommon.percentCompleted

result

如果作業以預期類型的結果結束，將會存在。

result?: DocumentModelDetails

屬性值

DocumentModelDetails

繼承自 PollOperationState.result

status

作業的狀態。 其中一個：

• “notStarted”
• “running”
• “succeeded”
• “failed”
• “canceled”

status: OperationStatus

屬性值

OperationStatus

繼承自ModelAdministrationOperationStateCommon.status

tags

與模型相關聯的其他使用者定義索引鍵/值組做為元數據。

tags?: Record<string, string>

屬性值

Record<string, string>

繼承自ModelAdministrationOperationStateCommon.tags