• 生成鉴权信息
• 初始化会话
• 对话接口
• 关闭会话
• 获取知识分类列表
• 获取知识文档列表
• 上传知识文档
• 修改知识文档
• 删除知识文档

生成鉴权信息

初次登录Service Agent系统： 进入系统设置-接口设置页面，点击生成，即可创建接口调用所需要的APPID和APPTOKEN。

创建完成 获取到对应的APPID和APPTOKEN。

• 请求头参数：

参数名	类型	是否必填	描述	示例
Content-Type	string	是	application/json	application/json
accept	string	是	application/json, text/plain, */*	application/json, text/plain, */*

• 请求头示例

{
    "accept": "application/json, text/plain, */*",
    "Content-Type": "application/json"
}

• 请求体参数

参数名	类型	是否必填	描述	示例
appid	string	是	应用ID，由32个英文字母和阿拉伯数字组成的唯一标识符，可登录Service Agent系统，进入系统设置-接口设置页面查询到当前企业的appid	I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX
apptoken	string	是	应用密钥，可登录Service Agent系统，进入系统设置-接口设置页面查询到当前企业的apptoken	YVRNZD0X9BT6VEYX
timestamp	string	是	当前系统时间戳，格式为yyyyMMddHHmmss，如20180416142030	20250321140659
auth_token	string	是	令牌，由appid、英文冒号、timestamp 字符串拼接之后，使用Base64编码得出 auth_token = Base64({appid}:{ timestamp})	STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTU s6MjAyNTAzMjExNDA2NTk=
sig	string	是	undefined签名，由appid、apptoken、timestamp 字符串拼接之后，使用32位MD5加密并转为大写得出，sig = MD5({appid}{apptoken}{timestamp})	00addfa69e29757a20939cca7e597c0X

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
}

• 注意事项：
  1、sig有效期：sig有效期为24小时，请在过期前重新按照规则生成。
  2、安全性：请确保在安全的网络环境下使用该接口，并保护好appid和apptoken。
  3、使用方式：所有API接口的调用都必须进行接口鉴权，每个接口都需要在请求体中携带appid、apptoken、timestamp、auth_token、sig这五个参数，请求头的格式保持一致
  

初始化会话

• 接口地址：POST https://ai-agent-sdk.7moor.com/agent/v1/api/init_session
• 请求体参数

参数名	类型	是否必填	描述	示例
sid	string	是	会话sid，会话的唯一标识	5cbfb31a-2e6cec3d-1abeaa17-cb3c626b
session_source	string	是	会话来源	x_bot aicall elitecrm other
agent_id	string	是	当前会话需要调用的agent id	956ecea660ef4f52bb392e0a80497fa0
system_args	object	否	扩展参数	字典格式 ,例如 {"is_vip":"1"}
query_tags	object	否	标签参数	字典格式 ,例如 {"changjing":"1"}
msg_receive_url	string	是	回调地址	消息通知回调地址
visitor_id	string	否	访客id
visitor_name	string	否	访客名字

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
    "sid":"5cbfb31a-2e6cec3d-1abeaa17-cb3c626b",
    "session_source":"test",
    "agent_id":"956ecea660ef4f52bb392e0a80497fa0",
    "system_args": {},
    "query_tags": {},
    "msg_receive_url":"http://chat-task-based-addon/ac/callback",
    "visitor_id":"",
    "visitor_name":""
}

• 响应示例

{
    "agent_id":"956ecea660ef4f52bb392e0a80497fa0",
    "agent_info": {},
    "agent_name":"testFu",
    "msg_receive_url":"http://chat-task-based-addon/ac/callback",
    "session_source":"test",
    "sid":"5cbfb31a-2e6cec3d-1abeaa17-cb3c626b",
    "source":0,
    "start_time":"2024-06-18 09:44:37",
    "system_args": {},
    "visitor_id":"30bdc59f6a5f4d8c9299137076277fa1",
    "visitor_name":""
}

对话接口

• 接口地址：POST https://ai-agent-sdk.7moor.com/agent/v1/api/query_with_history
• 请求体参数

