添加/获取/移除知识库内文档
1. 简介
1.1 场景简介
添加/获取/移除知识库内文档场景是指,借助讯飞星火插件,实现向指定知识库添加上传后的文档、根据文档名称与查询数量获取指定知识库内匹配的文档、移除知识库内无效文档的效果,提高知识库内文档查询与管理效率。
1.2 应用场景
适用于需要将上传的文档进行归类整理的场景中。
1.3 预期效果
以向知识库「公司考勤规范」添加、获取、移除文档「考勤与请假规章制度」为例,效果如下所示:
2. 插件安装及配置
2.1 安装插件
1)直接安装
2)插件市场处安装
在简道云「插件市场」处,安装「讯飞星火」插件。插件市场处安装方法可参见文档:插件市场中【2.3 插件安装】。
2.2 配置插件
安装完成后,在「插件管理」处,点击插件右侧的「设置」按钮,将 讯飞星火插件中【2.3 获取 APPID 和 APISecret 】处获取到的「APPID」 和 「APISecret」配置进去。
2.3 启用插件
在插件管理中,打开讯飞星火插件右侧开关,启用插件。
3. 表单搭建
插件使用体验可点击右侧链接:讯飞星火插件模板。本文将按照示例表单进行讲解。
插件配置需要使用 3 张表单,分别是:
- 向知识库添加文档:将上传成功后的文档,添加至制定的知识库内;
- 获取知识库内文档列表:根据文档名称和查询数量,获取指定知识库内匹配的文档;
- 移除知识库内文档:移除知识库内无用/无效的文档。
4. 前端事件配置
4.1 向知识库添加文档
4.1.1 添加按钮执行动作
进入「向知识库添加文档」表单中,点击「是否添加」按钮字段,在「字段属性 >> 执行动作」处,点击「添加执行动作」:
4.1.2 设置事件名称和说明
添加好前端事件后,首先设置前端事件的基础信息,即事件名称和事件说明,用于区分前端事件:
4.1.3 设置执行动作
设置执行动作如下:
- 选择插件:选择「讯飞星火 >> 向知识库添加文档」;
- 知识库 ld:设置为字段值,即「知识库 ID」字段;
- 添加文档列表:设置为字段值,即「文档 id」字段;
- 字段存储关系,点击「添加」按钮,并选择添加「全部」:
- 设置「失败文档列表.文档 Id」的值存储到「添加失败文档列表.文档 id」中;
- 子字段填充方式:选择「先清空子表单再填充」。
全部设置完成后点击「保存」。
4.2 获取知识库内文档列表
4.2.1 添加按钮执行动作
进入「获取知识库内文档列表」表单中,点击「是否获取」按钮字段,在「字段属性 >> 执行动作」处,点击「添加执行动作」:
4.2.2 设置事件名称和说明
添加好前端事件后,首先设置前端事件的基础信息,即事件名称和事件说明,用于区分前端事件:
4.2.3 设置执行动作
设置执行动作如下:
- 选择插件:选择「讯飞星火 >> 获取知识库文档列表」;
- 知识库 ld :设置为字段值,即「知识库 ID」字段;
- 文档名(模糊查询):设置为字段值,即「文档名称」字段;
- 数量显示:设置为字段值,即「查询数量」字段;
- 字段存储关系,点击「添加」按钮,并选择添加「全部」:
- 设置「知识库文档列表.文档 Id」的值存储到「知识库文档列表.文档 id」中;
- 设置「知识库文档列表.文档名称」的值存储到「知识库文档列表.文档名称」中;
- 设置「知识库文档列表.文档创建时间」的值存储到「知识库列表.文档创建时间」中;
- 子字段填充方式:选择「先清空子表单再填充」。
全部设置完成后点击「保存」。
4.3 移除知识库内文档
4.3.1 添加按钮执行动作
进入「移除知识库内文档」表单中,点击「是否移除」按钮字段,在「字段属性 >> 执行动作」处,点击「添加执行动作」:
4.3.2 设置事件名称和说明
添加好前端事件后,首先设置前端事件的基础信息,即事件名称和事件说明,用于区分前端事件:
4.3.3 设置执行动作
设置执行动作如下:
- 选择插件:选择「讯飞星火 >> 移除知识库中文档」;
- 知识库 ld:设置为字段值,即「知识库 ID」字段;
- 移除文档列表:设置为字段值,即「文档 id」字段;
- 字段存储关系,点击「添加」按钮,并选择添加「全部」:
- 设置「失败文档列表.失败文档 Id」的值存储到「移除失败文档列表.文档 ID」中;
- 子字段填充方式:选择「先清空子表单再填充」。
设置完成后点击「保存」。
4.4 效果演示
效果参见本文【1.3 预期效果】。