danvics/haiku.rag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update extras and docs

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/configuration.md
View file

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

18
docs/installation.md
View file

@ -6,11 +6,15 @@
uv pip install haiku.rag 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 ## Provider-Specific Installation
For other embedding providers, install with extras: For additional embedding providers, install with extras:
### VoyageAI ### VoyageAI
@ -18,16 +22,10 @@ For other embedding providers, install with extras:
uv pip install haiku.rag[voyageai] uv pip install haiku.rag[voyageai]
``` ```
### OpenAI ### MixedBread AI Reranking
```bash ```bash
uv pip install haiku.rag[openai] uv pip install haiku.rag[mxbai]
```
### Anthropic
```bash
uv pip install haiku.rag[anthropic]
``` ```
## Requirements ## Requirements

3
pyproject.toml
View file

@ -38,9 +38,6 @@ dependencies = [
[project.optional-dependencies] [project.optional-dependencies]
voyageai = ["voyageai>=0.3.2"] 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"] mxbai = ["mxbai-rerank>=0.1.6"]
[project.scripts] [project.scripts]