Version: latest

`agrag.common.data_models.navigation.NavigationResult`

Bases: BaseModel

The result of one navigation call.

Attributes:

status (NavigationStatus) – The overall outcome.
items (list[NavigationItem]) – The passages, in the order of the relation.
truncated (bool) – True when a bound cut the items or the text.
truncation_reason (TruncationReason | None) – The bound that cut the result, when truncated.
version_status (VersionStatus | None) – Whether the version of the starting passage is current. None when no passage was resolved.
multi_section (bool) – True when the starting passage covers more than one section, so parent returns one item per section.
detail (str | None) – A short message for a malformed or failed id. None otherwise.

`detail`

detail: str | None = None

items: list[NavigationItem] = Field(default_factory=list)

multi_section: bool = False

status: NavigationStatus

truncated: bool = False

truncation_reason: TruncationReason | None = None

version_status: VersionStatus | None = None