Repository navigation
π Quick RAG v1.0.0 - Production Ready
We're excited to announce Quick RAG v1.0.0 - the first production-ready release!
π What's New
β¨ Production Ready
- Thoroughly tested - All features tested with both Ollama and LM Studio
- Clean examples - 10 focused examples (5 for Ollama + 5 for LM Studio)
- Complete documentation - Full API docs and usage guides
- Stable API - No breaking changes planned
π Document Loaders
Load various document formats for RAG:
- PDF -
loadPDF()with pdf-parse - Word -
loadWord()for .docx files - Excel -
loadExcel()for .xlsx files - Text, JSON, Markdown - Built-in loaders
- Web Content -
loadURL(),loadURLs(),loadSitemap()
πͺ Smart Chunking
4 different chunking strategies:
chunkText()- Character-based with overlapchunkBySentences()- Semantic sentence splittingchunkDocuments()- Intelligent document chunkingchunkMarkdown()- Markdown-aware splitting
π·οΈ Metadata Filtering
Filter documents by any metadata field + minimum score threshold.
π¨ Dual Provider Support
Works seamlessly with both Ollama and LM Studio:
- Auto-detection of available providers
- Consistent API across both platforms
- Full SDK feature access (streaming, tool calling, etc.)
π§ Bug Fixes
- Fixed LM Studio
listLoaded()API call - Fixed embedding model caching issue
- Removed unused imports from examples
- Cleaned up example directory structure
π¦ Installation
npm install quick-ragOptional dependencies (install as needed):
npm install pdf-parse # PDF support
npm install mammoth # Word support
npm install xlsx # Excel supportπ Quick Start
Ollama
import {
OllamaRAGClient,
createOllamaRAGEmbedding,
InMemoryVectorStore
} from 'quick-rag';
const client = new OllamaRAGClient();
const embed = createOllamaRAGEmbedding(client, 'embeddinggemma');
const store = new InMemoryVectorStore(embed);
await store.addDocuments([{ text: 'Your knowledge here' }]);LM Studio
import {
LMStudioRAGClient,
createLMStudioRAGEmbedding,
InMemoryVectorStore
} from 'quick-rag';
const client = new LMStudioRAGClient();
const embed = createLMStudioRAGEmbedding(client, 'nomic-embed-text-v1.5');
const store = new InMemoryVectorStore(embed);
await store.addDocuments([{ text: 'Your knowledge here' }]);π Examples
Check out the example/ directory for:
- Basic usage - Get started quickly
- Document loading - Load PDFs, Word, Excel
- Metadata filtering - Advanced filtering
- Streaming - Real-time responses
- Test both providers - Verify your setup
π Acknowledgments
Thank you to everyone who provided feedback and helped test this release!
π Documentation
Full Changelog: v0.7.2...v1.0.0