PiiEntity interface

An entity from PII recognition with information about the kind of PII encountered.

Extends

Properties

category

Entity type.

confidenceScore

Confidence score between 0 and 1 of the extracted entity.

length

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.

offset

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.

subCategory

(Optional) Entity sub type.

text

Entity text as appears in the request.

Property Details

category

Entity type.

category: string

Property Value

string

confidenceScore

Confidence score between 0 and 1 of the extracted entity.

confidenceScore: number

Property Value

number

length

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.

length: number

Property Value

number

offset

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.

offset: number

Property Value

number

subCategory

(Optional) Entity sub type.

subCategory?: string

Property Value

string

text

Entity text as appears in the request.

text: string

Property Value

string