AnalyzeHealthcareOperationState interface

Package:

@azure/ai-text-analytics

The state of the begin analyze healthcare polling operation.

Extends

AnalysisPollOperationState<PagedAnalyzeHealthcareEntitiesResult>

Inherited Properties

createdOn	The date and time the operation was created.
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

createdOn

The date and time the operation was created.

createdOn: Date

Property Value

Date

Inherited From AnalysisPollOperationState.createdOn

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 AnalysisPollOperationState.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 AnalysisPollOperationState.lastModifiedOn

operationId

The operation id.

operationId: string

Property Value

string

Inherited From AnalysisPollOperationState.operationId

result

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

result?: PagedAnalyzeHealthcareEntitiesResult

Property Value

PagedAnalyzeHealthcareEntitiesResult

Inherited From AnalysisPollOperationState.result

status

The current status of the operation.

status: TextAnalyticsOperationStatus

Property Value

TextAnalyticsOperationStatus

Inherited From AnalysisPollOperationState.status