herocode/herodb
12
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
Maxime Van Hees
2025-10-20 11:38:21 +02:00
parent df780e20a2
commit 483ccb2ba8
8 changed files with 24 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/lance.md
View File

@@ -71,12 +71,11 @@ redis-cli -p 6379 SELECT 1
HeroDB embeds text internally at STORE/SEARCH time using a per-dataset EmbeddingConfig sidecar. Configure provider before creating a dataset to choose dimensions and provider.
Supported providers:
- openai (standard OpenAI or Azure OpenAI)
- openai (standard OpenAI API or custom OpenAI-compatible endpoints)
- testhash (deterministic, CI-friendly; no network)
Environment variables for OpenAI:
Environment variable for OpenAI:
- Standard OpenAI: export OPENAI_API_KEY=sk-...
- Azure OpenAI: export AZURE_OPENAI_API_KEY=...
RESP examples:
```bash
@@ -86,12 +85,9 @@ redis-cli -p 6379 LANCE.EMBEDDING CONFIG SET myset PROVIDER openai MODEL text-em
# OpenAI with reduced output dimension (e.g., 512) when supported
redis-cli -p 6379 LANCE.EMBEDDING CONFIG SET myset PROVIDER openai MODEL text-embedding-3-small PARAM dim 512
# Azure OpenAI (set env: AZURE_OPENAI_API_KEY)
# Custom OpenAI-compatible endpoint (e.g., self-hosted)
redis-cli -p 6379 LANCE.EMBEDDING CONFIG SET myset PROVIDER openai MODEL text-embedding-3-small \
PARAM use_azure true \
PARAM azure_endpoint https://myresource.openai.azure.com \
PARAM azure_deployment my-embed-deploy \
PARAM azure_api_version 2024-02-15 \
PARAM endpoint http://localhost:8081/v1/embeddings \
PARAM dim 512
# Deterministic test provider (no network, stable vectors)