工具创建指南
更新时间：2024-03-24
工具是什么？
工具是指各类可调用的服务，例如图片编辑、文本翻译、股票搜索服务等。
工具的使用方式：
- 根据文档直接调用API
- 多工具智能编排类型应用创建时作为工具挂载使用
如何创建工具？
两种创建方式：
- 从0-1构建API
- 上传OpenAPI YAML文件自动渲染
*OpenAPI YAML文件规范请参考 OpenAPI 3.0文档
两大创建入口：
-
工具中心
-
控制台-我的创作-我的工具
方式一：从零构建API接口
1. 定义工具基本信息
- 工具名称：用于展示在前端界面上的工具的名称（工具中心、工具列表）
- 工具ID：用于调用工具时的唯一标识（代码调用or大模型后续作为工具调用），请注意确认后不可修改
- 简介：工具的描述，用于后续大模型判断何时需要调用此工具，因此希望用一句话描述清晰该工具的主要功能
- 相关链接：工具介绍相关的网页链接
- 工具图片：用于展示在前端界面上的工具Logo
2. 添加功能
创建好工具后，即可往里添加功能，功能是后续大模型调用工具时的最小单位（例如，大模型会调用【单词本】这个工具中的【添加单词】这个功能），每一个功能对应了一套请求的服务地址以及请求方式，需要依次设置。
- 功能中文名称：用于展示在前端界面
- 功能英文名称：用于调用功能时的唯一标识（代码调用or大模型后续作为工具调用）
- 功能简介：功能的描述，用于后续大模型判断何时需要调用此功能，因此希望用一句话描述清晰该功能的主要功能
设置接口参数
目前工具主要应用途径为挂载至Agent应用中作为可调用能力，因此在设置输入参数的时候，需要考虑到：
-
参数个数尽量少
- 例如原API有5个必填参数，2个默认参数，建议非必要可不设置默认参数，且选择需要用户自定义强烈的参数设置为必填，因此原API接入工具中心后，可能仅有2个必填参数，3个非必填有默认值的参数。
- 对于参数的描述尽量简洁清晰（让大模型快速理解何时该触发）
- 请求参数
-
鉴权信息
-
鉴权类型：当前支持apiKey、Token、百度云bce三种鉴权方式
- API Key鉴权：需要填写apiKey的名称、值、所要添加的位置
- bearerToken：需要填写token，请求时会自动以“bearer”为前缀
- 百度云bce：需要填写clientId（对应AK）、clientSecret（对应SK）、字段Key（默认为access_token，具体字段需参考百度云API文档查询）、所要添加的位置
-
-
HTTP Headers：类型自动对应请求Body中所选中类别
- application/x-www-form-urlencoded
- application/JSON
- multipart/form-data
-
请求body：
- 字段key：将用于参数接口的唯一标识
- 字段名称：将用于前端界面渲染
- 字段说明：将用于让大模型判断该如何抽取该参数信息，请用一句话清晰说明
- 字段类型：支持OpenAPI 3.0的数据类型
-
支持格式：
- form-data
- x-www-form-urlencoded
- JSON（填写JSON Schema定义参数key、描述、名称等）
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "number",
"minimum": 0
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string"
},
"city": {
"type": "string"
}
},
"required": ["street", "city"]
}
},
"required": ["name", "age", "address"]
}-
接口请求测试：用于测试该接口是否能成功调用
- 样本数据：支持将填写的测试数据保存为样本数据，后续测试可以直接应用
3. 使用文档
设置使用文档让开发者了解您接入的工具具体包含的功能以及使用方式。
方式二：上传OpenAPI Yaml文件
如您的工具涉及到复杂的嵌套参数，可直接上传编辑好的符合OpenAPI规范的Yaml文件，上传后，我们将自动为您解析功能及参数。
点击下载示例文件。
如您对参数有进一步调整的需求，可以继续手动在表单中调整后测试并保存。
发布工具
您可以将工具发布至工具中心，点击【发布】按钮后，需等待1~3个工作日，我们将审核您的工具内容是否合规，通过后，您的工具将出现在工具中心供其他用户调用。