Update docs
This commit is contained in:
parent
5ed8c9cf44
commit
700e7c94e0
3 changed files with 66 additions and 48 deletions
24
README.md
24
README.md
|
|
@ -23,13 +23,29 @@ Retrieval-Augmented Generation (RAG) library built on LanceDB.
|
||||||
- **A2A agent**: Conversational agent with context and multi-turn dialogue
|
- **A2A agent**: Conversational agent with context and multi-turn dialogue
|
||||||
- **CLI & Python API**: Use from command line or Python
|
- **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
|
## Quick Start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install
|
|
||||||
# Python 3.12 or newer required
|
|
||||||
uv pip install haiku.rag
|
|
||||||
|
|
||||||
# Add documents
|
# Add documents
|
||||||
haiku-rag add "Your content here"
|
haiku-rag add "Your content here"
|
||||||
haiku-rag add "Your content here" --meta author=alice --meta topic=notes
|
haiku-rag add "Your content here" --meta author=alice --meta topic=notes
|
||||||
|
|
|
||||||
|
|
@ -238,10 +238,10 @@ If neither is set, it defaults to `http://localhost:11434`.
|
||||||
|
|
||||||
### VoyageAI
|
### 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
|
```bash
|
||||||
uv pip install haiku.rag[voyageai]
|
uv pip install haiku.rag-slim[voyageai]
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|
@ -396,10 +396,10 @@ Reranking is **disabled by default** (`provider: ""`) for faster searches. You c
|
||||||
|
|
||||||
### MixedBread AI
|
### 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
|
```bash
|
||||||
uv pip install haiku.rag[mxbai]
|
uv pip install haiku.rag-slim[mxbai]
|
||||||
```
|
```
|
||||||
|
|
||||||
Then configure:
|
Then configure:
|
||||||
|
|
@ -412,10 +412,10 @@ reranking:
|
||||||
|
|
||||||
### Cohere
|
### 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
|
```bash
|
||||||
uv pip install haiku.rag[cohere]
|
uv pip install haiku.rag-slim[cohere]
|
||||||
```
|
```
|
||||||
|
|
||||||
Then configure:
|
Then configure:
|
||||||
|
|
@ -434,10 +434,10 @@ export CO_API_KEY=your-api-key
|
||||||
|
|
||||||
### Zero Entropy
|
### 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
|
```bash
|
||||||
uv pip install haiku.rag[zeroentropy]
|
uv pip install haiku.rag-slim[zeroentropy]
|
||||||
```
|
```
|
||||||
|
|
||||||
Then configure:
|
Then configure:
|
||||||
|
|
|
||||||
|
|
@ -1,48 +1,50 @@
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
## Basic Installation
|
## Choose Your Package
|
||||||
|
|
||||||
|
**haiku.rag** is available in two packages:
|
||||||
|
|
||||||
|
### Full Package (Recommended)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv pip install haiku.rag
|
uv pip install haiku.rag
|
||||||
```
|
```
|
||||||
|
|
||||||
This includes support for:
|
The full package includes **all features and extras**:
|
||||||
- **Ollama** (default embedding provider using `mxbai-embed-large`)
|
- **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)
|
- **OpenAI** (GPT models for QA and embeddings)
|
||||||
- **Anthropic** (Claude models for QA)
|
- **Anthropic** (Claude models for QA)
|
||||||
- **vLLM** (high-performance local inference for embeddings, QA, and reranking)
|
- **vLLM** (high-performance local inference)
|
||||||
|
|
||||||
## 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 Setup
|
### vLLM Setup
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue