文档中心

联网问答Agent

资源库

知识库操作指南

概述

本文档介绍联网问答智能体API知识库接入时的接入流程、并提供的查询知识库接口应当遵守的规范。当智能体需要查询知识库时，需要按本文描述实现相应的接口方能正常查询。

接入流程

接入联网问答智能体知识库功能时，客户侧需要按照如下步骤完成：

依据知识库接口说明，实现知识库接口

在【联网问答Agent控制台】的【知识库配置】页面完成配置，包括【路径导入】【检索配置】

在上述页面中【请求路径调试】点击“测试”以发送测试数据，测试接口连通性，确认接口可用后完成保存

保存后再次点击【知识库配置】可获取鉴权密钥，支持请求校验（非必要）

完成知识库配置后，在【联网问答Agent控制台】的【联网问答Agent】中，进入智能体配置页进行知识库绑定，完成后开始使用

知识库接口说明

请求方式

HTTPS

Method：POST

Content-Type：application/json

签名校验

客户侧通过检验 signature 对请求进行校验（下面有校验方式），以确认请求来自内容定制系统。

签名参数

参数	描述
timestamp	unix时间戳，单位：秒。为保证安全，与当前时间戳绝对值不要超过3600s。从请求头中获取，键为：X-Content-Timestamp
nonce	请求随机串。随机串长度为6-32位数字和字母的组合，大小写敏感。从请求头中获取，键为：X-Content-Nonce
signature	签名字符串。从请求头中获取，键为：X-Content-Signature
payload	业务数据。请求体body字节流。
secret_key	鉴权密钥。在【联网问答Agent控制台】的【智能体配置】页面中点击【知识库配置】查看。

签名算法

Hmac_SHA256算法

签名步骤

将 timestamp、nonce 和 payload 依次进行拼接；

使用 secret_key 对上述拼接的字符串进行 hmac sha256 加密，然后转成十六进制字符串；

得到加密后的字符串可与 signature 对比，标识该请求来源于内容定制的内容事件推送。

签名示例

检验signature的Java示例代码：

检验signature的Go示例代码：

请求参数

请求方指“火山引擎-联网智能体”。

Header

KEY	VALUE/说明
method	POST
Content-Type	application/json
X-Content-Timestamp	unix时间戳（单位：秒）
X-Content-Nonce	随机串（6-32位数字、字母组成）
X-Content-Signature	回调签名（生成逻辑见上文）

Body

字段名	字段类型	说明
FirstLevelId	string	知识库一级路径，与客户配置一致
SecondLevelId	string	知识库二级路径，与客户配置一致
Query	string	查询内容
Limit	number	查询条数

响应参数

响应方指“客户侧”。

字段名	字段类型	说明
Ret	number	响应状态码。0-成功；非0-失败，并在msg中补充说明。
Msg	string	响应信息。例如：成功时提供"success"；失败时提供失败相关信息。
Result	Array<Result>	查询结果数组

Result

字段名	字段类型	说明
Id	string	内容id，不可重复，重复会导致内容丢失
Title	string	内容标题
Summary	string	内容摘要，用于大模型总结，建议提供
PublishTime	number	发布时间，秒级时间戳
Url	string	跳转链接
CoverImage	CoverImage	封面图
KnowledgeContent	string	内容信息，透传字段

CoverImage

字段名	字段类型	说明
Height	number	图片高度
Width	number	图片宽度
Url	string	图片链接

请求示例

注意：这里的Body应该作为一个字符串接收。不要利用引入的SDK或者框架的能力作为一个JSONObject接收，再转为字符串，这样可能导致Body的字符串内容不一致，从而导致签名计算出来的最终结果不一致。

响应示例

客户侧服务端返回给火山引擎侧的响应数据

最近更新时间：2025.07.15 11:37:57

这个页面对您有帮助吗？

有用

无用