知识库
知识源让 Agent 用上你们自己的材料,比如设计文档、编码规范、API 文档。每一轮开始时,Yi Code 用你的消息去检索角色挂的知识源,把最相关的段落连同来源名称交给 Agent,让它引用。
知识源的类型
| 类型 | 说明 |
|---|---|
ragflow | RAGFlow 文档检索。在 Yi Code 里上传文档,由 RAGFlow 解析、建索引。 |
http | 你们自己的 HTTP 检索服务。 |
mcp | 你们自己的检索服务,以 Streamable HTTP 方式提供的 MCP 服务器。 |
每个组织的文档放在它自己的知识服务账号里,凭据也是独立的。云服务上,这个账号由我们为组织开好。
添加知识源
所有者和管理员在设置里打开「知识库」,添加知识源:
- 「知识源名称」。
- 「类型」:
ragflow、http或mcp。 - 「服务端点(须由部署管理员允许)」:主机必须在部署允许的连接主机列表里。云服务上必须是 HTTPS。
- 「凭据引用(可选)」:服务端密钥的名字,不是密钥本身(见凭据引用)。
ragflow类型还要填「RAGFlow Dataset ID」。
上传文档
ragflow 类型的知识源,点「上传并解析文档」。每个文档最大 10 MB。页面先显示「文档已提交解析」,之后变成「文档已就绪」。
组织有知识库配额,包括文档数、总大小和每月的 embedding token,页面上能看到用了多少。配额内的 embedding 不扣你的额度。
上传中途断了,页面会提示「上传状态待后台核对,请勿重复提交。」文档可能已经进了后端,我们核对之后才释放配额。同一个文件再传到同一个知识源,返回的是之前那次上传。
检索测试
「检索测试」对一个知识源跑一次检索,在依赖它之前,先看看 Agent 针对某个问题会拿到什么。
在轮次里使用
知识源要挂到角色上才会用到。管理员发布一个新版本的 ask 或 code 角色,在「知识源」里勾上它(见修改角色)。之后这个模式下每个新的轮次会:
- 用你的消息检索每个挂上的知识源,每个取前五段。
- 把这些段落连同来源名称加进 Agent 的指令,要求它引用。
- 在这一轮的
report.md里列出用到的知识源。
检索到的内容只当作任务数据,不会被当成给 Agent 的指令。已经在跑的轮次继续用它开始时的知识源。
接入自己的检索服务
http 类型的知识源会收到一个 POST,请求体是:
json
{ "query": "the user's message", "top_k": 5, "filters": {} }返回:
json
{ "items": [ { "text": "passage", "source": "where it came from", "metadata": {} } ] }mcp 类型的知识源通过它的 search 工具调用,参数是 query 和 top_k。工具以文本形式返回同样的 items JSON,或者直接返回纯文本,纯文本会当作一段。
配了凭据引用的话,会以 Authorization: Bearer … 发送。Yi Code 从控制面调用这些服务,沙箱接触不到凭据。