LCORE-1426: BYOK Config refactoring - #247
Conversation
… config format Align config templates with the BYOK config refactoring in lightspeed-stack: - byok_rag → rag.byok.stores - rag_type → backend (faiss instead of inline::faiss, pgvector instead of remote::pgvector) - rag.tool → rag.retrieval.tool.sources Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
WalkthroughThe BYOK RAG configuration changed from ChangesBYOK RAG schema update
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 462-477: Update the db_path value in the README rag.byok.stores
example to use the generated configuration template format, including the
${env.RAG_DB_PATH:=...} environment-variable fallback around the existing
default path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: c42fff80-3b30-404f-8170-f8b16706106c
📒 Files selected for processing (3)
README.mdsrc/lightspeed_rag_content/config_templates.pytests/test_document_processor_llama_stack.py
| rag: | ||
| # inline: | ||
| # - custom-docs-0_1 | ||
| tool: | ||
| - custom-docs-0_1 | ||
| byok: | ||
| stores: | ||
| - rag_id: custom-docs-0_1 | ||
| backend: faiss | ||
| embedding_model: sentence-transformers/all-mpnet-base-v2 | ||
| embedding_dimension: 768 | ||
| vector_db_id: <generated-vector-store-id> | ||
| db_path: /home/<user>/rag-content/vector_db/custom_docs/0.1/faiss_store.db | ||
| retrieval: | ||
| # inline: | ||
| # sources: | ||
| # - custom-docs-0_1 | ||
| tool: | ||
| sources: | ||
| - custom-docs-0_1 |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Update db_path in the example to match the generated template.
The generated configuration now wraps the db_path with an environment variable fallback (${env.RAG_DB_PATH:=...}). Please consider updating the example to accurately reflect the actual generated lightspeed-stack.yaml.
📝 Proposed fix
- db_path: /home/<user>/rag-content/vector_db/custom_docs/0.1/faiss_store.db
+ db_path: ${env.RAG_DB_PATH:=/home/<user>/rag-content/vector_db/custom_docs/0.1/faiss_store.db}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| rag: | |
| # inline: | |
| # - custom-docs-0_1 | |
| tool: | |
| - custom-docs-0_1 | |
| byok: | |
| stores: | |
| - rag_id: custom-docs-0_1 | |
| backend: faiss | |
| embedding_model: sentence-transformers/all-mpnet-base-v2 | |
| embedding_dimension: 768 | |
| vector_db_id: <generated-vector-store-id> | |
| db_path: /home/<user>/rag-content/vector_db/custom_docs/0.1/faiss_store.db | |
| retrieval: | |
| # inline: | |
| # sources: | |
| # - custom-docs-0_1 | |
| tool: | |
| sources: | |
| - custom-docs-0_1 | |
| rag: | |
| byok: | |
| stores: | |
| - rag_id: custom-docs-0_1 | |
| backend: faiss | |
| embedding_model: sentence-transformers/all-mpnet-base-v2 | |
| embedding_dimension: 768 | |
| vector_db_id: <generated-vector-store-id> | |
| db_path: ${env.RAG_DB_PATH:=/home/<user>/rag-content/vector_db/custom_docs/0.1/faiss_store.db} | |
| retrieval: | |
| # inline: | |
| # sources: | |
| # - custom-docs-0_1 | |
| tool: | |
| sources: | |
| - custom-docs-0_1 |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 462 - 477, Update the db_path value in the README
rag.byok.stores example to use the generated configuration template format,
including the ${env.RAG_DB_PATH:=...} environment-variable fallback around the
existing default path.
|
/ok-to-test |
2 participants
Description
Update the
lightspeed-stack.yamlconfig templates generated by rag-content to match the unified RAG config format introduced in lightspeed-stack (LCORE-1426).byok_rag:top-level section →rag.byok.storesrag_typefield →backend(faissinstead ofinline::faiss,pgvectorinstead ofremote::pgvector)rag.tool:list →rag.retrieval.tool.sourcesType of change
Tools used to create PR
Related Tickets & Documents
Checklist before requesting a review
Testing
make test-unit)rag.byok.storeswithbackendfield,rag.retrieval.tool.sourcesSummary by CodeRabbit
New Features
Tests