参数名	类型	是否必填	描述	示例
sid	string	是	会话sid，当前会话的唯一标识，跟初始化会话接口保持一致	5cbfb31a-2e6cec3d-1abeaa17-cb3c626b
qid	string	否	请求qid，当前请求的唯一标识，如果不传，后端会新建uuid作为标识
agent_id	string	是	当前会话需要调用的agent id	956ecea660ef4f52bb392e0a80497fa0
messages	array[msg]	是	消息列表，仅需传入最后一条user的消息即可	[{"type":"user","text":"你好"}]
user_args	map	否	用户的自定义参数列表，k-v键值对	{"phone":"11111111111"}
stream	bool	否	是否流式请求，默认为false	false
push_msg	bool	否	应答是否强制使用主动推送接口，如果为true，则stream参数失效	false

请求messages中的msg参数

参数名	类型	是否必填	描述	示例
type	string	是	消息类型user	user
text	string	是	消息内容	你好
content_type	string	否	image 图片消息，默认为空，表示文本	image
origin_message	string	否	图片消息场景下，图片资源的原始链接	https://www.domain.com/img.png

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
    "sid":"5cbfb31a-2e6cec3d-1abeaa17-cb3c626b",
    "agent_id":"956ecea660ef4f52bb392e0a80497fa0",
    "messages": [{
      "type":"user",
      "text":"你好"
      }],
    "user_args": {},
    "stream": false
}

• 响应参数

参数名	类型	约束	描述
code	int	必返	响应结果
message	string	必返	响应描述
data	string	必返	llm agent返回的响应结果，非流式请求时agent返回的回复内容
log	map	可选	回复的扩展数据，标识回复类型以及额外数据。 key说明如下： action 技能组/挂机/直接回复等标识，和cate定义一致。5 人工服务， 6 按键拨号， 7 挂断 skill_num 技能组数据 strategy_type 回复策略类型 keyboard_scene 按键数据 biz_msg_type 业务消息类型 1 追粉话术
msg_time	string	必返	收到请求的时间
response_time	string	必返	应答时间
debug	debug_info	必返	调试信息数据
qid	string	必返	请求的标识
answer_res_list	array	可选	消息携带的附件列表，示例：[{"type":"doc","name":"abc.doc","url":"https://aiagent-dev.oss.com/agentid/date/abc.doc"}]
is_end	bool	可选	流式请求时，结果是否完整返回

响应debug中的debug_info参数说明

参数名	类型	约束	描述
add_info	add_info	可选	大模型计费信息，调用大模型时追加
tool_log	log	必返	角色筛选日志日志
scene_log	log	可选	场景筛选日志，经过分类角色时追加
query_log	log	可选	回答策略，经过ll回复时追加
guidance_log	guidance_info	可选	引导信息，仅主动推送时返回
flow_log	flow_log	可选	流程日志，经过流程场景时追加
frs_log	log	可选	追粉话术日志，仅主动推送时返回

debug_info中的add_info参数说明

参数名	类型	约束	描述
billing	float	必返	计费金额
completion_tokens	int	必返	当前消耗的tokens
model	string	必返	模型名称
prompt_tokens	int	必返	prompt token
total_tokens	int	必返	上下文总消耗的tokens
reference	object	可选	引用网站列表，格式：{"idx": 1, "site_name": "天气网"}

debug_info中的log参数说明

参数名	类型	约束	描述
ai_slots	map	必返	上下文中的词槽信息
content	string	可选	人设信息
info	string	必返	命中/兜底等描述
json_parser	string	必返	1、直接返回模型应答，2、json解析模型应答
option	array[str]	可选	角色/场景中的分类信息
prompt	string	可选	传递给大模型的提示词
response	string	可选	模型返回的应答信息
tool_llm	string	可选	模型名称

debug_info中的guidance_info参数说明

参数名	类型	约束	描述
guidance_name	string	必返	静默拉回/下一环节拉回/拉回主动引导
current_guidance_index	int	必返	当前引导话术顺序
name	string	必返	引导节点名称
response	string	必返	返回的应答

debug_info中的flow_log参数说明

