danvics/haiku.rag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
haiku.rag/docs/index.md
Yiorgis Gozadinos 8e2829bf0e
Documentation update for title
2025-09-22 12:45:32 +03:00

2.7 KiB
Raw Blame History

haiku.rag

haiku.rag is a Retrieval-Augmented Generation (RAG) library built to work with LanceDB as a local vector database. It uses LanceDB for storing embeddings and performs semantic (vector) search as well as full-text search combined through native hybrid search with Reciprocal Rank Fusion. Both open-source (Ollama, MixedBread AI) as well as commercial (OpenAI, VoyageAI) embedding providers are supported.

Note

: Starting with version 0.7.0, haiku.rag uses LanceDB instead of SQLite. If you have an existing SQLite database, use haiku-rag migrate old_database.sqlite to migrate your data safely.

Features

  • Local LanceDB: No need to run additional servers
  • Support for various embedding providers: Ollama, VoyageAI, OpenAI or add your own
  • Native Hybrid Search: Vector search combined with full-text search using native LanceDB RRF reranking
  • Reranking: Optional result reranking with MixedBread AI or Cohere
  • Question Answering: Built-in QA agents using Ollama, OpenAI, or Anthropic.
  • File monitoring: Automatically index files when run as a server
  • Extended file format support: Parse 40+ file formats including PDF, DOCX, HTML, Markdown, code files and more. Or add a URL!
  • MCP server: Exposes functionality as MCP tools
  • CLI commands: Access all functionality from your terminal
    • Add sources from text, files, or URLs, optionally with a human‑readable title
  • Python client: Call haiku.rag from your own python applications

Quick Start

Install haiku.rag:

uv pip install haiku.rag

Use from Python:

from haiku.rag.client import HaikuRAG

async with HaikuRAG("database.lancedb") as client:
    # Add a document
    doc = await client.create_document("Your content here")

    # Search documents
    results = await client.search("query")

    # Ask questions
    answer = await client.ask("Who is the author of haiku.rag?")

Or use the CLI:

haiku-rag add "Your document content"
haiku-rag add-src /path/to/document.pdf --title "Q3 Financial Report"
haiku-rag search "query"
haiku-rag ask "Who is the author of haiku.rag?"
haiku-rag migrate old_database.sqlite  # Migrate from SQLite

Documentation

  • Installation - Install haiku.rag with different providers
  • Configuration - Environment variables and settings
  • CLI - Command line interface usage
  • Server - File monitoring and server mode
  • MCP - Model Context Protocol integration
  • Python - Python API reference
  • Agents - QA agent and multi-agent research

License

This project is licensed under the MIT License.