Class HierarchyMetadata
java.lang.Object
com.tnsai.intelligence.rag.hierarchy.HierarchyMetadata
Canonical metadata keys for hierarchical retrieval.
Input documents declare ID, PARENT_ID, and
optionally SOURCE. The built-in Role binding uses an existing
entryId as the hierarchy ID when ID is absent and assigns
the enclosing @Knowledge.name() as SOURCE.
- Since:
- 0.13.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringNumber of parent edges between the hit and this result.static final StringWhether the hit belongs to a flat index with no parent.static final StringOriginal child-hit identifier that caused an expansion.static final StringStable hierarchy document identifier.static final StringIdentifier of the immediate parent document.static final StringStable child-to-parent identifier path.static final StringSource group used by annotation-level source fencing.static final StringReason expansion stopped before reaching the hierarchy root.static final StringWhether expansion stopped before reaching the hierarchy root. -
Method Summary
-
Field Details
-
ID
Stable hierarchy document identifier.- See Also:
-
PARENT_ID
Identifier of the immediate parent document.- See Also:
-
SOURCE
Source group used by annotation-level source fencing.- See Also:
-
HIT_ID
Original child-hit identifier that caused an expansion.- See Also:
-
DEPTH
Number of parent edges between the hit and this result.- See Also:
-
PATH
Stable child-to-parent identifier path.- See Also:
-
FLAT
Whether the hit belongs to a flat index with no parent.- See Also:
-
TRUNCATED
Whether expansion stopped before reaching the hierarchy root.- See Also:
-
STOP_REASON
Reason expansion stopped before reaching the hierarchy root.- See Also:
-