Skip to main content
Version: latest

agrag.common.data_models.navigation.NavigationItem

Bases: BaseModel

One passage returned by a navigation call.

Attributes:

  • evidence_id (str) – The evidence id of the passage. Pass it to fetch, check_citations or navigate.
  • document_key (str) – The key of the document the passage belongs to.
  • heading_path (list[str]) – The headings above the passage, from the outermost down.
  • kind (Literal['text', 'table']) – "text" for running text and "table" for a table passage.
  • text (str) – The passage text, cut to the character budget of the call.
  • text_truncated (bool) – True when the text was cut to fit the character budget.
  • location (EvidenceLocation) – The offsets or pages of the passage.

document_key​

document_key: str

evidence_id​

evidence_id: str

heading_path​

heading_path: list[str] = Field(default_factory=list)

kind​

kind: Literal['text', 'table']

location​

location: EvidenceLocation

text​

text: str

text_truncated​

text_truncated: bool = False