EnrichmentResult

Complete enrichment output for a single document.

Usage

Source

EnrichmentResult()

Combines all extracted information: entities, topics, relationships, and an optional summary.

Parameters

entities: list[ExtractedEntity] = list()


Entities found in the document.

topics: list[str] = list()


Topic labels assigned to the document.

relationships: list[ExtractedRelationship] = list()


Relationships between entities.

summary: str = ""

A short summary of the document content.

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


Additional enrichment metadata (model used, timing, etc.).

Examples

result = tb.EnrichmentResult(
    entities=[tb.ExtractedEntity(name="Python", entity_type="technology")],
    topics=["programming", "open-source"],
    summary="An overview of Python's key features.",
)
result.entity_names  # ["Python"]

Attributes

Name	Description
entity_count	Number of extracted entities.
entity_names	Names of all extracted entities.
relationship_count	Number of extracted relationships.
topic_count	Number of assigned topics.

---

entity_count

Number of extracted entities.

entity_count: int

---

entity_names

Names of all extracted entities.

entity_names: list[str]

---

relationship_count

Number of extracted relationships.

relationship_count: int

---

topic_count

Number of assigned topics.

topic_count: int