113 lines
3.4 KiB
Markdown
113 lines
3.4 KiB
Markdown
# Models
|
|
|
|
Hindsight uses several machine learning models for different tasks.
|
|
|
|
## Overview
|
|
|
|
| Model Type | Purpose | Default | Configurable |
|
|
|------------|---------|---------|--------------|
|
|
| **Embedding** | Vector representations for semantic search | `BAAI/bge-small-en-v1.5` | Yes |
|
|
| **Cross-Encoder** | Reranking search results | `ms-marco-MiniLM-L-6-v2` | Yes |
|
|
| **LLM** | Fact extraction, reasoning, generation | Provider-specific | Yes |
|
|
|
|
All local models (embedding, cross-encoder) are automatically downloaded from HuggingFace on first run.
|
|
|
|
---
|
|
|
|
## Embedding Model
|
|
|
|
Converts text into dense vector representations for semantic similarity search.
|
|
|
|
**Default:** `BAAI/bge-small-en-v1.5` (384 dimensions, ~130MB)
|
|
|
|
**Alternatives:**
|
|
|
|
| Model | Dimensions | Use Case |
|
|
|-------|------------|----------|
|
|
| `BAAI/bge-small-en-v1.5` | 384 | Default, fast, good quality |
|
|
| `BAAI/bge-base-en-v1.5` | 768 | Higher accuracy, slower |
|
|
| `sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2` | 384 | Multilingual (50+ languages) |
|
|
|
|
**Configuration:**
|
|
|
|
```bash
|
|
export HINDSIGHT_API_EMBEDDING_MODEL=BAAI/bge-base-en-v1.5
|
|
export HINDSIGHT_API_EMBEDDING_DEVICE=cuda # or mps for Apple Silicon
|
|
export HINDSIGHT_API_EMBEDDING_BATCH_SIZE=64
|
|
```
|
|
|
|
---
|
|
|
|
## Cross-Encoder (Reranker)
|
|
|
|
Reranks initial search results to improve precision.
|
|
|
|
**Default:** `cross-encoder/ms-marco-MiniLM-L-6-v2` (~85MB)
|
|
|
|
**Alternatives:**
|
|
|
|
| Model | Use Case |
|
|
|-------|----------|
|
|
| `ms-marco-MiniLM-L-6-v2` | Default, fast |
|
|
| `ms-marco-MiniLM-L-12-v2` | Higher accuracy |
|
|
| `mmarco-mMiniLMv2-L12-H384-v1` | Multilingual |
|
|
|
|
**Configuration:**
|
|
|
|
```bash
|
|
export HINDSIGHT_API_RERANK_MODEL=cross-encoder/ms-marco-MiniLM-L-12-v2
|
|
export HINDSIGHT_API_RERANK_TOP_K=50 # How many results to rerank
|
|
export HINDSIGHT_API_RERANK_ENABLED=true # Set to false to disable
|
|
```
|
|
|
|
---
|
|
|
|
## LLM
|
|
|
|
Used for fact extraction, entity resolution, opinion generation, and answer synthesis.
|
|
|
|
**Supported providers:** Groq, OpenAI, Ollama, Gemini
|
|
|
|
| Provider | Recommended Model | Best For |
|
|
|----------|------------------|----------|
|
|
| **Groq** | `openai/gpt-oss-20b` | Fast inference, high throughput (recommended) |
|
|
| **OpenAI** | `gpt-5-mini` | Good quality |
|
|
| **Gemini** | `gemini-2.5-flash` | Good quality |
|
|
| **Ollama** | `gpt-oss-20b` | Local deployment, privacy |
|
|
|
|
**Configuration:**
|
|
|
|
```bash
|
|
# Groq (recommended)
|
|
export HINDSIGHT_API_LLM_PROVIDER=groq
|
|
export HINDSIGHT_API_LLM_API_KEY=gsk_xxxxxxxxxxxx
|
|
export HINDSIGHT_API_LLM_MODEL=openai/gpt-oss-20b
|
|
|
|
# OpenAI
|
|
export HINDSIGHT_API_LLM_PROVIDER=openai
|
|
export HINDSIGHT_API_LLM_API_KEY=sk-xxxxxxxxxxxx
|
|
export HINDSIGHT_API_LLM_MODEL=gpt-5-mini
|
|
|
|
# Gemini
|
|
export HINDSIGHT_API_LLM_PROVIDER=gemini
|
|
export HINDSIGHT_API_LLM_API_KEY=xxxxxxxxxxxx
|
|
export HINDSIGHT_API_LLM_MODEL=gemini-2.5-flash
|
|
|
|
# Ollama (local)
|
|
export HINDSIGHT_API_LLM_PROVIDER=ollama
|
|
export HINDSIGHT_API_LLM_BASE_URL=http://localhost:11434/v1
|
|
export HINDSIGHT_API_LLM_MODEL=gpt-oss-20b
|
|
```
|
|
|
|
**Note:** The LLM is the primary bottleneck for write operations. See [Performance](./performance) for optimization strategies.
|
|
|
|
---
|
|
|
|
## Model Comparison
|
|
|
|
| Provider | Model | Speed | Quality | Cost |
|
|
|----------|-------|-------|---------|------|
|
|
| Groq | gpt-oss-20b | Fast | Good | Free tier |
|
|
| OpenAI | gpt-4o-mini | Medium | Good | $0.15 / $0.60 per 1M tokens |
|
|
| OpenAI | gpt-4o | Slower | Best | $2.50 / $10.00 per 1M tokens |
|
|
| Ollama | llama3.1 | Varies | Good | Free (local) |
|