AnalyzeBatchOperationState interface

Package:

@azure/ai-text-analytics

The state of the begin analyze polling operation.

Extends

PollOperationState<PagedAnalyzeBatchResult>,AnalyzeBatchOperationMetadata

Inherited Properties

actionFailedCount	Number of failed actions.
actionInProgressCount	Number of actions still in progress.
actionSucceededCount	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

actionFailedCount

Number of failed actions.

actionFailedCount: number

Property Value

number

Inherited From AnalyzeBatchOperationMetadata.actionFailedCount

actionInProgressCount

Number of actions still in progress.

actionInProgressCount: number

Property Value

number

Inherited From AnalyzeBatchOperationMetadata.actionInProgressCount

actionSucceededCount

Number of successfully completed actions.

actionSucceededCount: number

Property Value

number

Inherited From AnalyzeBatchOperationMetadata.actionSucceededCount

createdOn

The date and time the operation was created.

createdOn: Date

Property Value

Date

Inherited From AnalyzeBatchOperationMetadata.createdOn

displayName

The operation's display name.

displayName?: string

Property Value

string

Inherited From AnalyzeBatchOperationMetadata.displayName

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From PollOperationState.error

expiresOn

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

expiresOn?: Date

Property Value

Date

Inherited From AnalyzeBatchOperationMetadata.expiresOn

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

lastModifiedOn

The time the operation status was last updated.

lastModifiedOn: Date

Property Value

Date

Inherited From AnalyzeBatchOperationMetadata.lastModifiedOn

operationId

The operation id.

operationId: string

Property Value

string

Inherited From AnalyzeBatchOperationMetadata.operationId

result

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

result?: PagedAnalyzeBatchResult

Property Value

PagedAnalyzeBatchResult

Inherited From PollOperationState.result

status

The current status of the operation.

status: OperationStatus

Property Value

OperationStatus

Inherited From AnalyzeBatchOperationMetadata.status