字段手册:管理台¶
本文档适用于文档库管理台的部署与运维人员。管理台服务位于独立代码仓库 construciton-rag-offline-processing;API 调用方及问答主站的模型选择列表无需参考本章内容。
默认配置目录仍为 /etc/construction-rag/config/,或由环境变量 CG_RAG_ADMIN_CONFIG 指定。配置路径指针包含 CG_RAG_ADMIN_CONFIG 与 CG_RAG_ADMIN_SECRETS_CONFIG。配置项生效规则同样遵循「进程环境覆盖 YAML」。
管理台的 models.yaml 并非问答模型目录,切勿使用 Question API 的 catalog 覆盖该文件。
paths.yaml → admin¶
| YAML 键 | 环境变量 | 含义 |
|---|---|---|
source_root |
SOURCE_ROOT |
原始工程数据根目录 |
release_root |
CG_RAG_ADMIN_RELEASE_ROOT |
增量 release 目录 |
state_root |
CG_RAG_ADMIN_STATE_ROOT |
管理台状态目录(须位于项目目录内) |
upload_root |
CG_RAG_ADMIN_UPLOAD_ROOT |
上传目录(须位于项目目录内) |
active_env_json |
CG_RAG_ADMIN_ACTIVE_ENV_JSON |
历史检索 env.json 路径;仅在未配置 active_config 时生效 |
active_config |
CG_RAG_ADMIN_ACTIVE_CONFIG |
CG 服务当前读取的检索 YAML。启用检索库时写入该文件。生产环境应指向 cg-retrieval.yaml,切勿指向问答 models.yaml |
active_release_override |
CG_RAG_ADMIN_ACTIVE_RELEASE_ID |
强制指定当前 release id |
usual_catalog_xlsx |
CG_RAG_ADMIN_USUAL_CATALOG_XLSX |
常用规范目录表 |
law_catalog_xlsx |
CG_RAG_ADMIN_LAW_CATALOG_XLSX |
法律法规目录表 |
feedback_database_path |
CG_RAG_ADMIN_FEEDBACK_DATABASE_PATH |
反馈数据库路径 |
feedback_attachment_database_path |
CG_RAG_ADMIN_FEEDBACK_ATTACHMENT_DATABASE_PATH |
附件数据库路径 |
feedback_attachment_root |
CG_RAG_ADMIN_FEEDBACK_ATTACHMENT_ROOT |
附件根目录 |
llm_request_cache_path |
LLM_REQUEST_CACHE_PATH |
管理台 LLM 缓存路径 |
llm_request_cache_max_entries |
LLM_REQUEST_CACHE_MAX_ENTRIES |
缓存最大条目数 |
services.yaml¶
| YAML 路径 | 环境变量 | 含义 |
|---|---|---|
admin.env |
CG_RAG_ADMIN_ENV |
运行环境标识,如 production |
admin.retriever_url |
CG_RAG_ADMIN_RETRIEVER_URL |
管理台调用 CG_RAG 服务的 URL,如 http://127.0.0.1:8864/cg-rag |
admin.retriever_service |
CG_RAG_ADMIN_RETRIEVER_SERVICE |
systemd 服务单元名 |
admin.auto_catalog |
CG_RAG_ADMIN_AUTO_CATALOG |
设为 "1" 启用自动目录 |
admin.api_proxy_base |
CG_RAG_ADMIN_API_PROXY_BASE |
管理台前端反向代理基础路径 |
admin.base_path |
CG_RAG_ADMIN_BASE_PATH |
基础访问路径,通常为 /admin |
admin.api.host |
CG_RAG_ADMIN_HOST |
API 监听地址 |
admin.api.port |
CG_RAG_ADMIN_PORT |
API 端口,默认 8865 |
admin.web.host |
CG_RAG_ADMIN_WEB_HOST |
前端服务监听地址 |
admin.web.port |
CG_RAG_ADMIN_WEB_PORT |
前端服务端口,默认 8866 |
admin.web.node_bin |
CG_RAG_ADMIN_NODE_BIN |
Node.js 可执行文件路径 |
admin.web.python_bin |
PYTHON_BIN |
Python 可执行文件路径 |
auth.enabled |
CG_RAG_AUTH_ENABLED |
是否强制邮箱验证登录 |
auth.allowed_emails |
CG_RAG_AUTH_ALLOWED_EMAILS |
允许登录的邮箱列表;配置为环境变量时使用逗号分隔 |
auth.mail_service |
CG_RAG_AUTH_MAIL_SERVICE |
邮件服务类型,可选 smtp 或 microsoft_graph |
auth.smtp_host |
CG_RAG_AUTH_SMTP_HOST |
SMTP 服务器主机地址 |
auth.smtp_port |
CG_RAG_AUTH_SMTP_PORT |
SMTP 端口,为 465(ssl)或 587(starttls) |
auth.smtp_encryption |
CG_RAG_AUTH_SMTP_ENCRYPTION |
SMTP 加密协议,仅支持 ssl 或 starttls |
auth.smtp_username |
CG_RAG_AUTH_SMTP_USERNAME |
SMTP 发信账号 |
auth.smtp_from |
CG_RAG_AUTH_SMTP_FROM |
发件人 From 标头 |
auth.public_origin |
CG_RAG_AUTH_PUBLIC_ORIGIN |
公网 Origin,须与浏览器访问地址及端口完全一致 |
auth.additional_origins |
CG_RAG_AUTH_ADDITIONAL_ORIGINS |
额外允许的 Origin 列表 |
auth.graph_client_id |
CG_RAG_AUTH_GRAPH_CLIENT_ID |
Microsoft Graph 应用程序 ID |
auth.graph_account |
CG_RAG_AUTH_GRAPH_ACCOUNT |
Microsoft Graph 账号 |
auth.graph_authority |
CG_RAG_AUTH_GRAPH_AUTHORITY |
Microsoft Graph 认证机构 URL,如 https://login.microsoftonline.com/consumers |
auth.graph_token_cache_path |
CG_RAG_AUTH_GRAPH_TOKEN_CACHE |
MSAL 缓存文件路径 |
管理台 models.yaml¶
| YAML 路径 | 环境变量 | 含义 |
|---|---|---|
admin_llm.base_url |
LLM_BASE_URL |
条文抽取等流水线 LLM 服务地址 |
admin_llm.model |
LLM_MODEL |
流水线模型名称 |
admin_llm.tokenizer_model |
LLM_TOKENIZER_MODEL |
分词器模型名称(可选) |
embedding_api.endpoint |
EMBEDDING_API_ENDPOINT |
管理台向量接口地址 |
embedding_api.model |
EMBEDDING_API_MODEL |
向量模型名称 |
embedding_api.dimension |
EMBEDDING_API_DIMENSION |
向量维度 |
embedding_api.model_2560 / model_1024 |
对应 EMBEDDING_API_MODEL_* |
多维度模型别名 |
secrets.yaml(0600)¶
| YAML 路径 | 环境变量 |
|---|---|
admin.llm_api_key |
LLM_API_KEY |
auth.smtp_password |
CG_RAG_AUTH_SMTP_PASSWORD |
auth.otp_hmac_secret |
CG_RAG_AUTH_OTP_HMAC_SECRET |
pipeline.llm_api_key |
LLM_API_KEY(流水线,setdefault) |
pipeline.embedding_api_key |
EMBEDDING_API_KEY |
启用检索库时,管理台会将 usual / usual_plus_law / full 的 corpus_root、index_root、bm25_index_root、retrieval_method 及 index_file_name 写回 CG_RAG_ADMIN_ACTIVE_CONFIG 指向的 YAML 文件,并重启 CG 服务。由于 CG 服务已不再读取 env.json,切勿仅修改该文件。
仓库内的配置说明文档参见 construciton-rag-offline-processing/docs/admin-api-configuration.md。