BatchActionSuccessResult interface

Package:

@azure/ai-text-analytics

The state of a succeeded batched action.

Extends

BatchActionState<Kind>

Properties

completedOn	When this action was completed by the service.
error	Discriminant to determine if that this is an error result.
results	The list of document results.

Inherited Properties

actionName	The name of the action.
kind	The kind of the action results.
statistics	Action statistics.

Property Details

completedOn

When this action was completed by the service.

completedOn: Date

Property Value

Date

error

Discriminant to determine if that this is an error result.

error?: undefined

Property Value

undefined

results

The list of document results.

results: T[]

Property Value

T[]

Inherited Property Details

actionName

The name of the action.

actionName?: string

Property Value

string

Inherited From BatchActionState.actionName

kind

The kind of the action results.

kind: Kind

Property Value

Kind

Inherited From BatchActionState.kind

statistics

Action statistics.

statistics?: TextDocumentBatchStatistics

Property Value

TextDocumentBatchStatistics

Inherited From BatchActionState.statistics