Repository navigation
🧠 docs: Explain How LibreChat Uses the RAG API - #889
Merged
Merged
Conversation
Replace the generic benefits, challenges and conclusion sections of the RAG API feature page with how indexing, retrieval and answering actually work in LibreChat (k=5 per file, top 10 overall, citations, vector deletion), verified against LibreChat dev. Drop the first-person aside and replace the unlinked "official RAG API documentation" pointer with a link to the rag-api repository. Feedback: 1564667684472233985
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Contributor
📦 Next.js Bundle Analysis for librechat.aiThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The RAG API feature page spent most of its length on generic RAG marketing (benefits, research challenges, a conclusion that repeated the intro), had a first-person aside, and ended by pointing to "the official RAG API documentation" without a link. This replaces those sections with a short "How it works" covering what LibreChat actually does with the RAG API, keeps a brief concept explanation plus the IBM video (the configuration page links here for it), and links the rag-api repository.
The new facts were checked against LibreChat
dev:packages/api/src/files/rag/search.ts(k=5 per file, 10 closest overall, citation anchors),api/server/services/Files/VectorDB/crud.js(/embed), andpackages/api/src/files/rag.ts(vector deletion on file delete). The lazy indexing wording matches the Upload as Text page.Feedback addressed
1564667684472233985:/docs/features/rag_apiValidation
@mdx-js/mdx3.1.1 for both the old and new page: both oknpx fumadocs-mdx: generated without errors; frontmatter parsed withjs-yaml#filecitationsand#what-happens-under-the-hoodanchorsnpx eslint content/docs/features/rag_api.mdx: file is ignored by the ESLint config (no JS/TS changed)pnpm buildand Playwright, since only one MDX page's prose changedNot changed
1564504101033873449(/docs, "Not good"): no identifiable problem, non-actionable1564891098038403124(/es/docs): a list of names, no report, non-actionable1564892590002806825(/docs/features): positive rating with no message, non-actionable1565061743040790660(/pt-BR/docs): Portuguese greeting, non-actionable