Class Entity

A data class encapsulating an Entity.

Implements

Properties

feats gkbId gkbProperties id mentions sentiment stdForm type vectors

Methods

toString of

Properties

feats

feats: Map<string, string>

Custom features/properties.

gkbId

gkbId: null | string = null

Unique identifier of this entity in Geneea knowladge base.

gkbProperties

gkbProperties: GkbProperty[]

GKB properties. Since 3.3.0.

Readonlyid

id: string

ID of the entity used to refer to it from other objects.

mentions

mentions: EntityMention[]

Actual occurences of this entity in the text. Empty if not requested/supported.

sentiment

sentiment: null | Sentiment = null

Sentiment of this entity. null if not requested.

stdForm

stdForm: string

Standard form of the entity, abstracting from alternative names.

type

type: string

Basic type of this entity (e.g. person, location, ...).

vectors

vectors: null | Vector[] = null

Optional vectors for this entity.

Methods

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

Staticof

  • of(
        id: string,
        gkbId?: null | string,
        stdForm: string,
        type: string,
        mentions?: null | EntityMention[],
        feats?: null | Map<string, string>,
        sentiment?: null | Sentiment,
        vectors?: null | Vector[],
        gkbProperties?: null | GkbProperty[],
    ): Entity

  • Entity factory method, public constructor.

    Parameters

    • id: string
    • gkbId: null | string = null
    • stdForm: string
    • type: string
    • mentions: null | EntityMention[] = null
    • feats: null | Map<string, string> = null
    • sentiment: null | Sentiment = null
    • vectors: null | Vector[] = null
    • gkbProperties: null | GkbProperty[] = null

    Returns Entity

Settings

Member Visibility

On This Page

Properties
Methods