跳转到内容

基于已有服务创建插件

本文介绍如何通过插件页面向导创建自定义插件。创建插件后，必须发布插件才可以被 Bot 使用。

🎈

在个人空间下创建的插件，仅能被个人调用。
在团队空间下创建的插件，能被团队成员调用。
插件发布了新版本后，使用了这个插件的 Bot 会自动使用发布的最新版本。

操作步骤

登录扣子。
在左侧导航栏的工作区区域，选择进入指定团队。
在页面顶部进入插件页面，或者在某一 Bot 的编排页面，找到插件区域并单击 + 图标。
单击创建插件。
在新建插件对话框，根据以下信息完成配置并单击确认。

配置项	说明
插件图标	单击默认图标后，您可以上传本地图片文件作为新的图标。
插件名称	自定义插件名称，用于标识当前插件。建议输入清晰易理解的名称，便于大语言模型搜索与使用插件。
插件描述	插件的描述信息，一般用于记录当前插件的用途。
插件工具创建方式	选择基于已有服务创建。
插件 URL	插件的访问地址或相关资源的链接。例如：https://www.example.com/api
Header 列表	HTTP 请求头参数列表。您需要根据 API 自身的参数配置要求来填写。
授权方式	选择插件内 API 的鉴权方式。目前支持以下三种：不需要授权 Service：服务认证，该认证方式是指 API 通过秘钥或令牌校验合法性。位置：选择秘钥或令牌的传递位置，Header（请求头）或是 Query （查询参数）内。 Parameter name：秘钥或令牌对应的参数名称。 Service token / API key：秘钥或令牌的值。后续根据该值进行服务认证。 Oauth > 标准模式：OAuth 是一种常用于用户代理身份验证的标准，它允许第三方应用程序在不共享用户密码的情况下访问用户下的特定资源。 client_id：注册 OAuth 后获取的唯一标识符。 client_secret：与 client_id 匹配的密码。 client_url：验证通过后，模型会重定向到该 url。 scope：您的应用需要访问的资源范围或级别。 authorization_url：OAuth 提供商的 URL，用户会重定向到该 URL 进行应用授权。 authorization_content_type：向 OAuth 提供商发送数据时的内容类型。

在已创建的插件页面，单击创建工具。
在填写基本信息界面，完成配置并单击保存并继续。

配置项	说明
工具名称	用于标识当前工具。建议输入清晰易理解的名称，便于后续大语言模型搜索与使用工具。
工具描述	工具的描述信息，一般用于记录当前工具的用途。
工具路径	输入 API 路径。如果 API 没有路径，直接填写 / 作为路径。如果您需要在 API 的请求路径内插入变量，可以使用大括号 {} 包裹变量名作为占位符，例如 https://www.example.com/api/{id}/getTime。此外，在后续添加输入参数时，您需要新增一个和变量名相同的输入参数，并将参数的传入方法设置为 Path。
Request Method	选择 API 的请求方式。

在配置输入参数界面，单击新增参数添加输入参数，并单击保存并继续。

🎈

如果 API 没有输入参数，则直接单击保存并继续。

配置项	说明
参数名称	参数名称，支持字母、数字或下划线。
参数描述	参数描述。准确的参数描述可以帮助用户或 LLM 理解当前参数的作用。
参数类型	参数的数据类型。
传入方法	参数传入方法。可选值： Body：请求参数 Path：路径参数 Query：查询参数 Header：请求头参数
是否必填	参数是否必填。打开开关表示当前参数为必填参数。关闭开关表示当前参数为选填参数。

在配置输出参数界面，设置输出参数，并单击保存并继续。

您可以单击自动解析，在对话框内填写输入参数调用 API，平台将会根据 API 响应结果自动配置输出参数。您也可以单击新增参数，手动设置输出参数。

配置项	说明
参数名称	参数名称，支持字母、数字或下划线。参数名称
参数描述	参数描述。准确的参数描述可以帮助用户或 LLM 理解当前参数的作用。
参数类型	参数的数据类型。
是否必填	参数是否必须输出。打开开关表示当前参数为必须输出的参数。关闭开关表示当前参数为可选输出的参数。
新增子项	当参数类型选择 Object 类型时，该配置项会显示加号（+）图标。单击加号图标可在当前 Object 参数内添加子参数。

在调试与校验界面，填写输入参数，并单击运行。
在页面右侧，查看调试结果为绿色标识的调试通过后，单击完成。

在插件详情页的右上角，单击发布。

上架到商店

您可以将创建的插件发布到扣子商店，让更多扣子用户发现、使用您的插件。详情请参考将插件上架到商店。