自定义插件
支持创建自定义插件能力,支持设置意图识别 或 关建词识别的触发条件,执行调用外部接口或服务。可对接业务系统、数据库、第三方接口服务、外部设备等。
1. 功能简介
自定义插件的实现方式是基于自有或第三方的API,在LinkAI创建一个可以访问该API的能力,当满足触发条件时调用该API以实现其支持的特定功能。
例如,我们可以将业务系统的数据写入API作为自定义插件,当用户提问满足条件时可以自动往业务系统写入数据;也可以将数据库的查询接口服务作为自定义插件,通过对话式的交互,让AI执行数据获取和分析的任务,等等。
自定义插件支持 HTTP/HTTPS 接口,只需要在LInkAI配置接口的 描述、请求地址、参数 即可。
2. 配置说明
以下用对接 第三方快递查询 接口为例进行说明:
该第三方接口的接口文档中对于请求地址、请求方法 和 请求参数等信息做了完整的说明,根据接口文档说明,在LinkAI创建自定义插件(创建入口为 "控制台 - 插件 - 自定义插件"),填写插件的名称、描述、头像,并根据接口文档配置第三方接口的信息即可完成创建。
"插件描述" 会用于AI判断插件的执行条件,需尽量描述清楚插件的使用场景、什么时候需要执行该插件。当自定义插件的触发条件选择「意图识别」时,用户提问与插件描述的语义意图匹配时,则触发该插件。
2.1 多级请求和响应结构设置
2.1.1 请求参数支持多级
自定义插件参数支持 对象 和 数组 类型,支持定义多级嵌套的入参结构,以适配更复杂的接口调用:
2.1.2 支持定义接口响应的结构
支持 响应结果 配置,可定义接口返回中的各个字段的 名称、类型、描述,提升模型对接口返回数据的处理效果:
同时为了方便快速配置响应结构,提供了一键 自动填写 的功能,填入请求参数后将根据实际请求的数据自动生成响应结构,生成后可手动筛选所需的字段,并补充描述信息,保存插件后生效。
响应结果的定义可按需选择是否开启,如不开启,接口的全部返回数据都会交给模型处理。
定义结构化的响应结果,对插件效果有以下提升:
- 提升回答准确性: 响应结果中的字段描述会发送给大模型,增强模型对返回结果的理解,提升向用户回复的效果
- 减少上下文长度: 用户定义了响应字段后,结果中的其他字段信息则会被过滤,可以实现精确提取回复中的关键内容,在减少token消耗的同时也降低了无关信息对模型的干扰
2.2 在线调试
自定义插件支持 在线调试 ,方便检查接口的联通性和参数填写的正确性。
点击右上角 调试 按钮,填入参数值后提交。若请求成功,则会展示接口返回的结果;若失败会输出接口的错误码以及错误信息:
3. 使用说明
3.1 应用中使用
自定义插件的配置和使用方法与内置插件相同,即在「应用配置-插件配置」中添加,并设置触发条件(意图识别 / 关键词识别)启用即可。自定义插件基于在应用和工作流中的使用,可以兼容支持网页端调试、API接入、渠道接入(微信、企微、公众号)等。
3.2 工作流中使用
工作流中的 插件 节点可选择创建的自定义插件。并可开启 结构化参数,更精准地定义请求参数和响应结果。在请求参数中可填入前置节点的输出变量,输出变量可被后置节点所引用:
如不开启结构化参数,将依据插件配置中请求参数的描述,从节点输入中提取入参信息;插件的返回结果也将完整输出。