Minor doc fixes

This commit is contained in:
Yiorgis Gozadinos 2025-06-27 19:58:34 +03:00
parent e07c849d3c
commit 7a1b09d5e2
No known key found for this signature in database
5 changed files with 7 additions and 18 deletions

View file

@ -2,6 +2,8 @@
Retrieval-Augmented Generation (RAG) library on SQLite.
`haiku.rag` is a Retrieval-Augmented Generation (RAG) library built to work on SQLite alone without the need for external vector databases. It uses [sqlite-vec](https://github.com/asg017/sqlite-vec) for storing the embeddings and performs semantic (vector) search as well as full-text search combined through Reciprocal Rank Fusion. Both open-source (Ollama) as well as commercial (OpenAI, VoyageAI) embedding providers are supported.
## Features
- **Local SQLite**: No external servers required

View file

@ -1,6 +1,6 @@
# Configuration
Configuration is done through environment variables.
Configuration is done through the use of environment variables.
## File Monitoring

View file

@ -1,6 +1,7 @@
# haiku.rag
A Retrieval-Augmented Generation (RAG) library on SQLite.
`haiku.rag` is a Retrieval-Augmented Generation (RAG) library built to work on SQLite alone without the need for external vector databases. It uses [sqlite-vec](https://github.com/asg017/sqlite-vec) for storing the embeddings and performs semantic (vector) search as well as full-text search combined through Reciprocal Rank Fusion. Both open-source (Ollama) as well as commercial (OpenAI, VoyageAI) embedding providers are supported.
## Features

View file

@ -1,6 +1,6 @@
# Model Context Protocol (MCP)
The MCP server exposes RAG functionality as tools for AI assistants like Claude Desktop.
The MCP server exposes `haiku.rag` as MCP tools for compatible MCP clients.
## Available Tools
@ -19,7 +19,7 @@ The MCP server exposes RAG functionality as tools for AI assistants like Claude
## Starting MCP Server
The MCP server starts automatically with the serve command:
The MCP server starts automatically with the serve command and supports `Streamable HTTP`, `stdio` and `SSE` transports:
```bash
# Default HTTP transport
@ -31,10 +31,3 @@ haiku-rag serve --stdio
# SSE transport
haiku-rag serve --sse
```
## Integration
The MCP server follows the Model Context Protocol specification, making it compatible with:
- Claude Desktop
- Other MCP-compatible AI assistants
- Custom MCP clients

View file

@ -92,10 +92,3 @@ for chunk, relevance_score in results:
print(f"Content: {chunk.content}")
print(f"From document: {chunk.document_id}")
```
## Search Technology
`haiku.rag` uses hybrid search combining:
- **Vector search** using `sqlite-vec` for semantic similarity
- **Full-text search** using SQLite's `FTS5` for keyword matching
- **Reciprocal Rank Fusion** to combine and rank results