登录
基础
连接微信
办公目录
应用在专区的程序可调用本系列接口管理专区知识集。添加知识集后，应用和智能机器人可在专区中结合此知识集调用大模型。
| 应用类型 | 权限要求 |
|---|---|
| 自建应用 | 需具备「数据与智能专区-知识集」权限 |
| 代开发应用 | 需具备「数据与智能专区-知识集」权限 |
| 第三方应用 | 需具备「数据与智能专区-知识集」权限 |
请求方法
通过SDK调用，具体方式参考专区程序使用指引。
请求接口名:
knowledge_base_list
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"kb_info_list": [{
"kb_id": "KBID",
"kb_name": "NAME"
}]
}参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 错误码描述 |
| kb_info_list | 知识集信息列表，详见KBInfo说明 |
KBInfo说明:
| 参数 | 说明 |
|---|---|
| kb_id | 知识集ID |
| kb_name | 知识集名称 |
请求方法
通过SDK调用，具体方式参考专区程序使用指引。
请求接口名：
knowledge_base_create
每个企业的知识集总数量不能超过1000
在线文档 需满足浏览人数 > 1且创建者在企业的"文档存档范围"内，微盘文件需满足文件所在空间浏览人数 > 1，且文件上传者在企业的"文档存档范围"内，否则会进入返回结果的rejected_item_list
请求包体：
{
"kb_name": "知识集名",
"doc_list": [{
"doc_name": "客服问答.pdf",
"type": 2,
"file_media_id": "MEDIA_ID"
},
{
"doc_name": "腾讯网",
"type": 101,
"web_url": "http://www.qq.com"
},
{
"doc_name": "客服培训手册",
"online_docid": "DOCID"
},
{
"doc_name": "产品规格表.xlsx",
"fileid": "FILEID"
}
]
}参数说明：
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 调用接口凭证 |
| kb_name | 是 | string | 知识集名 不少于1个字符 不多于20个字符 |
| doc_list | 是 | obj[] | 內容列表 可填充个数：1 ~ 1000 |
| doc_list.doc_name | 是 | string | 內容名，如果是文件，需要有准确的文件名后缀 不多于200字节 |
| doc_list.type | 是 | uint32 | 內容类型，仅离线文件 / 网页 时必传 取值范围： 2 - pdf 4 - xlsx(用于上传问答对表格，需从管理端下载模版配置后上传) 5 - doc 6 - docx 101 - 网页链接 在线文档 / 微盘文件 / 微盘目录由后台自动识别，无需传 type |
| doc_list.file_media_id | 否 | string | 专区临时文件ID。当 type 为 2/4/5/6 时必传 通过上传临时文件到专区接口获取 不多于1024字节 |
| doc_list.web_url | 否 | string | 网页链接。当type为网页链接时必传，以http或https开头的链接 不多于1024字节 |
| doc_list.online_docid | 否 | string | 在线文档/在线表格/在线智能表格/在线思维导图/在线智能文档的 docid。传此字段时无需传 type / file_media_id / web_url，不多于128字节 |
| doc_list.fileid | 否 | string | 微盘文件 / 微盘目录的 fileid（文件还是目录由后台自动识别）。传此字段时无需传 type / file_media_id / web_url，不多于128字节 |
file_media_id / web_url / online_docid / fileid 四选一，且仅当对应字段非空时其他字段无效。
入参约束：file_media_id/web_url/online_docid/fileid四选一——每个doc_list[i]不能同时为空，否则该条目会进入rejected_item_list，reject_errcode = 710730。
返回结果：
{
"errcode": 0,
"errmsg": "ok",
"kb_id": "KBID",
"doc_list": [{
"doc_name": "客服问答.pdf",
"type": 2,
"file_media_id": "MEDIA_ID",
"docid": 1
},
{
"doc_name": "百度一下，你就知道",
"type": 101,
"web_url": "http://www.baidu.com",
"docid": 2
},
{
"doc_name": "客服培训手册",
"type": 8,
"online_docid": "DOCID_XXX",
"docid": 3
}
],
"rejected_item_list": [{
"doc_name": "产品规格表.xlsx",
"fileid": "WPSXXX",
"type": 12,
"reject_errcode": 710733,
"reject_errmsg": "doc not public, viewer count <= 1"
}]
}部分成功语义：合规内容已正常入库（出现在doc_list，带docid）；不合规内容进入rejected_item_list。doc_list与rejected_item_list互斥，两者总和 ≤ 入参doc_list长度（重复条目会被去重）。
调用方必须主动检查rejected_item_list是否非空，否则会漏掉被拒绝的内容。
参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码 |
| errmsg | string | 错误码描述 |
| kb_id | string | 知识集ID |
| doc_list | obj[] | 已成功入库的內容列表 |
| doc_list.doc_name | string | 內容名 |
| doc_list.type | uint32 | 內容类型（后台识别后回带） |
| doc_list.file_media_id | string | 专区临时文件ID（按入参回带） |
| doc_list.web_url | string | 网页链接（按入参回带） |
| doc_list.online_docid | string | 在线文档 docid（按入参回带） |
| doc_list.fileid | string | 微盘文件 / 目录 fileid（按入参回带） |
| doc_list.docid | uint64 | 临时文件添加到知识集后的內容ID |
| rejected_item_list | obj[] | 被拒绝的內容列表。调用方必须主动检查此字段是否非空——外层 errcode 不会因为此字段非空而变非 0 |
| rejected_item_list[].doc_name / file_media_id / web_url / online_docid / fileid | — | 与入参对齐 |
| rejected_item_list[].type | uint32 | 后台推导出的 type（推导失败为 0） |
| rejected_item_list[].reject_errcode | int32 | 该条內容被拒绝的错误码 |
| rejected_item_list[].reject_errmsg | string | 该条內容被拒绝的错误描述 |
请求方法
通过SDK调用，具体方式参考专区程序使用指引。
请求接口名：
knowledge_base_detail
只能获取本应用通过API创建且没有被企业取消授权的知识集
请求包体：
{
"kb_id": "KBID"
}参数说明：
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 调用接口凭证 |
| kb_id | 是 | string | 知识集ID |
返回结果：
{
"errcode": 0,
"errmsg": "ok",
"kb_id": "KBID",
"kb_name": "KB_NAME",
"doc_list": [{
"docid": 1,
"doc_name": "客服问答.pdf",
"type": 2,
"status": 1
},
{
"docid": 2,
"doc_name": "百度一下，你就知道",
"type": 101,
"web_url": "http://www.baidu.com",
"status": 0
},
{
"docid": 3,
"doc_name": "客服培训手册",
"type": 8,
"online_docid": "DOCID_XXX",
"status": 0
},
{
"docid": 4,
"doc_name": "产品规格表.xlsx",
"type": 12,
"fileid": "WPSXXX",
"status": 0
}
]
}参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码 |
| errmsg | string | 错误码描述 |
| kb_id | string | 知识集ID |
| kb_name | string | 知识集名 |
| doc_list | obj[] | 內容列表 |
| doc_list.docid | uint64 | 临时文件添加到知识集后的內容ID |
| doc_list.doc_name | string | 內容名 |
| doc_list.type | uint32 | 內容类型 取值范围： 2 - pdf 4 - xlsx(用于上传问答对表格，需从管理端下载模版配置后上传) 5 - doc 6 - docx 8 - 在线文档 9 - 在线表格 10 - 微盘文本 11 - 微盘pdf 12 - 微盘excel 13 - 微盘doc 14 - 微盘docx 15 - 微盘csv 16 - 微盘文件夹 19 - 在线智能表格 20 - 在线思维导图 21 - 在线智能文档 101 - 网页链接 |
| doc_list.web_url | string | 网页链接（type=101 时返回） |
| doc_list.online_docid | string | 在线文档 docid（type ∈ {8,9,19,20,21} 时返回） |
| doc_list.fileid | string | 微盘文件/目录 fileid（type ∈ {10~16} 时返回） |
| doc_list.status | int32 | 內容状态。 0-添加成功； 1-添加失败（网页无法访问/需鉴权/Excel没遵从模版格式等）； 2-添加中； |
请求方法
通过SDK调用，具体方式参考专区程序使用指引。
请求接口名：
knowledge_base_add_doc
暂不支持添加在线文档/表格/微盘文件
只能操作本应用通过API创建且没有被企业取消授权的知识集
请求包体：
{
"kb_name": "知识集名",
"doc_list": [{
"doc_name": "客服问答.pdf",
"type": 2,
"file_media_id": "MEDIA_ID"
},
{
"doc_name": "腾讯网",
"type": 101,
"web_url": "http://www.qq.com"
},
{
"doc_name": "客服培训手册",
"online_docid": "DOCID"
},
{
"doc_name": "产品规格表.xlsx",
"fileid": "FILEID"
}
]
}参数说明：
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 调用接口凭证 |
| kb_id | 是 | string | 知识集ID |
| doc_list | 是 | obj[] | 內容列表 可填充个数：1 ~ 1000。每个知识集的內容总数量不能超过1000 |
| doc_list.doc_name | 是 | string | 內容名，如果是文件，需要有准确的文件名后缀 不多于200字节 |
| doc_list.type | 否 | uint32 | 內容类型，仅离线文件 / 网页时必传 取值范围： 2 - pdf 4 - xlsx(用于上传问答对表格，需从管理端下载模版配置后上传) 5 - doc 6 - docx 101 - 网页链接 在线文档/微盘文件/微盘目录由后台自动识别，无需传 type |
| doc_list.file_media_id | 否 | string | 专区临时文件ID。当 type 为 2/4/5/6 时必传 通过上传临时文件到专区接口获取 不多于1024字节 |
| doc_list.web_url | 否 | string | 网页链接。当 type 为 101 时必传，以http或https开头的链接 不多于1024字节 |
| doc_list.online_docid | 否 | string | 在线文档/在线表格/在线智能表格/在线思维导图/在线智能文档的 docid。传此字段时无需传 type / file_media_id / web_url 不多于128字节 |
| doc_list.fileid | 否 | string | 微盘文件 / 微盘目录的 fileid（文件还是目录由后台自动识别）。传此字段时无需传 type / file_media_id / web_url 不多于128字节 |
入参约束：file_media_id/web_url/online_docid/fileid四选一——每个doc_list[i]不能同时为空，否则该条目会进入rejected_item_list，reject_errcode = 710730。
返回结果：
{
"errcode": 0,
"errmsg": "ok",
"doc_list": [{
"doc_name": "客服问答.pdf",
"type": 2,
"file_media_id": "MEDIA_ID",
"docid": 1
},
{
"doc_name": "客服培训手册",
"type": 8,
"online_docid": "DOCID_XXX",
"docid": 2
}
],
"rejected_item_list": [{
"doc_name": "产品规格表.xlsx",
"fileid": "WPSXXX",
"type": 12,
"reject_errcode": 710728,
"reject_errmsg": "space owner not in archive range"
}]
}⚠️ 部分成功语义：合规内容已正常入库（出现在doc_list，带docid）；不合规内容进入rejected_item_list。
调用方必须主动检查rejected_item_list是否非空。
参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码（系统级错误才会非 0；业务级 reject 不影响此字段） |
| errmsg | string | 错误码描述 |
| doc_list | obj[] | 已成功入库的內容列表 |
| doc_list.doc_name | string | 內容名 |
| doc_list.type | uint32 | 內容类型（后台识别后回带） |
| doc_list.file_media_id | string | 专区临时文件ID（按入参回带） |
| doc_list.web_url | string | 网页链接（按入参回带） |
| doc_list.online_docid | string | 在线文档 docid（按入参回带） |
| doc_list.fileid | string | 微盘文件 / 目录 fileid（按入参回带） |
| doc_list.docid | uint64 | 临时文件添加到知识集后的內容ID |
| rejected_item_list | obj[] | 被拒绝的內容列表。调用方必须主动检查此字段是否非空 |
| rejected_item_list[].doc_name / file_media_id / web_url / online_docid / fileid | — | 与入参对齐 |
| rejected_item_list[].type | uint32 | 后台推导出的 type（推导失败为 0） |
| rejected_item_list[].reject_errcode | int32 | 该条內容被拒绝的错误码 |
| rejected_item_list[].reject_errmsg | string | 该条內容被拒绝的错误描述 |
请求方法
通过SDK调用，具体方式参考专区程序使用指引。
请求接口名：
knowledge_base_remove_doc
只能操作本应用通过API创建且没有被企业取消授权的知识集
请求包体：
{
"kb_id": "KBID",
"docid_list": [0,1]
}参数说明：
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 调用接口凭证 |
| kb_id | 是 | string | 知识集ID |
| docid_list | 是 | uint64[] | 要删除的docid列表 可填充个数：1 ~ 1000 |
返回结果：
{
"errcode": 0,
"errmsg": "ok"
}参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码 |
| errmsg | string | 错误码描述 |
请求方法
通过SDK调用，具体方式参考专区程序使用指引。
请求接口名：
knowledge_base_modify_name
只能操作本应用通过API创建且没有被企业取消授权的知识集
请求包体：
{
"kb_id": "KBID",
"kb_name": "NEW_NAME"
}参数说明：
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 调用接口凭证 |
| kb_id | 是 | string | 知识集ID |
| kb_name | 是 | string | 新名字 不少于1个字符 不多于20个字符 |
返回结果：
{
"errcode": 0,
"errmsg": "ok"
}参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码 |
| errmsg | string | 错误码描述 |
请求方法
通过SDK调用，具体方式参考专区程序使用指引。
请求接口名：
knowledge_base_delete
只能操作本应用通过API创建且没有被企业取消授权的知识集
请求包体：
{
"kb_id": "KBID"
}参数说明：
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 调用接口凭证 |
| kb_id | 是 | string | 知识集ID |
返回结果：
{
"errcode": 0,
"errmsg": "ok"
}参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | int32 | 返回码 |
| errmsg | string | 错误码描述 |
基础连接微信办公基础连接微信办公基础连接微信办公