连接General知识库
目前业界有诸多知识库种类,但并没有一个统一的规范。对于用户自开发的知识库平台,AgentArts提供了第三方通用知识库接入规范。知识库的开发者参考此规范进行适配后,即能够作为第三方知识库接入AgentArts平台。
本文将介绍如何在AgentArts对接第三方General知识库。
费用说明
调用第三方知识库接口可能产生第三方平台的相关费用,请确保第三方服务账户状态正常。
步骤一:准备工作
- 用户拥有一个自开发的知识库系统(下文统称第三方知识库),并且已经按第三方通用知识库接入规范完成适配。知识库的服务接口发布到公网IP,并且可访问。
- 获取已搭建的第三方知识库连接信息:
- 获取服务器接口地址,即第三方知识库接口的发布地址IP,例如,http://123.456.789.12:8080。
- 获取鉴权信息密钥,该密钥是第三方知识库平台用户的认证信息,由第三方知识库提供。例如,123456789。
用户填入时不需要在密钥开始处拼接Bearer,AgentArts平台会负责拼接操作。
- 获取知识库详情页面链接,登录第三方知识库平台后,进入知识库详情页面,复制地址栏的URL,将其中的知识库ID替换为{{id}}。以下图RAGFLOW为例,其知识库详情页面链接为:http://123.456.789.12/dataset?id={{id}} 。
该连接信息用于接入第三方知识库后,AgentArts用户可根据此链接跳转第三方知识库平台页面。如果第三方知识库只有后端服务器,没有web或前端页面,可填写http://xxx.com作为占位。
图2 RAGFlow知识库详情页
步骤二:连接General外部知识库
- 登录AgentArts智能体开发平台。
- 在左侧导航栏中选择“开发中心 > 组件库”。
- 选择“知识库”页签,切换至“外部知识库连接”页面,单击“连接外部知识库”。
- 在弹出的对话框中,参见表1设置连接General外部知识库基本信息。
图3 连接外部知识库
表1 参数说明 参数
说明
示例
基本信息
选择类型
- General:通用外部知识库。
- RAGFlow:适用于已自建开源RAGFlow知识库系统的场景。
- KooSearch:适用于已自建开源KooSearch知识库系统的场景。
General
知识库连接名称
用于标识知识库。它是用户在创建知识库时必须填写的字段。
命名规则:
- 命名要求:仅支持以字母、数字、或中文开头。
- 支持字符:中英文、数字、中划线(-)、下划线(_)。
- 长度限制:1~50个字符。
第三方General
描述(可选)
用于简要说明知识库内容和用途。它提供了关于知识库的详细信息,帮助用户了解知识库的内容和使用场景。
命名规则:长度不大于255个字符。
外部知识库
图标
知识库图标。单击当前显示的知识库图标,在弹出的对话框中,选择要上传的新图标文件。
支持jpg、jpeg、png及gif格式,大小不大于200KB。
默认
连接信息
服务地址
能够访问检索接口及查询列表接口的地址,以https://或http://开头。
填入按获取服务器接口地址,即第三方知识库接口的发布地址...获取的信息
鉴权信息密钥
在http/https的请求header中添加的用户鉴权信息密钥。
说明:请确保鉴权密钥来源安全,不要在非安全环境下泄露。
关于密钥加密:鼠标移动至“鉴权信息密钥”右侧的
上,可参看密钥的加密方式。平台默认使用KMS加密 + 默认密钥方式对认证密钥进行加密存储,防止信息泄露。
- 加密机制:使用用户选择的密钥派生DEK进行加密,默认密钥为kms-agentarts/default。
- 费用说明:实例不收费,每月提供20,000次免费调用次数。解密时支持缓存,但敏感数据较多时可能超出免费次数。如需更换加密方式,具体请参考更换密钥的加密方式。
填入按获取鉴权信息密钥,该密钥是第三方知识库平台用户的...获取的信息
知识库详情页面链接
第三方General知识库详情页面的链接,可通过该页面直接访问General知识库的详情页面。
注意需要使用占位符{{id}}表示知识库ID,否则无法跳转到对应的知识库页面。
填入按获取知识库详情页面链接,登录第三方知识库平台后,...获取的信息
- 单击“测试连接”,弹出“测试成功”提示。
如果显示“第三方知识库连接失败,请检查连接地址和认证信息”,请检查General服务是否支持在公网使用API访问。
- 测试成功后,单击“确定”。
页面返回第三方知识库列表,可以在“外部知识库连接”页签中查看,仅接入第三方知识库,“状态”为“已停用”,创建第三方知识库后,“状态”为“已启用”。
步骤三:创建General第三方知识库
- 登录AgentArts智能体开发平台。
- 在左侧导航栏中选择“开发中心 > 组件库”。
- 选择“知识库”页签,在“知识库”页面,单击“创建知识库”。
- 在“选择创建类型”弹框中选择“接入第三方知识库”,单击“确定”。
- 平台知识库:适用于数据在AgentArts平台直接管理的场景,支持上传文档和FAQ。具体操作请参考创建知识库。
- 接入第三方知识库:适用于企业已有现成知识库(如RAGFlow),希望直接对接复用的场景。
- 在“接入第三方知识库”界面中,单击“请选择”下拉框,从中选择需要接入的第三方知识库,“选择接入知识库类型”取值示例:General。
- 在“知识库列表”中勾选添加所需知识库,单击
将其添加到右侧的“已选项”中。取值示例:一个通用第三方知识库名称。
图4 接入第三方知识库
- 单击“确定”,完成接入第三方知识库创建。创建完成后,可以在“接入第三方知识库 ”界面中查看接入的外部知识库。
创建完成的知识库,默认是启用状态。
常见问题
- 创建第三方知识库时为什么查不到知识库列表?
- 外部知识库连接中的已启用/已停用状态如何更改?
- 连接外部知识库失败如何排查?
- 接口返回401/403:检查APIKey是否正确。
- 链接超时:检查URL是否正确。