1.注册火山账号并开通 VikingDB 知识库服务

访问 火山引擎 并登录，进入VikingDB知识库

2.获取知识库 Resource_ID

登录 VikingDB 知识库，获取已创建的知识库 Resource_ID 。此参数将会在后续步骤用于与 Dify 平台的连接。

3.获取火山方舟 AK/SK

如何获取详情参考：https://www.volcengine.com/docs/84313/1254485

4.安装&配置 VikingDB 插件

安装插件

1. 登陆 Dify 官网，点击插件

开发插件官方文档：https://docs.dify.ai/zh/develop-plugin/getting-started/getting-started-dify-plugin

2. 点击安装插件，并选择 Marketplace

3. 搜索：Vikingdb Knowledge Base 并安装

Viking Knowledge Base 插件地址：https://marketplace.dify.ai/plugins/bytedance_vikingdb/vikingdb_knowledge_base

vikingdb_knowledge_base.difypkg

未知大小

插件配置

1. 点击 Knowledge Base 插件，并点击添加 API 端点

2. 自定义端点名称，填入第3步中获取的火山方舟平台的 AK/SK

3. 复制 POST 知识库外部连接地址

5. 关联外部知识 API

前往 Dify 平台中的 “知识库” 页，点击右上角的 “外部知识库 API”，轻点 “添加外部知识库 API”。
按照页面提示，依次填写以下内容：

• 知识库的名称，允许自定义名称，用于区分 Dify 平台内所连接的不同外部知识 API；
• API 接口地址，外部知识库的连接地址，可在第3步插件配置中找到。
  （注意：地址需要删除 "/retrieval" 。正确示例： https://***/vikingdb/knowledge_base）
• API Key（由于Viking Db 采用的 AK/SK 鉴权，未使用 API Key ，该部分可以自行任意填写）

6. 连接外部知识库

前往 “知识库” 页，点击添加知识库卡片下方的 “连接外部知识库” 跳转至参数配置页面。

填写以下参数：

• 知识库名称与描述
• 外部知识库 API

选择在第5步中关联的外部知识库 API

• 外部知识库 ID

填写在第2步中获取的火山 VikingDB 知识库 Resource_ID

• 调整召回设置

Top K：用户发起提问时，将请求外部知识 API 获取相关性较高的内容分段。该参数用于筛选与用户问题相似度较高的文本片段。默认值为 3，数值越高，召回存在相关性的文本分段也就越多。
Score 阈值：文本片段筛选的相似度阈值，只召回超过设置分数的文本片段，默认值为 0.5。数值越高说明对于文本与问题要求的相似度越高，预期被召回的文本数量也越少，结果也会相对而言更加精准。

设置完成后即可建立与外部知识库 API 的连接。

7. 测试外部知识库连接与召回

建立与外部知识库的连接后，开发者可以在 “召回测试” 中模拟可能的问题关键词，预览从火山 VikingDB 知识库召回的文本分段。

8. 应用案例：基于豆包模型 + VikingDB 知识库构建聊天 bot

在建立好外部知识库后，可以在 “工作室” 中使用豆包模型和上面建立的外部 VikingDB 知识库构建聊天机器人。

9. 常见问题

Q：为什么使用 CollectionSearchKnowledgeApi 而不是 CollectionServiceChatApi ？
A：因为 Dify 中外部知识库要支持 TopK、Score 等参数，知识服务已经把这些参数固化了，如果采用知识服务则无法和 Dify 联动

Q：为什么使用本地 Docker 安装 Dify 时添加外部知识库 API 报错？

A：Dify 的 cloud 环境和本地 docker 环境不同，与插件没有关系，即使使用非知识库插件也一样有问题，需要调整域名才能在本地 docker 环境使用。

• 默认配置下的解决方法
  1. 新版本：将域名改为 plugin_daemon:5002，端口以 docker 展示为准
  2. 旧版本：将域名改为 host.docker.internal

https://docs.dify.ai/zh/self-host/troubleshooting/docker-issues
https://github.com/langgenius/dify/blob/main/docker/docker-compose.yaml