AnalyzeActionsOperationState interface

Package:

@azure/ai-text-analytics

The state of the begin analyze polling operation.

Extends

AnalysisPollOperationState<PagedAnalyzeActionsResult>,AnalyzeActionsOperationMetadata

Inherited Properties

actionsFailedCount	Number of failed actions.
actionsInProgressCount	Number of actions still in progress.
actionsSucceededCount	Number of successfully completed actions.
createdOn	The date and time the operation was created.
displayName	The operation's display name.
error	Will exist if the operation encountered any error.
expiresOn	The date and time when the operation results will expire on the server.
isCancelled	True if the operation has been cancelled.
isCompleted	True if the operation has been completed.
isStarted	True if the operation has started.
lastModifiedOn	The time the operation status was last updated.
operationId	The operation id.
result	Will exist if the operation concluded in a result of an expected type.
status	The current status of the operation.

Inherited Property Details

actionsFailedCount

Number of failed actions.

actionsFailedCount: number

Property Value

number

Inherited From AnalyzeActionsOperationMetadata.actionsFailedCount

actionsInProgressCount

Number of actions still in progress.

actionsInProgressCount: number

Property Value

number

Inherited From AnalyzeActionsOperationMetadata.actionsInProgressCount

actionsSucceededCount

Number of successfully completed actions.

actionsSucceededCount: number

Property Value

number

Inherited From AnalyzeActionsOperationMetadata.actionsSucceededCount

createdOn

The date and time the operation was created.

createdOn: Date

Property Value

Date

Inherited From AnalyzeActionsOperationMetadata.createdOn

displayName

The operation's display name.

displayName?: string

Property Value

string

Inherited From AnalyzeActionsOperationMetadata.displayName

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From AnalysisPollOperationState.error

expiresOn

The date and time when the operation results will expire on the server.

expiresOn?: Date

Property Value

Date

Inherited From AnalyzeActionsOperationMetadata.expiresOn

isCancelled

True if the operation has been cancelled.

isCancelled?: boolean

Property Value

boolean

Inherited From AnalysisPollOperationState.isCancelled

isCompleted

True if the operation has been completed.

isCompleted?: boolean

Property Value

boolean

Inherited From AnalysisPollOperationState.isCompleted

isStarted

True if the operation has started.

isStarted?: boolean

Property Value

boolean

Inherited From AnalysisPollOperationState.isStarted

lastModifiedOn

The time the operation status was last updated.

lastModifiedOn: Date

Property Value

Date

Inherited From AnalyzeActionsOperationMetadata.lastModifiedOn

operationId

The operation id.

operationId: string

Property Value

string

Inherited From AnalyzeActionsOperationMetadata.operationId

result

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

result?: PagedAnalyzeActionsResult

Property Value

PagedAnalyzeActionsResult

Inherited From AnalysisPollOperationState.result

status

The current status of the operation.

status: TextAnalyticsOperationStatus

Property Value

TextAnalyticsOperationStatus

Inherited From AnalyzeActionsOperationMetadata.status