Skip to content

Providers

Remind uses embedding providers for semantic retrieval. By default, it uses local embeddings — no API keys needed.

Provider matrix

ProviderEmbeddingsAPI key required
LocalYes (default)No
OpenAIYesYes
Azure OpenAIYesYes
OllamaYesNo (local server)

Local (default)

Uses fastembed with ONNX for fast local inference. No API keys or external calls.

json
{
  "embedding_provider": "local",
  "local": {
    "embedding_model": "sentence-transformers/all-MiniLM-L6-v2"
  }
}
bash
EMBEDDING_PROVIDER=local
LOCAL_EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2
SettingDefault
embedding_modelsentence-transformers/all-MiniLM-L6-v2

This is the default — no configuration needed to use it.

OpenAI

Higher-quality embeddings via OpenAI API.

json
{
  "embedding_provider": "openai",
  "openai": {
    "api_key": "sk-...",
    "embedding_model": "text-embedding-3-small"
  }
}
bash
OPENAI_API_KEY=sk-...
EMBEDDING_PROVIDER=openai
SettingDefault
api_key
base_urlnull (OpenAI default)
embedding_modeltext-embedding-3-small

Azure OpenAI

Embeddings via Azure.

json
{
  "embedding_provider": "azure_openai",
  "azure_openai": {
    "api_key": "...",
    "base_url": "https://your-resource.openai.azure.com",
    "embedding_deployment_name": "text-embedding-3-small",
    "embedding_size": 1536
  }
}
bash
AZURE_OPENAI_API_KEY=...
AZURE_OPENAI_API_BASE_URL=https://your-resource.openai.azure.com
AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME=text-embedding-3-small
EMBEDDING_PROVIDER=azure_openai
SettingDefault
api_key
base_url— (/openai/v1 appended automatically)
embedding_deployment_name
embedding_size1536

Ollama (local server)

Local embeddings via Ollama. Requires Ollama running:

bash
ollama pull nomic-embed-text
json
{
  "embedding_provider": "ollama",
  "ollama": {
    "url": "http://localhost:11434",
    "embedding_model": "nomic-embed-text"
  }
}
bash
OLLAMA_URL=http://localhost:11434
OLLAMA_EMBEDDING_MODEL=nomic-embed-text
EMBEDDING_PROVIDER=ollama
SettingDefault
urlhttp://localhost:11434
embedding_modelnomic-embed-text

Choosing a provider

Use caseRecommended
Getting startedLocal (default)
Higher quality retrievalOpenAI
Enterprise / complianceAzure OpenAI
Air-gapped / privacyLocal or Ollama

The local provider works well for most use cases. Switch to OpenAI or another remote provider if you need higher-quality embeddings for large knowledge bases.

Switching providers

When switching embedding providers, you'll need to re-embed existing content:

bash
remind clear-embeddings
remind re-embed --all

This is because different providers produce different embedding dimensions and vector spaces.

Released under the Apache 2.0 License.