Skip to main content
Version: latest

agrag.common.data_models.entity_search.EntityHit

Bases: BaseModel

One entity found by entity discovery.

Attributes:

  • entity_id (str) – The id of the entity node.
  • label (str) – The entity label the node was found under.
  • name (str) – The entity name.
  • properties (dict[str, Any]) – The schema properties of the entity. Internal fields, the embedding and the source chunk list are left out.
  • kind (EntityKind) – Whether the entity has a visible supporting passage.
  • score (float) – An ordering value. Higher scores rank first. It is not a confidence, and it is not a probability that the entity is correct.
  • legs (list[DiscoveryLeg]) – The search legs that found the entity.
  • support (list[SupportingPassage]) – Visible passages that mention the entity, up to the support limit of the call. Empty for an unsupported entity.

entity_id​

entity_id: str

kind​

kind: EntityKind

label​

label: str

legs​

legs: list[DiscoveryLeg]

name​

name: str

properties​

properties: dict[str, Any] = Field(default_factory=dict)

score​

score: float

support​

support: list[SupportingPassage] = Field(default_factory=list)