RecognizePiiEntitiesSuccessResult interface

Package:

@azure/ai-text-analytics

The result of the recognize entities operation on a single document, containing the collection of Entity objects identified in that document.

Extends

TextAnalyticsSuccessResult

Properties

entities	The collection of entities identified in the input document.
redactedText	The text redacted.

Inherited 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

entities

The collection of entities identified in the input document.

entities: PiiEntity[]

Property Value

PiiEntity[]

redactedText

The text redacted.

redactedText: string

Property Value

string

Inherited Property Details

error

Discriminant to determine if that this is an error result.

error?: undefined

Property Value

undefined

Inherited From TextAnalyticsSuccessResult.error

id

Unique, non-empty document identifier.

id: string

Property Value

string

Inherited From TextAnalyticsSuccessResult.id

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

Inherited From TextAnalyticsSuccessResult.statistics

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[]

Inherited From TextAnalyticsSuccessResult.warnings