PiiEntity

import type { PiiEntity } from "https://aws-api.deno.dev/v0.3/services/comprehend.ts?docs=full";

Provides information about a PII entity.

interface PiiEntity {

BeginOffset?: number | null;

EndOffset?: number | null;

Score?: number | null;

Type?: PiiEntityType | null;

}

§Properties

BeginOffset?: number | null

[src]

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

EndOffset?: number | null

[src]

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Score?: number | null

[src]

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

Type?: PiiEntityType | null

[src]

The entity's type.