DocumentModelOperationState interface

  • Reference
Package:
@azure/ai-form-recognizer

The state of a model creation operation.

Extends

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

Inherited Properties

apiVersion

The API version used to train this model.
createdOn

The Date and Time that the operation was created.
error

Will exist if the operation encountered any error.
isCancelled

True if the operation has been cancelled.
isCompleted

True if the operation has been completed.
isStarted

True if the operation has started.
lastUpdatedOn

The date & time that the operation state was last modified.
operationId

The unique ID of this operation.
percentCompleted

A number between 0 and 100 representing the progress of the operation.
result

Will exist if the operation concluded in a result of an expected type.
status

The status of the operation. One of:

  • "notStarted"
  • "running"
  • "succeeded"
  • "failed"
  • "canceled"
tags

Additional, user-defined key-value pairs associated with the model as metadata.

Inherited Property Details

apiVersion

The API version used to train this model.

apiVersion?: string

Property Value

string

Inherited From ModelAdministrationOperationStateCommon.apiVersion

createdOn

The Date and Time that the operation was created.

createdOn: Date

Property Value

Date

Inherited From ModelAdministrationOperationStateCommon.createdOn

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From PollOperationState.error

isCancelled

True if the operation has been cancelled.

isCancelled?: boolean

Property Value

boolean

Inherited From PollOperationState.isCancelled

isCompleted

True if the operation has been completed.

isCompleted?: boolean

Property Value

boolean

Inherited From PollOperationState.isCompleted

isStarted

True if the operation has started.

isStarted?: boolean

Property Value

boolean

Inherited From PollOperationState.isStarted

lastUpdatedOn

The date & time that the operation state was last modified.

lastUpdatedOn: Date

Property Value

Date

Inherited From ModelAdministrationOperationStateCommon.lastUpdatedOn

operationId

The unique ID of this operation.

operationId: string

Property Value

string

Inherited From ModelAdministrationOperationStateCommon.operationId

percentCompleted

A number between 0 and 100 representing the progress of the operation.

percentCompleted: number

Property Value

number

Inherited From ModelAdministrationOperationStateCommon.percentCompleted

result

Will exist if the operation concluded in a result of an expected type.

result?: DocumentModelDetails

Property Value

DocumentModelDetails

Inherited From PollOperationState.result

status

The status of the operation. One of:

  • "notStarted"
  • "running"
  • "succeeded"
  • "failed"
  • "canceled"
status: OperationStatus

Property Value

OperationStatus

Inherited From ModelAdministrationOperationStateCommon.status

tags

Additional, user-defined key-value pairs associated with the model as metadata.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From ModelAdministrationOperationStateCommon.tags