参数名	类型	约束	描述
path_link	string	必返	流程经过的节点名称
path	array[flow_info]	必返	当前引导话术顺序

debug_info中的flow_log中的flow_info参数说明

参数名	类型	约束	描述
type	string	必返	flow节点类型
name	array	必返	flow节点名称
debug	object	必返	flow节点执行结果，根据类型不一样，结构不一样

debug_info中的flow_log中的flow_info中的debug参数说明

参数名	类型	约束	描述
variable	object	必返	抽取到的实体数据，key:var_name,val:抽取到的值
func	string	必返	json字符串，{"name":"func alias", "response":responsebody}
condition	object	必返	条件判断结果,{"key":"key","name":"cond_name","error":"未匹配到条件"}
llm	object	必返	模型执行结果，{"content":"人设信息","info":"add_info","response":"模型返回结果","tool_llm":"模型名称"}

• 流式响应示例

参数名	类型	约束	描述
is_end	bool	必返	是否结束，流式是否结束 true 结束 false 未结束
reply	string	必返	流式输出内容

其他参数解释流式和非流式相同

{
    "is_end": false,
    "reply": "您可以在【组织架构】中，点击部门右侧的按钮，然后选择【删除部门】即可。如果当前部门还有人员，系统会提示先删除部门中的人员，然后再删除部门。\np><img src=\"https://ai-agent-dev.oss-cn-beijing.aliyuncs.com/dfdd748191754122b76c27f06c11a17a.jpg\" alt=\"\" /></p>",
    "info": null,
    "log": {
      "action": "8",
      "strategy_type": "answer"
    },
    "debug": null,
    "msg_time": null,
    "response_time": null,
    "qid": "7d1335922844490bb9786ca8a06e1068",
    "answer_res_list": null
  }
  {
    "is_end": true,
    "reply": "您可以在【组织架构】中，点击部门右侧的按钮，然后选择【删除部门】即可。如果当前部门还有人员，系统会提示先删除部门中的人员，然后再删除部门。\n<p><img src=\"https://ai-agent-dev.oss-cn-beijing.aliyuncs.com/dfdd748191754122b76c27f06c11a17a.jpg\" alt=\"\" /></p>",
    "info": null,
    "log": {
      "action": "8",
      "strategy_type": "answer"
    },
    "debug": [],
    "msg_time": "2024-06-18 09:51:15",
    "response_time": "2024-06-18 09:51:20",
    "qid": "7d1335922844490bb9786ca8a06e1068",
    "answer_res_list": null
}

非流式响应示例

{
    "answer_res_list":null,
    "code":200,
    "data":"您可以在【组织架构】中，点击部门右侧的按钮，然后选择【删除部门】即可。如果当前部门还有人员，系统会提示先删除部门中的人员，然后再删除部门。\n<img src='https://ai-agent-dev.oss-cn-beijing.aliyuncs.com/dfdd748191754122b76c27f06c11a17a.jpg'alt='删除部门步骤' />\n<p><img src=\"https://ai-agent-dev.oss-cn-beijing.aliyuncs.com/dfdd748191754122b76c27f06c11a17a.jpg\" alt=\"\" /></p>",
    "debug": [],
    "log": {
      "action":"8",
      "strategy_type":"answer"
    },
    "message":"success",
    "msg_time":"2024-06-18 09:55:19",
    "qid":"9ab4c47e74284ff8a4be0998aabbfc71",
    "response_time":"2024-06-18 09:55:25"
}

关闭会话

• 接口地址：POST https://ai-agent-sdk.7moor.com/agent/v1/api/close_session
• 请求体参数

参数名	类型	是否必填	描述	示例
sid	string	是	会话sid，当前会话的唯一标识，跟初始化会话接口保持一致	5cbfb31a-2e6cec3d-1abeaa17-cb3c626b

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
    "sid":"5cbfb31a-2e6cec3d-1abeaa17-cb3c626b",
}

• 响应示例

{
    "code": 200,
    "message": "success"
}

获取知识分类列表

• 接口地址：POST https://ai-agent-sdk.7moor.com/agent/v1/api/query_kb
• 请求体参数

