1.知识类插件

可上传业务数据，进行业务问答，适用于问答搜索等场景。

1）插件类型：选择“知识类插件”

2）填写插件基本信息

• 插件名称：填写插件名称。
• 插件描述：描述这个插件能干什么，方便Agent判断哪些问题要调用这个插件。
• 问答prompt：系统自动填充角色、简介、技能、要求、工作流程信息，用户可自定义编辑，可点击恢复默认状态。
• 问法示例：填写插件的一些典型问法，填写后会展示在插件详情页的插件体验区旁边，便于其他开发者能直观了解该插件能解答哪些问法。

3）上传数据

• 支持“本地上传”和“API接入”两种方式。
• 本地上传：本地文件可点击或拖拽上传，支持数据格式包括：.docx, .doc, .xlsx, .xls, .pptx, .ppt, .pdf, .txt。

• API接入：支持API推送，每个知识类插件都会自动生成一个API token，可按token进行数据推送，具体操作可下载查看“API接入操作手册”。

4）插件调试

• 数据上传后，系统会自动执行数据解析和发布。
• 数据状态变为“发布成功”后，可对插件里数据进行问答调试。
• 插件调试时，默认返回自然语言结果，同时可查看日志信息。

5）插件发布

调试没问题后，可点击发布。

2.任务类插件

需要调用第三方API的插件，需要绑定API才可使用。 根据注册方式的不同，区分为API和Flow两种方式。

• API：单个API调用，无需编排
• Flow：需要对API进行编排、数据处理

2.1 API

基本信息录入

• 名称：插件名称

• 描述：描述插件的核心能力以及使用场景，以便于大模型进行意图识别，决定什么时候调起该插件。

  • 例如：为当前用户发起假期申请，包含休假的开始、结束时间、假期类型和请假事由，假期类型包括年假、调休、病假，可能出现的字段有请假、请一天、请两天、休一天、休两天等。
  • 例如：用于查询快递信息，只支持单一快递号查询
• 问法示例：问题示例可以辅助用户了解该插件支持的问题类型，可以在体验的时候快速输入query

API配置

• 选择API

  • 选择从API管理维护的APIS (只能选择已发布的APIS)
  • API有更新时，可以点击“更新API数据”进行接口更新，假如不更新，调用的还是老版本的API

• 待抽取参数

  • 此处需要维护需要哪些参数需要大模型进行参数抽取，同时需要维护帮助大模型抽参的描述（请求头、请求体、URL查询参数、URL路径参数）

• 自定义返回结果

  • 透传响应体：直接透传API返回的全部参数。

  

  • 人工指定回复：定义插件最终返回给用户的答案话术，可在话术里以${父参数名称.子参数名称}的方式插入变量

    • 例如： 获取地址成功！您所查询的地区为：${data.geocodes.0.country}${data.geocodes.0.province}${data.geocodes.0.city}${data.geocodes.0.district}的编码为${data.geocodes.0.adcode}

  

  

  • 大模型回复：可以通过prompt描述，让大模型对返回结果进行整理汇总

    • 例如： 帮我查询地区编码信息，进行总结并拟人化的返回

    

    

    • 例如： 以markdown的格式输出结果，可以把接口的返回结果整理成表格的格式展示出来。表格的表头为：|地区|地区编码|，对应接口的返回结果里面的字段为|address|City|。输出数据要求：只能有表格内的信息，不要返回表格以外的文字输出；不需要对表格进行说明。

2.2 FLOW

对API插件能力的补充，可以多API进行编排、参数、返回结果的处理。以卡片、指定回复、json、文本等格式进行数据的返回。

基本信息录入

• 名称：插件名称

• 描述：描述插件的核心能力以及使用场景，以便于大模型进行意图识别，决定什么时候调起该插件。

  • 例如：为当前用户发起假期申请，包含休假的开始、结束时间、假期类型和请假事由，假期类型包括年假、调休、病假，可能出现的字段有请假、请一天、请两天、休一天、休两天等。
  • 例如：用于查询快递信息，只支持单一快递号查询。
• 问法示例：问题示例可以辅助用户了解该插件支持的问题类型，可以在体验的时候快速输入query。

FLOW搭建

触发调用节点

• 触发调用节点：为FLOW入口节点，定义入参信息（大模型抽取的参数值）。可以初始化参数数据，Flow调试的时候使用。

• 添加操作：

  • 可以增加API节点FLOW流执行到此节点的时候，会进行接口调用

    

  • API的参数可以从所有直接或者间接上游节点的request、response，以及上下文选择某个参数值作为本API的入参

  

