七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
AI Agent

API 工具对接

在七鱼 AI Agent 中创建自定义工具组,配置通用 Header、鉴权方式、API 工具及输入输出参数,并完成在线调试。

Agent 工具创建指引

什么是工具组?

一个工具组可以包含一个或多个工具(API)。

工具组与工具的关系

创建工具组

七鱼支持创建自定义工具组。每个工具组可以添加多个工具,每个工具都是一个独立的 API 服务。同一个工具组内的不同工具必须使用相同的域名,即具有相同的 endpoint。

例如,一个天气查询 API Service 可能包含以下两个 endpoint:

  • 查询当前天气:http://api.weather.com/current
  • 查询预测天气:http://api.weather.com/forecast

创建工具组时,每个 endpoint 对应工具组下的一个工具。

天气查询工具组示例

添加工具组信息

填写工具组的基础信息。

添加工具组信息

设置 Header 列表

Header 列表中可以设置 API 通用参数,例如 Authorization、API_KEY、Token 等。

选择授权方式

目前支持三种授权方式:

  • 无鉴权:不进行权限校验,也可以在 Header 列表中自行设置鉴权信息。
  • 七鱼鉴权体系:采用七鱼的 checksum 方式校验,需要填写 AppKey 和 AppSecret。计算方式请参考通用说明 - 七鱼签名。
  • 云商鉴权体系:采用云商的签名方式校验,需要填写 AppKey 和 AppSecret。计算方式请参考通用说明 - 云商签名。

新增工具

填写 API 工具的工具名称、工具描述和请求路径等信息。

工具描述请务必详细填写,Agent 会根据工具描述选择要调用的工具。

填写基础信息

填写 API 工具基础信息

配置输入参数

配置 API 工具输入参数

配置输出参数

配置 API 工具输出参数

调试工具

完成配置后,在调试区域填写测试参数并调用工具,确认请求与响应符合预期。

调试 API 工具

这篇文档有帮助吗?

目录