企业私有 RAG 怎么搭：自定义知识库全流程
本篇涵盖的知识重点
- 当前后台中该能力页面名为知识库管理，用于定制企业私有 RAG
- 知识库名称限制为 20 个英文字符或 10 个中文字符，描述为 30 个英文或 15 个中文字符
- 可见范围必选，默认企业所有成员，也可设置部分成员可见
- 文档支持 .md、.markdown、.docx、.pdf 及代码类文件，单个不超过 30MB
- 压缩包支持 .zip、.tar、.tgz、.tar.gz、.gz、.gzip，单个不超过 300MB
- Top K 建议设为 3 到 5，Score threshold 建议设为 0 到 0.5
- 文件处理状态分索引中、索引失败、已完成，前两者不可启用
- 适用于旗舰版、专享版、企业版，插件需升级到最新版本 3.1.20
搭建路径导览
知识库配置要点解读
作用知识库空间是内容的容器，可见范围决定了谁能检索到这些企业知识。
操作登录企业管理后台，进入知识库管理后创建知识库空间：输入名称、描述并选择可见范围，单击确定完成创建。
注意名称与描述的长度限制按中英文分别计算，超长会无法保存；可见范围一旦设为部分成员，未被覆盖的成员将检索不到该库内容。
- 名称：必填，限 20 个英文字符或 10 个中文字符
- 描述：选填，限 30 个英文字符或 15 个中文字符
- 可见范围：必选，默认是企业所有成员，也可设置部分成员可见，支持输入搜索选择和在下拉选项列表中直接选择
作用知识库的价值来自内容本身，选对文件和格式是检索质量的前提。
操作单击「添加数据」进入添加文件页面，支持文件拖拽和单击选择文件两种交互。以 GitHub 仓库为例，下载 ZIP 包后拖至页面并单击确定，系统会自动进行后端解压。没有问题后则上传成功，并返回到知识库的首页展示文件列表。
注意文件内容命名需遵循 utf-8、gbk 编码，暂不支持其他编码格式；遇到限制时系统会给出失败原因，上传后可返回知识库首页查看每个文件的索引状态。
- 文档：支持 .md、.markdown、.docx、.pdf 格式，以及 .py、.js、.css 等代码类型文档，每个文档不超过 30MB
- 压缩包：支持 .zip、.tar、.tgz、.tar.gz、.gz、.gzip 格式，每个压缩包不超过 300MB，适合直接吞下整个离线代码库
- 编码：文件内容命名要遵循 utf-8、gbk 编码，暂时不支持其它格式的编码
作用这两个参数直接决定召回内容的多少与精准度，是最影响回答质量的一组设置。
操作在知识库设置中调整 Top K 与 Score threshold 两项参数。
注意两个参数要配合调整：只调大 Top K 而阈值过严，仍会召回不足；建议先用建议区间跑一轮再微调。
- Top K：用于筛选与用户问题相似度最高的文本片段，建议设置区间为 3 到 5，较小的值返回更少但更精确的结果，较大的值返回更多的候选结果
- Score threshold：设置结果的相关性分数阈值，建议设置区间为 0 到 0.5，较低的值返回更多结果，较高的值只返回高度相关的结果
作用未索引完成的数据不可启用，提前开启会导致检索不到内容。
操作观察数据处理状态，确认索引完成后，返回知识库首页开启知识库。
注意出现索引失败时需检查文件是否为支持的格式与编码，以及是否超出单个文件大小限制，处理后重新上传。
- 索引中：正在处理，此时不可启用
- 索引失败：处理未通过，此时不可启用，需要排查格式、编码或大小后重新上传
- 已完成：索引完成的数据默认启用，回到首页打开知识库开关即可
作用知识库最终是给开发者用的，客户端能看到才算配置闭环。
操作当前用户处于企业组织且该企业组织下有自定义知识库时，@ Docs 知识库下会出现自定义知识库分类，可通过键盘或鼠标两种方式选中内置的知识库来使用。JetBrains 系列 IDE 同理。
注意若 @ Docs 下没有出现自定义分类，先确认账号是否处于正确的企业组织下，再确认插件版本。
- 适用版本：腾讯云代码助手旗舰版、专享版、企业版
- 插件版本：需要升级到最新版本 3.1.20
作用企业知识会持续变化，定期更新才能保持回答的时效性。
操作有两种修改方式：从知识库列表中选择对应知识库并单击编辑进入编辑模式；或进入对应知识库内，单击名称边上的按钮进行编辑，回车即完成保存。在知识库内页面同样支持添加数据和对知识库进行设置，可修改名称、描述并追加文件。
注意追加文件后需要重新等待索引完成，新内容才会被检索到；改名和删除文件同样会触发重新索引。
- 从知识库列表编辑：在知识库列表中选择对应知识库，单击编辑，即可进入知识库编辑模式
- 知识库内页面编辑：进入对应知识库内，单击名称边上的按钮进行编辑，回车即完成保存，同时支持添加数据或进行设置
格式与版本限制
- 文件内容命名要遵循 utf-8、gbk 编码，暂时不支持其它格式的编码，非这两种编码的文件会在上传环节失败。
- 上传过程中如果遇到限制，系统会给出失败原因，按提示处理后再重新上传即可。
- 以 GitHub 仓库为例，下载 ZIP 包后将其拖至当前页面并点击确定，系统将自动进行后端解压。
- 知识库支持的文件类型包括单文档、多文档、文档压缩包、离线代码库等，可按内容形态选择上传方式。
- 自定义知识库用于把企业文档和文件整合为上下文参考，使代码助手的回答更贴合企业特点。
规划与调参练习
```markdown
我要为企业搭建自定义知识库，请帮我规划内容与拆分方案。
必须依据的真实规则（不要增删限制）：
- 知识库名称限 20 个英文字符或 10 个中文字符，描述限 30 个英文字符或 15 个中文字符；
- 可见范围必选，默认企业所有成员，可设置部分成员可见；
- 文档支持 .md、.markdown、.docx、.pdf 以及 .py、.js、.css 等代码类型文档，每个文档不超过 30MB；
- 压缩包支持 .zip、.tar、.tgz、.tar.gz、.gz、.gzip，每个压缩包不超过 300MB；
- 文件内容命名需遵循 utf-8、gbk 编码，暂不支持其它编码格式；
- Top K 建议区间 3 到 5，Score threshold 建议区间 0 到 0.5；
- 处理状态分为索引中、索引失败、已完成，索引中和索引失败的数据不可启用。
我的场景：一家 150 人的技术公司，需要把内部技术规范、接口文档、新员工手册、历史故障复盘四类内容入库，其中接口文档含大量代码片段，新员工手册只对 HR 与新人可见。
请输出：1）一张拆分方案表（知识库名称 / 收录内容 / 可见范围 / 预估文件形态 / 命名与编码注意点）；2）一段针对「代码类内容」的上传建议（不超过 150 字）；3）一份索引失败时的处理流程（不超过 150 字）。
```得到一张拆分方案表、代码类内容上传建议和索引失败处理流程，所有格式、大小与编码限制表述准确。
```markdown
我要调试企业知识库的检索参数，请帮我设计调试方案。
已知事实（请严格按此设计）：
- Top K 用于筛选与用户问题相似度最高的文本片段，建议设置区间为 3 到 5；较小的值返回更少但更精确的结果，较大的值返回更多的候选结果；
- Score threshold 设置结果的相关性分数阈值，建议设置区间为 0 到 0.5；较低的值返回更多结果，较高的值只返回高度相关的结果；
- 等待索引完毕后才能开启知识库；索引中与索引失败的数据不可启用，索引完成的数据默认启用。
请输出：
1. 一张参数组合实验表，覆盖保守、均衡、宽松三档取值，每档写出 Top K 与 Score threshold 的推荐取值、预期召回表现、适用内容类型；
2. 一份测试用例设计，包含 5 个问题（其中 2 个是知识库明确没有答案的问题），并写明每档取值下的预期表现与判定标准；
3. 一段调参顺序建议（不超过 150 字），说明应该先固定哪个参数再调另一个。
```得到参数组合实验表、5 个测试用例和调参顺序建议，取值均落在建议区间内，且能说明跨档位的召回差异。
```markdown
我在企业管理后台创建并开启了自定义知识库，但有同事说在客户端里检索不到它。
已知事实（请严格按此组织，不要编造新的菜单或开关）：
- 适用版本为旗舰版、专享版、企业版，插件需要升级到最新版本 3.1.20；
- 当前用户如果处于企业组织，且企业组织下有自定义知识库，那么 @ Docs 知识库下就会出现自定义知识库分类；
- 可见范围默认是企业所有成员，也可设置部分成员可见；
- 数据处理状态分为索引中、索引失败、已完成；索引中和索引失败的数据不可启用，索引完成的数据默认启用；
- 需要在知识库首页开启知识库；
- 用户可通过键盘或鼠标两种方式选中内置的知识库。
请输出：1）一棵排查决策树（缩进列表），覆盖版本、组织归属、可见范围、索引状态、开启状态五个分支，每步写清判断什么、如何验证；2）一张「问题归属方」表，标明哪些问题由管理员处理、哪些需要同事自行处理；3）一段给同事的操作指引话术（不超过 150 字），说明如何确认插件版本与如何在 @ Docs 下选中自定义知识库。
```得到一棵覆盖五个分支的排查决策树、一张问题归属表和一段操作指引，所有依据均来自给定事实。
本文基于官方文档再创作，具体以官方文档站实际展示为准。