ExtractedEntity

An entity extracted from a document.

Usage

Source

ExtractedEntity(
    name,
    entity_type="unknown",
    mentions=1,
    metadata=dict(),
)

Parameters

name: str

The entity name (e.g. "Sarah Chen").

entity_type: str = "unknown"

Category such as "person", "organization", "technology", "project", "date".

mentions: int = 1

Number of times the entity appears in the source document.

metadata: dict[str, Any] = dict()


Extra information about the entity (role, description, etc.).

Examples

import talk_box as tb

entity = tb.ExtractedEntity(
    name="Sarah Chen",
    entity_type="person",
    mentions=3,
    metadata={"role": "Tech Lead"},
)
entity.name  # "Sarah Chen"