参数名	类型	是否必填	描述
page	int	否	当前页
per_page	int	否	当前页数量
title	string	否	知识分类名称
agent_id	string	是	当前会话需要调用的agent id

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
    "agent_id": "678bfc6b8d3048628041ec01c8678cc8",
    "title": ""
}

• 响应体参数

参数名	类型	约束	描述
code	int	否	响应状态码
message	string	必返	响应信息
success	bool	必返	请求是否成功
time	string	必返	响应时间
data	object	必返	数据对象
data.count	int	必返	记录总数
data.list	array	必返	记录列表
data.page	int	必返	当前页
data.pages	int	必返	总页数

data中的list参数说明

参数名	类型	约束	描述
bytes	int	必返	字节数
characters	int	必返	字符数
count	int	必返	计数
create_datetime	string	必返	创建时间
default	int	必返	是否默认
description	string	必返	描述
id	string	必返	唯一标识符
space_id	string	必返	空间标识符
title	string	必返	标题
type	int	必返	类型
update_datetime	string	必返	更新时间

• 响应示例

{
   "code": 200,
   "data": {
   "count": 1,
   "list": [
     {
      "bytes": 0,
      "characters": 0,
      "count": 0,
      "create_datetime": "2024-11-15T18:24:10",
      "default": 1,
      "description": "默认",
      "id": "2e45380938e14b61b6bda80f5bd460a3",
      "space_id": "ad62405276fb4a398c320d9dbe77bfef",
      "title": "默认",
      "type": 0,
      "update_datetime": "2024-11-15T18:24:10"
     }
    ],
    "page": 1,
    "pages": 1
   },
   "message": "success",
   "success": true,
   "time": "2025-03-24 17:17:07"
}

获取知识文档列表

• 接口地址：POST https://ai-agent-sdk.7moor.com/agent/v1/api/query_files
• 请求体参数

参数名	类型	是否必填	描述
page	int	否	当前页
per_page	int	否	当前页数量
file_name	string	否	知识文档名称
agent_id	string	是	当前会话需要调用的agent id
kb_id	string	是	知识分类ID

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
    "agent_id": "678bfc6b8d3048628041ec01c8678cc8",
    "kb_id": "2e45380938e14b61b6bda80f5bd460a3"
}

• 响应体参数

参数名	类型	是否必填	描述
message	string	必返	响应信息
success	bool	必返	请求是否成功
time	string	必返	响应时间
data	object	必返	数据对象
data.count	int	必返	记录总数
data.list	array	必返	记录列表
data.page	int	必返	当前页
data.pages	int	必返	总页数
list.bytes	int	必返	文件字节数
list.characters	int	必返	文件字符数
list.chunk_size	int	必返	分块大小
list.create_datetime	string	必返	创建时间
list.document_id	string	必返	文档ID
list.end_date	string	可选	结束日期
list.error_text	string	可选	错误文本
list.file_download_url	string	必返	文件下载链接
list.file_name	string	必返	文件名
list.file_suffix	string	必返	文件后缀
list.generated_qa	int	必返	生成的问答对数
list.id	string	必返	唯一标识符
list.is_permanent	bool	必返	是否永久
list.kb_id	string	必返	知识库ID
list.md_mode	int	必返	Markdown模式
list.merge_max_len	int	必返	合并最大长度
list.overlap	int	必返	重叠长度
list.parse_process	string	必返	解析过程
list.shelve_status	int	必返	搁置状态
list.single_max_len	int	必返	单个最大长度
list.space_id	string	必返	空间ID
list.split_depth	int	必返	分割深度
list.start_date	string	可选	开始日期
list.status	int	必返	状态
list.tag_description	string	可选	标签描述
list.tags	array	可选	标签列表
list.update_datetime	string	可选	更新时间

• 响应示例

