Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Entity

entity object

Properties

Functions

Properties

Optional isPii

isPii: undefined | false | true

This flag is to indicate if it is PII entity or not.

Optional length

length: undefined | number

Length of entity text Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional offset

offset: undefined | number

The number of Unicode code points preceding this entity in the submitted text. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional score

score: undefined | number

Score or confidence of extracted entity type. Example: {@code 0.9999856066867399} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional text

text: undefined | string

Entity text like name of person, location, and so on.

Optional type

type: undefined | string

Type of entity text like PER, LOC, GPE and NOPE.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Entity): object

getJsonObj

  • getJsonObj(obj: Entity): object