• 可以添加超级助理内置的工具（数据收集器、筛选、指定回复、工作卡）

  • 数据收集器：json格式，可以定义常量、收集上游所有节点的参数或者结果，供下游节点使用

  • 时间戳转格式化时间

    • 示例：将时间戳（毫秒1709791558850 秒1709791601）转换成格式化时间（2024-03-07 14:05:58） format：yyyy-MM-dd HH:mm:ss isMillSecondsFlag：是否为毫秒（1：true，0：false） timestamp：时间戳

  • 格式化时间转时间戳

    • 示例：将格式化时间（2024-03-07 14:05:58）转换成时间戳（毫秒1709791558850 秒1709791601） date：日期 isMillSecondsFlag：是否为毫秒（1：true，0：false）
  • 脚本函数转换：用户可以自己写java/groovy（兼容java语法）脚本进行数据的处理
  • 自定义回复话术：用户可以自己进行话术的整理，也可以拼接下游选择的参数或者结果字段
  • 工作卡：以卡片的形式进行交互的澄清

  

• 添加分支：根据上游节点参数或者返回值字段，进行条件筛选
• 工作卡配置：点击创建或者编辑进入卡片编辑页面，在卡片编辑页面进行卡片的搭建，以及卡片元素动态变量的定义、事件的定义，具体搭建说明见卡片搭建教程。卡片搭建成功后，点击保存后跳转回FLOW配置页面，然后进行节点字段的关联操作。

• 回调流：卡片中的某些操作需要进行二次的交互，再此调用的流。比如：请假卡片参数澄清后，点击确定，进行请假接口的真实调用。

  • userData：与卡片动态变量进行过绑定的FLow流中的数据

  • event：卡片触发事件的信息

    • interactivity_id:触发事件的id，卡片配置中可以查看
    • fields：触发事件中用户最终提交的卡片上的数据

  • 例如：

    • 请假卡片

    

    • 点击确认的回调流配置

{
 "userData": {
   "asOfDateEndSelectEnum": [
     "上午",
     "下午"
   ],
   "editable": "1",
   "asOfDateStartSelect": "下午",
   "botCardTitle": "请假",
   "lt": "年假",
   "reson": "请假理由",
   "hasDays": "*注意：您当前可用年假为20天",
   "leaveType": [
     "丧假",
     "事假",
     "婚嫁",
     "年假",
     "调休"
   ],
   "readonly": "0",
   "asOfDateEndSelect": "上午",
   "asOfDateStart": "1709049600",
   "asOfDateEnd": "1709135999",
   "asOfDateStartSelectEnum": [
     "上午",
     "下午"
   ]
 },
 "appContext": {},
 "biz_data": {},
 "templateId": {},
 "event": {
   "interactivity_id": "botCard_button_click",
   "fields": [
     {
       "name": "unit_senior_time_selector_1708851749726177",
       "value": "1709049600"
     },
     {
       "name": "unit_senior_select_1708850607467118",
       "value": "array1"
     },
     {
       "name": "unit_senior_time_selector_1709105236252124",
       "value": "1709135999"
     },
     {
       "name": "unit_senior_select_1709105236252676",
       "value": "array0"
     },
     {
       "name": "unit_senior_input_1709105324573626",
       "value": "请假理由"
     },
     {
       "name": "leaveType",
       "value": "array3"
     }
   ]
 },
 "userId": ""
}

3.生成类插件

生成类插件

可自定义prompt，执行对应prompt指令，适用于总结、翻译、创作等场景。

1）插件类型：选择“生成类插件”

2）填写插件信息

• 插件名称：填写插件名称。
• 插件描述：描述这个插件能干什么，方便Agent判断哪些问题要调用这个插件。
• 问法示例：填写插件的一些典型问法，填写后会展示在插件详情页的插件体验区旁边，便于其他开发者能直观了解该插件能解答哪些问法。
• prompt：详细说明这个插件如何响应用户的问题，定义输出的答案格式、字数、内容表达风格等。

• prompt变量：

  • 若prompt中涉及变量，可以在此处添加变量名称和变量描述，变量名称尽量用英文命名。
  • 添加变量后，在prompt中可以用大括号的方式引用此变量，比如下图中的{text}。
• 流式返回：指大模型返回答案时，在前端可以以流式方式逐字返回展示。

• 大模型：选择插件要调用的大模型，可以选择系统预置的“千帆千亿”和“千帆百亿”模型，也可以自定义选择您自己训的大模型。

  • 自定义大模型：

    • 自定义大模型必须是在百度千帆平台训练的模型。
    • 版本名称：自定义您的大模型名称
    • 调用地址：填写您的千帆大模型调用地址
    • AK：填写千帆大模型的App Key
    • SK：填写千帆大模型的Secret Key

3）插件调试：

• 填写完插件信息后，可对插件进行调试，同时可查看日志信息。

4）插件发布：调试没问题后，可点击发布。