蓝心九问
工具库插件工具配置

HTTP

HTTP 类型插件是基于 HTTP 协议实现外部工具交互的传统插件形式,也是目前应用最广泛的基础类型。其核心逻辑是通过标准化的 HTTP 请求(如 GET、POST、PUT、DELETE 等方法)与外部系统的 API 接口建立通信,实现数据的上传、获取与功能调用。

在具体实现上,开发者需预先配置外部 API 的请求URL、请求头(Headers)、请求参数(Query/Body)及认证信息(如 Token、API Key),插件会按照预设规则自动封装请求并解析返回结果(通常为 JSON/XML 格式)。例如,对接天气查询 API 时,HTTP 插件可通过发送包含城市 ID 的 GET 请求,从第三方服务器获取实时天气数据,并将温度、湿度等关键信息提取后返回给智能体。

创建插件

定义插件

从 工具库-创建工具-插件,进入创建插件页面后,填写名称和简介、创建方式选择HTTP、配置插件URL、Header列表(选填)、授权方式。

  • 名称、简介、创建方式、插件url:均为必填内容,如果用户未填写,则无法创建。插件url是指插件访问地址或相关资源的链接。

  • Header列表:HTTP请求头列表是客户端程序和服务器在每个HTTP请求和响应中发送和接收的字符串列表。这些标头通常对最终用户不可见,仅由服务器和客户端应用程序处理或记录。

  • 授权方式:选择插件使用的授权或验证方式。目前支持如下两种类型:无需授权认证和Service认证。Service 认证通常是指一种简化的认证方式,其中 API 调用需要某种秘钥或令牌来验证其合法性。这种秘钥可能会通过查询参数或请求头传递。它是为了确保只有拥有此秘钥的用户或系统能够访问 API。例如,你可能已经看到过有些公开 API 会要求你注册以获得一个 API 秘钥。

添加工具

填写完上述信息后,即可进入添加工具页面。你需要配置工具名称、工具描述、路径、请求方法和参数。

  • 工具名称、工具描述、路径、请求方法:均为必填内容,如果用户未填写,则无法保存。

  • 输入参数:可以为空,如果添加了一个入参,则输入框必填。

  • 输出参数:包含一键生成参数,此时需要根据输入参数进行解析,点击出现弹窗。

插件示例

本教程以天气查询API为例。以下是这个接口的基本信息:

API信息说明
请求地址http://jiuwen-plugins-adapter.vivo.lan:8080
接口(Endpoint)/open-api/ai-search/weather
请求方法GET
HeaderNone
请求参数text=南京今天的天气怎么样
返回参数{    "success": true,    "code": 0,    "msg": "成功",    "data": [        {            "link": "http://www.weather.com.cn/weather/101190101.shtml",            "position": 1,            "snippet": "南京天气预报,及时准确发布中央气象台天气信息,便捷查询南京今日天气,南京周末天气,南京一周天气预报,南京蓝天预报,南京天气预报,南京40日天气预报,还提供南京 ...",            "title": "预报- 南京 - 天气网"        },        {            "link": "https://weather.cma.cn/web/weather/58238.html",            "position": 2,            "snippet": "气温 · 降水 · 风速 ; 30.3℃ · 无降水 · 3.3m/s ; 32.9℃ · 无降水 · 7.5m/s ...",            "title": "中国气象局-天气预报-城市预报"        }    ]}

On this page