Update extras and docs

This commit is contained in:
Yiorgis Gozadinos 2025-08-15 21:44:33 +02:00
parent 26a3715902
commit 4e2e6e490e
No known key found for this signature in database
3 changed files with 12 additions and 41 deletions

View file

@ -44,13 +44,7 @@ VOYAGE_API_KEY="your-api-key"
```
### OpenAI
If you want to use OpenAI embeddings you will need to install `haiku.rag` with the VoyageAI extras,
```bash
uv pip install haiku.rag[openai]
```
and set environment variables.
OpenAI embeddings are included in the default installation. Simply set environment variables:
```bash
EMBEDDINGS_PROVIDER="openai"
@ -73,13 +67,7 @@ OLLAMA_BASE_URL="http://localhost:11434"
### OpenAI
For OpenAI QA, you need to install haiku.rag with OpenAI extras:
```bash
uv pip install haiku.rag[openai]
```
Then configure:
OpenAI QA is included in the default installation. Simply configure:
```bash
QA_PROVIDER="openai"
@ -89,13 +77,7 @@ OPENAI_API_KEY="your-api-key"
### Anthropic
For Anthropic QA, you need to install haiku.rag with Anthropic extras:
```bash
uv pip install haiku.rag[anthropic]
```
Then configure:
Anthropic QA is included in the default installation. Simply configure:
```bash
QA_PROVIDER="anthropic"
@ -144,13 +126,7 @@ RERANK_MODEL="mixedbread-ai/mxbai-rerank-base-v2"
### Cohere
For Cohere reranking, install with Cohere extras:
```bash
uv pip install haiku.rag[cohere]
```
Then configure:
Cohere reranking is included in the default installation. Simply configure:
```bash
RERANK_PROVIDER="cohere"

View file

@ -6,11 +6,15 @@
uv pip install haiku.rag
```
By default, Ollama (with the `mxbai-embed-large` model) is used for embeddings.
This includes support for:
- **Ollama** (default embedding provider using `mxbai-embed-large`)
- **OpenAI** (GPT models for QA and embeddings)
- **Anthropic** (Claude models for QA)
- **Cohere** (reranking models)
## Provider-Specific Installation
For other embedding providers, install with extras:
For additional embedding providers, install with extras:
### VoyageAI
@ -18,16 +22,10 @@ For other embedding providers, install with extras:
uv pip install haiku.rag[voyageai]
```
### OpenAI
### MixedBread AI Reranking
```bash
uv pip install haiku.rag[openai]
```
### Anthropic
```bash
uv pip install haiku.rag[anthropic]
uv pip install haiku.rag[mxbai]
```
## Requirements

View file

@ -38,9 +38,6 @@ dependencies = [
[project.optional-dependencies]
voyageai = ["voyageai>=0.3.2"]
openai = ["openai>=1.0.0"]
anthropic = ["anthropic>=0.56.0"]
cohere = ["cohere>=5.16.1"]
mxbai = ["mxbai-rerank>=0.1.6"]
[project.scripts]