TextAnalyticsSuccessResult interface

Package:

@azure/ai-text-analytics

Base type for results of text analytics operations corresponding to a single input document.

Properties

error	Discriminant to determine if that this is an error result.
id	Unique, non-empty document identifier.
statistics	Statistics about the input document and how it was processed by the service. This property will have a value when includeStatistics is set to true in the client call.
warnings	An array of warning data corresponding to this document. If no warnings were returned, this array will be empty.

Property Details

error

Discriminant to determine if that this is an error result.

error?: undefined

Property Value

undefined

id

Unique, non-empty document identifier.

id: string

Property Value

string

statistics

Statistics about the input document and how it was processed by the service. This property will have a value when includeStatistics is set to true in the client call.

statistics?: TextDocumentStatistics

Property Value

TextDocumentStatistics

warnings

An array of warning data corresponding to this document.

If no warnings were returned, this array will be empty.

warnings: TextAnalyticsWarning[]

Property Value

TextAnalyticsWarning[]