接入方式
登录云客服系统,进入“设置”-“对接中心”,选择“知识库事件”,添加配置事件类型为相关知识推送事件的配置即可。

1、推送通用字段
| 字段名 | 数据类型 | 名称 | 描述 |
| kbId | String | 知识库ID | 问答所属知识库的唯一标识 |
| kbName | String | 知识库名称 | 问答所属知识库的名称 |
| hitCount | Number | 命中次数 | 该问答被检索命中的次数(0 表示新创建未命中) |
| dislikeCount | Number | 不喜欢次数 | 该问答被标记“不喜欢”的次数(0 表示未被标记) |
| eventUniqueId | String | 事件唯一ID | 本次创建问答事件的全局唯一标识,用于追踪 |
| likeCount | Number | 喜欢次数 | 该问答被标记“喜欢”的次数(0 表示未被标记) |
| categoryName | String | 分类名称 | 问答所属的知识库分类 |
| accountId | String | 账户ID | 操作创建问答的账户唯一标识 |
| effectStatus | String | 生效状态 | 问答的生效状态: inEffect:生效中 notInEffect:未生效 invalid:已失效 un_known:未知 |
| enable | Boolean | 是否启用 | 标识该问答是否启用,false 表示禁用 |
2、标准知识消息推送
标准知识新增示例:
{"kbId":"2013167161958993920",
"kbName":"对接测试知识库",
"hitCount":0,
"question":"您好",
"dislikeCount":0,
"eventUniqueId":"2013167259019382784",
"likeCount":0,
"eventType":"kbQACreate",
"categoryName":"未分类",
"keywordsList":[],
"accountId":"1090",
"effectStatus":"inEffect",
"effective":false,
"answer":"您好",
"enable":false,
"qaId":"2013167238140137472"}
标准知识推送字段说明:
| 字段名 | 数据类型 | 名称 | 描述 |
| question | String | 问题内容 | 知识库问答的问题文本 |
| eventType | String | 事件类型 | kbQACreate:新增标准知识kbQAUpdate:修改标准知识kbQADelete:删除标准知识 |
| keywordsList | Array | 关键词列表 | 该问答的关联关键词集合(空数组表示未设置关键词) |
| effective | Boolean | 是否有效 | 标识该问答是否有效,false 表示未生效/禁用 |
| answer | String | 答案内容 | 知识库问答的对应答案文本 |
| qaId | String | 问答ID | 该知识库问答的唯一标识 |
3、文档知识消息推送
文档知识新增推送示例:
{"kbId":"2013167161958993920",
"kbName":"对接测试知识库",
"hitCount":0,
"docId":"2013175166758817792",
"dislikeCount":0,
"eventUniqueId":"2013175166863675392",
"likeCount":0,
"eventType":"kbDocCreate",
"categoryName":"未分类",
"accountId":"1090",
"effectStatus":"inEffect",
"docName":"使用手册.docx",
"enable":false,
"desc":""}文档知识推送字段说明:
| 字段名 | 数据类型 | 名称 | 描述 |
| docId | String | 文档ID | 知识库文档的唯一标识 |
| eventType | String | 事件类型 | kbDocCreate:创建文档知识kbDocUpdate:修改文档知识kbDocDelete:删除文档知识 |
| docName | String | 文档名称 | 知识库文档的文件名,含后缀,示例:使用手册.docx |
| desc | String | 文档描述 | 文档的补充描述信息,空字符串表示未设置描述 |
4、文档分段知识消息推送
文档分段知识新增推送示例:
{"kbId":"1968279104485294080",
"accountId":"1090",
"kbName":"售前知识库",
"docSegId":"2013178725973889024",
"answer":"TSET1",
"docId":"1968511244415205376",
"enable":false,
"eventUniqueId":"2013178753048121344",
"eventType":"kbDocSegCreate",
"categoryName":"未分类"}文档分段知识推送字段说明:
| 字段名 | 数据类型 | 名称 | 描述 |
| docSegId | String | 文档片段ID | 知识库文档片段的唯一标识(用于定位文档内具体片段) |
| answer | String | 片段内容 | 文档片段的具体文本内容(可作为问答答案复用),示例:TSET1 |
| docId | String | 所属文档ID | 文档片段对应的源文档唯一标识,关联知识库文档 |
| eventType | String | 事件类型 | kbDocSegCreate:创建文档分段知识kbDocSegUpdate:修改文档分段知识kbDocSegDelete:删除文档分段知识 |
| categoryName | String | 分类名称 | 文档片段所属的知识库分类 |