Skip to content

配置项速查

配置由 Pydantic Settings 管理,从环境变量或 .env 读取。完整分组说明见 配置系统。这里是速查表:想改某个行为,找对应变量。

代码位置:src/ultimate_rag/config.py

1. 必填

环境变量说明
DASHSCOPE_API_KEY百炼 API Key,只从 .env 提供,禁止提交 Git

2. 按「想做什么」查变量

想做什么改哪个变量
限制上传文件大小MAX_UPLOAD_BYTES(默认 10MB)
调整 Chunk 大小CHUNK_MAX_TOKENS(512)、CHUNK_OVERLAP_TOKENS(64)
修改 Embedding 前 Chunk 快照目录CHUNK_SNAPSHOT_DIRdata/chunk_snapshots
换问答模型LLM_MODEL(qwen-plus)
换 Embedding 模型EMBEDDING_MODEL(text-embedding-v4)、EMBEDDING_DIMENSION(1024)
换 Query Rewrite / Rerank 模型QUERY_REWRITE_MODEL(qwen-plus)、RERANK_MODEL(qwen3-rerank)
收紧 Rerank 请求预算RERANK_MAX_REQUEST_TOKENS(120000,Adapter 另留 10% 余量)
换 OCR / 视觉模型OCR_MODEL(qwen3.5-ocr)、VISION_MODEL(qwen3-vl-flash)
调整高级检索候选与融合RETRIEVAL_CANDIDATE_K(30)、RETRIEVAL_RRF_K(60)
默认关闭可选线上阶段RETRIEVAL_QUERY_REWRITERETRIEVAL_RERANK
调整 Small2BigRETRIEVAL_PARENT_EXPANSIONRETRIEVAL_PARENT_WINDOWRETRIEVAL_PARENT_MAX_TOKENS
调整 BM25BM25_K1(1.2)、BM25_B(0.75);改后显式重建 Sparse Collection
增大检索上下文CONTEXT_MAX_CHARS(12000)
增加任务重试次数INGESTION_JOB_MAX_ATTEMPTS(3)
加快/放慢 Worker 轮询WORKER_POLL_INTERVAL_SECONDS(1.0)
调整租约与心跳WORKER_LEASE_SECONDS(900)、WORKER_HEARTBEAT_SECONDS(30)
重试更快/更慢WORKER_RETRY_DELAY_SECONDS(10)
PDF 扫描页判定灵敏度PDF_NATIVE_TEXT_THRESHOLD(20)
Docling 推理设备DOCLING_DEVICE(cpu)、DOCLING_NUM_THREADS(4)
模型请求超时MODEL_TIMEOUT_SECONDS(60)
跨域白名单CORS_ORIGINS

3. 外部服务连接

环境变量默认值
DATABASE_URLpostgresql+asyncpg://ultimate_rag:ultimate_rag@localhost:5432/ultimate_rag
MINIO_ENDPOINT / MINIO_BUCKETlocalhost:9000 / documents
MILVUS_URI / MILVUS_COLLECTIONhttp://localhost:19530 / knowledge_chunks(Dense)
MILVUS_SPARSE_COLLECTIONknowledge_chunks_sparse_v3
CHUNK_SNAPSHOT_DIRdata/chunk_snapshots(Docker 内为 /app/data/chunk_snapshots
RERANK_URLhttps://dashscope.aliyuncs.com/compatible-api/v1/reranks
DASHSCOPE_BASE_URLhttps://dashscope.aliyuncs.com/compatible-mode/v1

4. 跨字段校验(违反即启动失败)

  • CHUNK_OVERLAP_TOKENS 必须小于 CHUNK_MAX_TOKENS
  • RETRIEVAL_PARENT_MAX_TOKENS 必须不小于 CHUNK_MAX_TOKENS
  • 全文总结使用 SUMMARY_* 独立预算,不受普通问答 TOP_KCONTEXT_MAX_CHARS 限制
  • 原始会话消息不会因 CHAT_RECENT_TOKEN_BUDGET 被删除,超出部分只生成可重建摘要
  • RERANK_MAX_REQUEST_TOKENS 必须位于 10000–120000
  • WORKER_HEARTBEAT_SECONDS 必须小于 WORKER_LEASE_SECONDS

5. 前端

环境变量说明
NEXT_PUBLIC_API_URL浏览器访问的 API 地址;留空则默认「当前主机名 + 8000 端口」

6. 最小 .env.example

dotenv
DASHSCOPE_BASE_URL=https://你的百炼工作空间地址/compatible-mode/v1
DASHSCOPE_API_KEY=你的API-Key

CHUNK_SNAPSHOT_DIR=data/chunk_snapshots

NEXT_PUBLIC_API_URL=

WARNING

.env 与真实密钥禁止提交到 Git。Chunk 快照包含文档明文,默认目录也已被 Git 忽略;生产部署 必须设置访问权限、容量监控,并覆盖默认凭据与 DOCLING_DEVICE

UltimateRAG · 从最小可用 RAG 演进为企业级知识平台