{
  "code": 200,
  "data": {
    "count": 1,
    "list": [
      {
        "bytes": 20672,
        "characters": 2869,
        "chunk_size": 512,
        "create_datetime": "2025-03-24T17:37:39",
        "document_id": "191e399fc20a4777bf184ea138416595",
        "end_date": null,
        "error_text": null,
        "file_download_url": "https://ai-agent-dev.oss-cn-beijing.aliyuncs.com/docs/DOS命令大全.md",
        "file_name": "DOS命令大全.md",
        "file_suffix": "md",
        "generated_qa": 0,
        "id": "7880a42e4e7a4a0b9f75b03626d910c1",
        "is_permanent": true,
        "kb_id": "2e45380938e14b61b6bda80f5bd460a3",
        "md_mode": 1,
        "merge_max_len": 512,
        "overlap": 50,
        "parse_process": "解析成功",
        "shelve_status": 1,
        "single_max_len": 1024,
        "space_id": "ad62405276fb4a398c320d9dbe77bfef",
        "split_depth": -1,
        "start_date": null,
        "status": 1,
        "tag_description": null,
        "tags": [],
        "update_datetime": "2025-03-24T17:38:00"
      }
    ],
    "page": 1,
    "pages": 1
  },
  "message": "success",
  "success": true,
  "time": "2025-03-24 17:50:31"
}

上传知识文档

• 接口地址：POST https://ai-agent-sdk.7moor.com/agent/v1/api/save_files
• 请求体参数

参数	类型	是否必填	描述	示例
agent_id	string	是	当前会话需要调用的agent id
kb_id	string	否	知识库 ID	1
chunk_size	int	否	文档切片大小	1024
bytes	int	是	文件字节大小	0
overlap	int	否	切片重叠大小	128
source_url	string	否	文件的源 URL（如果上传文件时为空，则使用上传文件）	https://xxx.com/yyy.txt
filename	string	是	文件名称	test.txt
generated_qa	int	否	是否生成问答对（1 表示生成，0 表示不生成）	0
file	file	是	上传的文件	file.txt
is_website	bool	否	是否为抽取网站内容（若为网站，则通过 URL 提取内容）	false
split_depth	int	否	MD 文档分割层级，-1 表示自动判断	-1
md_mode	int	否	MD 文件的标题和子标题组合模式： 0：hierarchy 继承模式 1：simple 独立组块	0
single_max_len	int	否	大段落字数限制	1024
merge_max_len	int	否	大段落合并字数限制	512
file_conversion	int	否	文件转换选项： 0：不转换 1：将 PDF/DOC/TXT 转为 MD 2：将 FAQ（Excel）转为 MD	0
md_conversion_strategy	int	否	MD 转换时关键符号替换策略： 0 表示不替换 1 表示替换	0
tags	string	否	JSON 格式的标签列表，每个标签需包含： tag_key (string) tag_value (string) description (可选)	[{"tag_key":"测试","tag_value":"测试成功"},{"tag_key":"部门","tag_value":"市场部"}]
tag_description	string	否	文档标签备注	这是一个备注
shelf_status	int	否	自定义文件上下架状态： 0：下架 1：上架（默认 0）	1
start_date	string	否	文件自定义生效起始时间（格式：YYYY-MM-DD HH:mm:ss）	'2025-01-07 08:04:04' （以单个空格分割）
end_date	string	否	文件自定义生效结束时间（格式：YYYY-MM-DD HH:mm:ss）	'2025-01-07 08:05:04' （以单个空格分割）

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
    "agent_id": "678bfc6b8d3048628041ec01c8678cc8",
    "shelf_status": "1",
    "bytes": 20672,
    "filename": "DOS命令大全.docx",
    "kb_id": "2e45380938e14b61b6bda80f5bd460a3"
}

• 响应体参数

