Update docs

This commit is contained in:
Yiorgis Gozadinos 2025-11-04 18:49:57 +02:00
parent 5ed8c9cf44
commit 700e7c94e0
No known key found for this signature in database
3 changed files with 66 additions and 48 deletions

View file

@ -23,13 +23,29 @@ Retrieval-Augmented Generation (RAG) library built on LanceDB.
- **A2A agent**: Conversational agent with context and multi-turn dialogue
- **CLI & Python API**: Use from command line or Python
## Installation
**Python 3.12 or newer required**
### Full Package (Recommended)
```bash
uv pip install haiku.rag
```
Includes all features: document processing, all embedding providers, rerankers, and A2A agent support.
### Slim Package (Minimal Dependencies)
```bash
uv pip install haiku.rag-slim
```
Install only the extras you need. See the [Installation](https://ggozad.github.io/haiku.rag/installation/) documentation for available options
## Quick Start
```bash
# Install
# Python 3.12 or newer required
uv pip install haiku.rag
# Add documents
haiku-rag add "Your content here"
haiku-rag add "Your content here" --meta author=alice --meta topic=notes

View file

@ -238,10 +238,10 @@ If neither is set, it defaults to `http://localhost:11434`.
### VoyageAI
If you want to use VoyageAI embeddings you will need to install `haiku.rag` with the VoyageAI extras:
If you installed `haiku.rag` (full package), VoyageAI is already included. If you installed `haiku.rag-slim`, install with VoyageAI extras:
```bash
uv pip install haiku.rag[voyageai]
uv pip install haiku.rag-slim[voyageai]
```
```yaml
@ -396,10 +396,10 @@ Reranking is **disabled by default** (`provider: ""`) for faster searches. You c
### MixedBread AI
For MxBAI reranking, install with mxbai extras:
If you installed `haiku.rag` (full package), MxBAI is already included. If you installed `haiku.rag-slim`, add the mxbai extra:
```bash
uv pip install haiku.rag[mxbai]
uv pip install haiku.rag-slim[mxbai]
```
Then configure:
@ -412,10 +412,10 @@ reranking:
### Cohere
Install with cohere extras:
If you installed `haiku.rag` (full package), Cohere is already included. If you installed `haiku.rag-slim`, add the cohere extra:
```bash
uv pip install haiku.rag[cohere]
uv pip install haiku.rag-slim[cohere]
```
Then configure:
@ -434,10 +434,10 @@ export CO_API_KEY=your-api-key
### Zero Entropy
Install with zeroentropy extras:
If you installed `haiku.rag` (full package), Zero Entropy is already included. If you installed `haiku.rag-slim`, add the zeroentropy extra:
```bash
uv pip install haiku.rag[zeroentropy]
uv pip install haiku.rag-slim[zeroentropy]
```
Then configure:

View file

@ -1,48 +1,50 @@
# Installation
## Basic Installation
## Choose Your Package
**haiku.rag** is available in two packages:
### Full Package (Recommended)
```bash
uv pip install haiku.rag
```
This includes support for:
- **Ollama** (default embedding provider using `mxbai-embed-large`)
The full package includes **all features and extras**:
- **Document processing** (Docling) - PDF, DOCX, PPTX, images, and 40+ file formats
- **All embedding providers** - Ollama, OpenAI, VoyageAI, Anthropic, vLLM
- **All rerankers** - MixedBread AI, Cohere, Zero Entropy, vLLM
- **A2A agent** - Agent-to-Agent protocol support
This is the easiest way to get started with all features enabled.
### Slim Package (Minimal Dependencies)
```bash
# Minimal installation (no document processing)
uv pip install haiku.rag-slim
# With document processing
uv pip install haiku.rag-slim[docling]
# With specific providers
uv pip install haiku.rag-slim[docling,voyageai,mxbai]
```
The slim package has minimal dependencies and lets you install only what you need:
- `docling` - PDF, DOCX, PPTX, images, and other document formats
- `voyageai` - VoyageAI embeddings
- `mxbai` - MixedBread AI reranking
- `a2a` - Agent-to-Agent protocol support
- `cohere` - Cohere reranking
- `zeroentropy` - Zero Entropy reranking
**Built-in providers** (no extras needed):
- **Ollama** (default embedding provider)
- **OpenAI** (GPT models for QA and embeddings)
- **Anthropic** (Claude models for QA)
- **vLLM** (high-performance local inference for embeddings, QA, and reranking)
## Provider-Specific Installation
For additional providers, install with extras:
### Embedding Providers
#### VoyageAI
```bash
uv pip install haiku.rag[voyageai]
```
### Reranking Providers
#### MixedBread AI
```bash
uv pip install haiku.rag[mxbai]
```
#### Cohere
```bash
uv pip install haiku.rag[cohere]
```
#### Zero Entropy
```bash
uv pip install haiku.rag[zeroentropy]
```
- **vLLM** (high-performance local inference)
### vLLM Setup