Created 第三方插件使用手册 (markdown)

第三方插件使用手册.md

@@ -0,0 +1,32 @@
+## 插件整体介绍
+目前插件分为WEB页面插件和WEB服务插件, 用户录入插件信息之后, 插件就可以被向量数据库和LLM召回, 进而执行对应的插件逻辑
+
+**WEB页面插件** 插件形式为任意一个网页, 可以是一个看板, 也可以是一个解读报告, 召回之后可以把这个页面渲染到问答会话列表
+
+**WEB服务插件** 插件形式为任意一个HTTP服务链接, 通过插件召回之后, 问答服务可以根据配置自动去调用HTTP服务链接并获取结果, 并把结果呈现到问答会话列表进行渲染
+
+举个栗子, 如果我们已经有一个现成的统计看板页面, 统计了超音数每个用户的访问情况，该看板有一个按名字的筛选框, 那么如何通过自然语言召回这个页面, 并从自然语言里解析出参数传入到看板页面呢
+
+<div align="center" >
+    <img src=https://github.com/lxwcodemonkey/supersonic/blob/master/docs/images/plugin.png/>
+    <p>图1-1 第三方插件示例</p>
+</div>
+
+如上图, 为创建插件需要填写的表单
+
+**主题域:** 该插件所属的主题域, 当语义识别到对应的主题域时, 才可以召回对应主题域的插件, 如果选择"默认"主题域, 那么语义识别到任何主题域都可以召回该插件
+
+**插件名称:** 为该插件的名称, 用于标识一个插件
+
+**插件类型:** 即为上面说的WEB页面和WEB服务两种
+
+**函数名称** 可以理解为该插件的英文名称, 该名称用来和LLM进行交互, 当LLM返回对应的函数名称时, 即为选中了该名称对应的插件
+
+**函数参数** 可以理解为页面/HTTP服务的参数以及与该参数绑定的维度, 比如这里填写的参数"name", 对应的是"超音数"主题域的"用户名"维度, 那么从"alice最近访问情况怎么样"
+这个文本中解析到"alice"之后, 就可以把alice作为"name"的参数值
+
+**示例问题** 用于生成向量以及提供给LLM的语义参考, 是作为召回插件的重要依据
+
+**地址** 如果该插件为"WEB网页"类型插件, 那么该地址就是网页的地址, 如果该插件为"WEB服务"类型的插件, 该地址就为该服务的HTTP地址
+
+**高度** 可视化选项, 如果是"WEB网页" 类型的插件, 该高度为该网页展示在会话列表所占用的高度, 需要根据实际情况进行微调