参数	类型	约束	描述
code	int	必返	响应状态码
message	string	必返	响应信息
success	bool	必返	请求是否成功
time	string	必返	响应时间
data	object	必返	数据对象
data.bytes	int	必返	文件字节数
data.characters	int	必返	文件字符数
data.chunk_size	int	必返	分块大小
data.create_datetime	string	必返	创建时间
data.document_id	string	必返	文档ID
data.end_date	string	可选	结束日期
data.error_text	string	可选	错误文本
data.file_download_url	string	必返	文件下载链接
data.file_name	string	必返	文件名
data.file_suffix	string	必返	文件后缀
data.generated_qa	int	必返	生成的问答对数
data.id	string	必返	唯一标识符
data.is_permanent	bool	必返	是否永久
data.kb_id	string	必返	知识库ID
data.md_mode	int	必返	Markdown模式
data.merge_max_len	int	必返	合并最大长度
data.overlap	int	必返	重叠长度
data.shelve_status	int	必返	搁置状态
data.single_max_len	int	可选	单个最大长度
data.space_id	string	必返	空间ID
data.split_depth	int	必返	分割深度
data.start_date	string	可选	开始日期
data.status	int	必返	状态
data.tag_description	string	可选	标签描述
data.tags	array	可选	标签列表
data.update_datetime	string	可选	更新时间

• 响应示例

{
  "code": 200,
  "data": {
    "bytes": 20672,
    "characters": 0,
    "chunk_size": 512,
    "create_datetime": "2025-03-24T17:37:38.769629",
    "document_id": "191e399fc20a4777bf184ea138416595",
    "end_date": null,
    "error_text": null,
    "file_download_url": "https://ai-agent-dev.oss-cn-beijing.aliyuncs.com/docs/DOS命令大全.md",
    "file_name": "DOS命令大全.md",
    "file_suffix": "md",
    "generated_qa": 0,
    "id": "7880a42e4e7a4a0b9f75b03626d910c1",
    "is_permanent": true,
    "kb_id": "2e45380938e14b61b6bda80f5bd460a3",
    "md_mode": 1,
    "merge_max_len": 512,
    "overlap": 50,
    "shelve_status": 1,
    "single_max_len": 1024,
    "space_id": "ad62405276fb4a398c320d9dbe77bfef",
    "split_depth": -1,
    "start_date": null,
    "status": 0,
    "tag_description": null,
    "tags": [],
    "update_datetime": "2025-03-24T17:37:38.769634"
  },
  "message": "success",
  "success": true,
  "time": "2025-03-24 17:37:38"
}

修改知识文档

• 接口地址：POST https://ai-agent-sdk.7moor.com/agent/v1/api/update_files
• 请求体参数

