Skip to main content

Entity

A named or unnamed entity mentioned in the article, either directly or indirectly.

Fields

PropertyRequiredTypeDescription
idTruestring

Internal ID of the entity, used for cross-referencing from other objects.

gkbIdFalsestring

Unique identifier of the entity in the Geneea Knowledge Base.

stdFormTruestring

Standardized form of the entity name, abstracting away from alternative spellings or variants.

typeTruestring

Entity type (e.g., organization, location, person, product, event, general).

mentionsFalse

List[EntityMention]

Occurrences of the entity in the text, when available.
featsFalseMap[string, string]

Custom features extending the entity information. All values are encoded as strings. See Custom Features below for the list of available keys.

gkbPropertiesFalse

List[GkbProperty]

Additional properties from the Geneea Knowledge Base.

Custom Features (feats)

The feats object contains additional metadata as string key-value pairs. The available features depend on your account configuration.

Deprecation and Duplicates

These features indicate knowledge base lifecycle changes. See Deprecated and Duplicate IDs for more information.

KeyValue TypeExamplesDescription
duplicateGkbIdsComma-separated GKB IDs"G8ad70d13-E,Gfd6d708c-C"Deprecated duplicate knowledge base IDs that have been merged into this tag's ID.
replacedByGkbIdGKB ID"G22262439"The active knowledge base ID that replaces this deprecated item.
deprecatedBoolean"true"Present when the knowledge base item has been deprecated or replaced.

Derivation

These features are present on entities that were derived from other entities rather than mentioned directly.

KeyValue TypeExamplesDescription
derivedByComma-separated strings"country", "region,city"Relation(s) used to derive the entity from other entities. See Derived Entities.
derivedOnlyBoolean string"true"Present when the entity was inferred from other entities and is not mentioned directly in the text. See Derived Entities.

Relevance

KeyValue TypeExamplesDescription
relevanceInteger string 0100"96", "11"How central the entity is to the article. See the Relevance guide.
rankingInteger string 0100"96", "11"Obsolete synonym for relevance. Use relevance instead.

Simple Mention Reference

These features provide a lightweight way to locate an early occurrence of the entity in the original input text — useful for linking or highlighting without requesting the full mentions output.

The mentions are searched only in permitted paragraph types (typically just body text paragraphs) in most configurations, entity mentions in the title and abstract/lead paragraphs are skipped. Typically, the first such mention is returned; in very rare cases we might return another mention or no mention at all.

KeyValue TypeExamplesDescription
mentionTextString"Macron"The surface text of the mention.
mentionParaSpecId"<index>:<type>""3:BODY"Paragraph reference — the paragraph index and its type (TITLE, ABSTRACT (lead), or BODY).
mentionParaSpecSpan"<offset>:<length>""42:6"Character span (in Unicode code points) of the mention within its paragraph. These are raw offsets into the input text, before any HTML conversion, whitespace normalization, etc.