Refine README for clarity and consistency

This commit is contained in:
S Jannette
2026-05-08 03:53:43 -04:00
committed by GitHub
parent 8dbdc1dea4
commit 7241b91c48

View File

@@ -31,27 +31,19 @@ make dev
## Rationale ## Rationale
NotebookLM is a powerful research tool, but it is proprietary and closed. This app demonstrates the core source-grounded Q&A pattern with transparent retrieval, generation, and groundedness scoring (LLM response quality cosine scoring) -- all with swappable models and is fully open source.
This clone demonstrates the core source-grounded Q&A pattern with transparent
retrieval, generation, and groundedness scoring (LLM response quality cosine scoring) -- all with swappable models/fully open source.
## Design ## Design
Two-package monorepo: Two-package monorepo:
- `server/` -- single Express backend with layered architecture - `server/` -- single Express backend with layered architecture (routes -> services -> stores). Routes orchestrate; services contain business logic; stores manage in-memory state.
(routes -> services -> stores). Routes orchestrate; services contain
business logic; stores manage in-memory state.
- `client/` -- React 19 SPA via Vite. Two-panel layout: sidebar for - `client/` -- React 19 SPA via Vite. Two-panel layout: sidebar for notebooks/data sources, main area for LLM chat with explorable citations, groundedness badges (cosine similarity scoring of LLM responses), and follow-up question chips.
notebooks/data sources, main area for LLM chat with explorable citations,
groundedness badges (cosine similarity scoring of LLM responses), and follow-up question chips.
## Query pipeline ## Query pipeline
Embed query (Voyage) -> k-NN search -> rerank (Voyage) -> Source Ingestion -> Parsing -> Chunking -> Embedding -> Storage (vector store) -> { user query submission } -> evaluation of user query → Retrieval -> Ranking -> Response Generation -> Response Groundedness Scoring
generate answer with citations (Claude) -> compute groundedness score
(cosine similarity of answer vs cited chunks).
## License ## License