Skip to content

Glossary

  • Centralized Terms

    data/glossary.json drives all tooltips in the UI.

  • Cross-References

    Each term lists related entries to encourage discovery.

  • Editable

    Update the JSON file, not components, to change tooltip content.

Get started Configuration API

Source of Truth

data/glossary.json is parsed by the UI. Keep key values stable for long-lived tooltips.

Representative Entries

  • PostgreSQL pgvector URL (POSTGRES_URL)
  • Neo4j Connection URI (NEO4J_URI)
  • Final Top-K (FINAL_K)

Typos

Misspelled keys break existing tooltips silently. Validate JSON in CI.

Example Entries

Term Key Definition
PostgreSQL pgvector URL POSTGRES_URL Connection URL for pgvector-enabled Postgres
Neo4j Connection URI NEO4J_URI Connection URI for Neo4j graph
Final Top‑K FINAL_K Final result size after fusion/reranking 
flowchart LR
    glossary["glossary.json"] --> Tooltip["TooltipIcon"]
    Tooltip --> UI["UI"]
# Backend is not reading glossary by default; UI reads the JSON.

# Validate glossary.json structure
eq 0 $(jq . data/glossary.json >/dev/null 2>&1; echo $?) && echo OK || echo FAIL

// UI side: load glossary.json and feed into TooltipIcon

Consistency

Use the glossary for all UI textual explanations to avoid drift between screens.