DocumentAnalysisPollOperationState interface

Package:

@azure/ai-form-recognizer

The state of an analysis operation, which will eventually produce the result type that corresponds to the model.

Extends

PollOperationState<Result>

Properties

createdOn	The Date and Time that the operation was created.
lastUpdatedOn	The date & time that the operation state was last modified.
modelId	The model ID that the analysis operation will use to produce the result.
operationLocation	The URL to the operation.
status	The status of the operation. One of: "notStarted" "running" "succeeded" "failed"

Inherited Properties

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.
result	Will exist if the operation concluded in a result of an expected type.

Property Details

createdOn

The Date and Time that the operation was created.

createdOn: Date

Property Value

Date

lastUpdatedOn

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

lastUpdatedOn: Date

Property Value

Date

modelId

The model ID that the analysis operation will use to produce the result.

modelId: string

Property Value

string

operationLocation

The URL to the operation.

operationLocation: string

Property Value

string

status

The status of the operation. One of:

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

status: AnalyzeResultOperationStatus

Property Value

AnalyzeResultOperationStatus

Inherited Property Details

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

result

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

result?: Result

Property Value

Result

Inherited From PollOperationState.result