Update docs

This commit is contained in:
Yiorgis Gozadinos 2025-12-02 12:01:10 +02:00
parent 3525fae625
commit 47d8f7ba3f
No known key found for this signature in database
4 changed files with 42 additions and 33 deletions

View file

@ -25,9 +25,10 @@ Create a configuration file `haiku.rag.yaml`:
environment: production environment: production
embeddings: embeddings:
provider: ollama model:
model: nomic-embed-text provider: ollama
vector_dim: 768 name: nomic-embed-text
vector_dim: 768
qa: qa:
model: model:

View file

@ -35,9 +35,10 @@ A minimal configuration file with defaults:
environment: production environment: production
embeddings: embeddings:
provider: ollama model:
model: qwen3-embedding:4b provider: ollama
vector_dim: 2560 name: qwen3-embedding:4b
vector_dim: 2560
qa: qa:
model: model:
@ -69,9 +70,10 @@ lancedb:
region: "" region: ""
embeddings: embeddings:
provider: ollama model:
model: qwen3-embedding:4b provider: ollama
vector_dim: 2560 name: qwen3-embedding:4b
vector_dim: 2560
reranking: reranking:
model: model:
@ -149,7 +151,7 @@ When using haiku.rag as a Python library, you can pass configuration directly to
```python ```python
from haiku.rag.config import AppConfig from haiku.rag.config import AppConfig
from haiku.rag.config.models import ModelConfig, QAConfig, EmbeddingsConfig from haiku.rag.config.models import EmbeddingModelConfig, ModelConfig, QAConfig, EmbeddingsConfig
from haiku.rag.client import HaikuRAG from haiku.rag.client import HaikuRAG
# Create custom configuration # Create custom configuration
@ -157,16 +159,16 @@ custom_config = AppConfig(
qa=QAConfig( qa=QAConfig(
model=ModelConfig( model=ModelConfig(
provider="openai", provider="openai",
model="gpt-4o", name="gpt-4o",
temperature=0.7 temperature=0.7
) )
), ),
embeddings=EmbeddingsConfig( embeddings=EmbeddingsConfig(
model=ModelConfig( model=EmbeddingModelConfig(
provider="ollama", provider="ollama",
model="qwen3-embedding:4b" name="qwen3-embedding:4b",
), vector_dim=2560
vector_dim=2560 )
), ),
processing={"chunk_size": 512} processing={"chunk_size": 512}
) )

View file

@ -73,9 +73,10 @@ If you use Ollama, you can use any pulled model that supports embeddings.
```yaml ```yaml
embeddings: embeddings:
provider: ollama model:
model: mxbai-embed-large provider: ollama
vector_dim: 1024 name: mxbai-embed-large
vector_dim: 1024
``` ```
The Ollama base URL can be configured in your config file or via environment variable: The Ollama base URL can be configured in your config file or via environment variable:
@ -104,9 +105,10 @@ uv pip install haiku.rag-slim[voyageai]
```yaml ```yaml
embeddings: embeddings:
provider: voyageai model:
model: voyage-3.5 provider: voyageai
vector_dim: 1024 name: voyage-3.5
vector_dim: 1024
``` ```
Set your API key via environment variable: Set your API key via environment variable:
@ -121,9 +123,10 @@ OpenAI embeddings are included in the default installation:
```yaml ```yaml
embeddings: embeddings:
provider: openai model:
model: text-embedding-3-small # or text-embedding-3-large provider: openai
vector_dim: 1536 name: text-embedding-3-small # or text-embedding-3-large
vector_dim: 1536
``` ```
Set your API key via environment variable: Set your API key via environment variable:
@ -138,9 +141,10 @@ For high-performance local inference, you can use vLLM to serve embedding models
```yaml ```yaml
embeddings: embeddings:
provider: vllm model:
model: mixedbread-ai/mxbai-embed-large-v1 provider: vllm
vector_dim: 512 name: mixedbread-ai/mxbai-embed-large-v1
vector_dim: 512
providers: providers:
vllm: vllm:
@ -155,9 +159,10 @@ providers:
```yaml ```yaml
embeddings: embeddings:
provider: lm_studio model:
model: text-embedding-qwen3-embedding-4b provider: lm_studio
vector_dim: 2560 name: text-embedding-qwen3-embedding-4b
vector_dim: 2560
providers: providers:
lm_studio: lm_studio:

View file

@ -33,9 +33,10 @@ Configure haiku.rag to use OpenAI. Create a `haiku.rag.yaml` file:
```yaml ```yaml
embeddings: embeddings:
provider: openai model:
model: text-embedding-3-small # or text-embedding-3-large provider: openai
vector_dim: 1536 name: text-embedding-3-small # or text-embedding-3-large
vector_dim: 1536
qa: qa:
model: model: