AnalysisOperationState interface

Package:

@azure/ai-content-understanding

The state of an analysis operation, extending the standard OperationState with analysis metadata.

Extends

OperationState<AnalysisResult>,AnalysisOperationMetadata

Inherited Properties

error	Will exist if the operation encountered any error.
operationId	The operation ID, used with getResultFile and deleteResult.
result	Will exist if the operation produced a result of the expected type.
status	The current status of the operation.
usage	Usage details of the analyze operation.

Inherited Property Details

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From OperationState.error

operationId

The operation ID, used with getResultFile and deleteResult.

operationId?: string

Property Value

string

Inherited From AnalysisOperationMetadata.operationId

result

Will exist if the operation produced a result of the expected type.

result?: AnalysisResult

Property Value

AnalysisResult

Inherited From OperationState.result

status

The current status of the operation.

status: OperationStatus

Property Value

OperationStatus

Inherited From OperationState.status

usage

Usage details of the analyze operation.

usage?: UsageDetails

Property Value

UsageDetails

Inherited From AnalysisOperationMetadata.usage