参数名	类型	是否必填	描述	示例
agent_id	string	是	当前会话需要调用的agent id
doc_id	string	是	文档ID取document_id
kb_id	string	否	知识库 ID	1
chunk_size	int	否	文档切片大小	1024
bytes	int	是	文件字节大小	0
overlap	int	否	切片重叠大小	128
source_url	string	否	文件的源 URL（如果上传文件时为空，则使用上传文件）	https://xxx.com/yyy.txt
filename	string	是	文件名称	test.txt
generated_qa	int	否	是否生成问答对（1 表示生成，0 表示不生成）	0
file	file	是	上传的文件	file.txt
is_website	bool	否	是否为抽取网站内容（若为网站，则通过 URL 提取内容）	false
split_depth	int	否	MD 文档分割层级，-1 表示自动判断	-1
md_mode	int	否	MD 文件的标题和子标题组合模式，0：hierarchy 继承模式，1：simple 独立组块	0
single_max_len	int	否	大段落字数限制	1024
merge_max_len	int	否	大段落合并字数限制	512
file_conversion	int	否	文件转换选项（0：不转换，1：将 PDF/DOC/TXT 转为 MD，2：将 FAQ（Excel）转为 MD）	0
md_conversion_strategy	int	否	MD 转换时关键符号替换策略，0 表示不替换，1 表示替换	0
tags	string	否	文档新增标签。使用 JSON 格式表示的标签列表。每个标签对象应包含以下字段： tag_key (string): 标签键 tag_value (string): 标签值 description (string, 可选): 标签描述	[{\"tag_key\": \"测试\", \"tag_value\": \"测试成功\"} , {\"tag_key\": \"部门\", \"tag_value\": \"市场部\"}]
tag_description	string	否	文档标签备注	这是一个备注
shelf_status	int	否	自定义文件上传后上下架状态, 0： 下架 1：上架. 默认为0（下架）	1
start_date	string	否	文件自定义的生效起始时间	'2025-01-07 08:04:04' （以单个空格分割）
end_date	string	否	文件自定义的生效结束时间	'2025-01-07 08:05:04' （以单个空格分割）

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
    "agent_id": "678bfc6b8d3048628041ec01c8678cc8",
    "shelf_status": "1",
    "doc_id": "191e399fc20a4777bf184ea138416595",
    "bytes": 6798,
    "filename": "敏感话题.md",
    "kb_id": "2e45380938e14b61b6bda80f5bd460a3",
    "split_depth": -1,
    "md_mode": 0
}

• 响应体参数

参数名	类型	约束	描述
code	int	必返	响应状态码
message	string	必返	响应信息
success	bool	必返	请求是否成功
time	string	必返	响应时间
data	object	必返	数据对象
data.bytes	int	必返	文件字节数
data.characters	int	必返	文件字符数
data.chunk_size	int	必返	分块大小
data.create_datetime	string	必返	创建时间
data.document_id	string	必返	文档ID
data.end_date	string	可选	结束日期
data.error_text	string	可选	错误文本
data.file_download_url	string	必返	文件下载链接
data.file_name	string	必返	文件名
data.file_suffix	string	必返	文件后缀
data.generated_qa	int	必返	生成的问答对数
data.id	string	必返	唯一标识符
data.is_permanent	bool	必返	是否永久
data.kb_id	string	必返	知识库ID
data.md_mode	int	必返	Markdown模式
data.merge_max_len	int	必返	合并最大长度
data.overlap	int	必返	重叠长度
data.shelve_status	int	必返	搁置状态
data.single_max_len	int	可选	单个最大长度
data.space_id	string	必返	空间ID
data.split_depth	int	必返	分割深度
data.start_date	string	可选	开始日期
data.status	int	必返	状态
data.tag_description	string	可选	标签描述
data.tags	array	可选	标签列表
data.update_datetime	string	可选	更新时间

• 响应示例

{
  "code": 200,
  "data": {
    "bytes": 20672,
    "characters": 0,
    "chunk_size": 512,
    "create_datetime": "2025-03-24T17:37:38.769629",
    "document_id": "191e399fc20a4777bf184ea138416595",
    "end_date": null,
    "error_text": null,
    "file_download_url": "https://ai-agent-dev.oss-cn-beijing.aliyuncs.com/docs/DOS命令大全.md",
    "file_name": "DOS命令大全.md",
    "file_suffix": "md",
    "generated_qa": 0,
    "id": "7880a42e4e7a4a0b9f75b03626d910c1",
    "is_permanent": true,
    "kb_id": "2e45380938e14b61b6bda80f5bd460a3",
    "md_mode": 1,
    "merge_max_len": 512,
    "overlap": 50,
    "shelve_status": 1,
    "single_max_len": 1024,
    "space_id": "ad62405276fb4a398c320d9dbe77bfef",
    "split_depth": -1,
    "start_date": null,
    "status": 0,
    "tag_description": null,
    "tags": [],
    "update_datetime": "2025-03-24T17:37:38.769634"
  },
  "message": "success",
  "success": true,
  "time": "2025-03-24 17:37:38"
}

删除知识文档

• 接口地址：POST https://ai-agent-sdk.7moor.com/agent/v1/api/delete_files
• 请求体参数

参数名	类型	是否必填	描述
agent_id	string	是	当前会话需要调用的agent id
id	string	是	query_files的唯一标识符

• 请求体示例

{
    "appid": "I7J1EEB3FH3LCRO1DRUEZEBFCY1XPRMX",
    "apptoken": "YVRNZD0X9BT6VEYX",
    "timestamp": "20250321140659",
    "auth_token": "STdKMUVFQjNGSDNMQ1JPMURSVUVaRUJGQ1kxXFBSTUs6MjAyNTAzMjExNDA2NTk=",
    "sig": "00addfa69e29757a20939cca7e597c0X",
    "agent_id": "678bfc6b8d3048628041ec01c8678cc8",
    "id": "7880a42e4e7a4a0b9f75b03626d910c1"
}

• 响应示例

{
    'code': 200,
    'data': null,
    'message': 'success',
    'success': true,
    'time': '2025-03-21 18:59:16'
}