Skip to content

πŸŽ‰ Quick RAG v1.0.0 - Production Ready

Choose a tag to compare

@devemree devemree released this 04 Nov 12:08
· 55 commits to main since this release

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 overlap
  • chunkBySentences() - Semantic sentence splitting
  • chunkDocuments() - Intelligent document chunking
  • chunkMarkdown() - 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-rag

Optional 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:

  1. Basic usage - Get started quickly
  2. Document loading - Load PDFs, Word, Excel
  3. Metadata filtering - Advanced filtering
  4. Streaming - Real-time responses
  5. 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