Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PiiEntityRecognitionSuccessResult

Package version

The result of a pii entity recognition action on a single document, containing the collection of Entity objects identified in that document.

Hierarchy

Index

Properties

entities

entities: Entity[]

The collection of entities identified in the input document.

Optional error

error: undefined

Discriminant to determine if this is an error result.

id

id: string

Unique, non-empty document identifier.

redactedText

redactedText: string

The text redacted.

Optional 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

warnings: DocumentWarning[]

An array of warning data corresponding to this document.

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

Generated using TypeDoc