问站内文档 可溯源
用中文直接提问,答案只从站内已翻译的官方文档里合成,并逐条给出引用。 找不到依据时它会说"不知道",而不是编一个听起来合理的答案。按 ⌘/Ctrl + I 可在任意页面唤起。
问题会同步到地址栏(/ask?q=…),可以直接分享给朋友或贴进 Issue。
未部署后端时本页也不会失效:会自动降级为浏览器内的站内检索,
给出最相关的页面与摘录(明确标注"未连接问答服务")。
每个回答都有依据
引用精确到页面 + 小节锚点,并标注译文所对照的上游 commit; 译文落后时会显式提示"结论可能已过时"。
不知道就说不知道
区分两种情况:文档里没有(建议换问法 / 去社区提问), 以及中文尚未翻译(直接给出官方英文原文,并可一键认领翻译)。
遵守社区术语
输出会过一遍与译文相同的术语门禁; 若模型输出违反了术语(例如把 Layer 译成"图层"),会退回检索合成版本。
报错诊断 →
把 Effect / TypeScript 报错整段贴进来:提取其中的 API 与错误码, 定位到相关中文小节(带引用)。未配置模型时只做定位,不臆测原因。
没有 API Key 也能用
默认是 extractive 模式:完全由检索结果组装,零成本、可离线; 部署方配置模型后才会切换到"模型润色",引用仍由检索层给出,模型无法伪造链接。
给 Agent 的用法
同一份知识也以机器可读形式开放,方便编码 Agent 直接使用:
| 入口 | 说明 |
|---|---|
POST /api/knowledge/ask | JSON 提问,返回 answer + citations(引用为空即拒答) |
GET /api/knowledge/ask?q=… | 同上,便于 curl/脚本使用 |
POST /api/knowledge/explain | 报错定位:提取报错里的 API/类型/错误码,返回相关小节与引用(见 报错诊断) |
GET /api/knowledge/stats | 语料规模、上游基线、是否启用模型 |
/llms.txt · /llms-full.txt | 站点导览 / 全量中文译文(Markdown,供 LLM 抓取) |
/docs/<slug>.md | 单页 Markdown 原文(带来源与基线),如 /docs/v4/getting-started/installation.md |
pnpm mcp(仓库内 MCP Server,stdio) |
以 MCP 工具形式暴露:search_docs / get_page / ask /
glossary / translation_status;离线自包含,配置方式见仓库
docs/agent-integration.md |
说明:限流按分钟计(默认 20 次/分钟);引用为空即视为"没有依据",调用方应据此展示拒答, 不要把它当成答案。