Interface PiiEntity

Provides information about a PII entity.

interface PiiEntity {
    BeginOffset?: number;
    EndOffset?: number;
    Score?: number;
    Type?: PiiEntityType;
}

Properties

BeginOffset?: number

The zero-based offset from the beginning of the source text to the first character in the entity.

EndOffset?: number

The zero-based offset from the beginning of the source text to the last character in the entity.

Score?: number

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

The entity's type.