1

插件介绍

什么是插件？

插件是一个工具集，一个插件内可以包含一个或多个工具（API）。 目前，Coze 集成了超过 60 种类型的插件，包括资讯阅读、旅游出行、效率办公、图片理解等 API 及多模态模型。使用这些插件，可以帮助你拓展 Bot 能力边界。例如，在你的 Bot 内添加新闻搜索插件，那么你的 Bot 将拥有搜索新闻资讯的能力。 如果 Coze 集成的插件不满足你的使用需求，你还可以创建自定义插件来集成需要使用的 API。

使用场景

插件可以直接在 Bot 内使用，拓展 Bot 的能力边界。插件也可以作为节点添加到工作流，实现工作流的任务处理能力。

Last updated: 2024/2/26 10:58

2

创建插件

你可以创建自定义插件来集成自己的 API。插件只有发布后，才可以被 Bot 使用。
  • 在 Personal 空间下创建的插件，仅能被个人调用。
  • 在团队空间下创建的插件，能被团队成员调用。
  • 插件发布了新版本后，使用了这个插件的 Bot 会自动使用发布的最新版本。

通过向导创建插件

  1. 登录 Coze。
  2. 在左侧导航栏的 My Workspace 区域，选择进入指定团队。
  3. 在页面顶部进入 Plugins 页面，或进入 Bot 编排页面，在 Plugins 区域单击 +。
  4. 单击 Create plugin。
  5. 在 Create Plugin 对话框，完成配置并单击 Confirm。
配置项 说明
插件图标 单击默认图标后，你可以上传本地图片文件作为新的图标。
Plugin name 自定义插件名称，用于标识当前插件。建议输入清晰易理解的名称，Bot 的大语言模型会根据插件名称来判断是否使用该插件。
Plugin description 插件的描述信息，一般用于记录当前插件的用途。
API URL 插件的访问地址或相关资源的链接。例如：https://www.example.com/api
Header List HTTP 请求头参数列表。你需要根据 API 自身的参数配置要求来填写。
Authorization method 选择插件内 API 的鉴权方式。目前支持以下三种： No authorization：无需鉴权。 Service：服务认证，该认证方式是指 API 通过秘钥或令牌校验合法性。 Location：选择秘钥或令牌的传递位置，Header（请求头）或是 Query （查询参数）内。 Parameter name：秘钥或令牌对应的参数名称。 Service token / API key：秘钥或令牌的值。后续根据该值进行服务认证。 Oauth > standard：OAuth 是一种常用于用户代理身份验证的标准，它允许第三方应用程序在不共享用户密码的情况下访问用户下的特定资源。 client_id：注册 OAuth 后获取的唯一标识符。 client_secret：与 client_id 匹配的密码。 client_url：验证通过后，模型会重定向到该 url。 scope：你的应用需要访问的资源范围或级别。 authorization_url：OAuth 提供商的 URL，用户会重定向到该 URL 进行应用授权。 authorization_content_type：向 OAuth 提供商发送数据时的内容类型。
  1. 在已创建的 Plugins 页面，单击 Create tool。
  2. 在 Basic information 界面，完成配置并单击 Save and continue。
配置项 说明
Tool name 工具名称，用于标识当前工具。建议输入清晰易理解的名称，Bot 的大语言模型会根据插件名称来判断是否使用该插件。
Tool description 工具的描述信息，一般用于记录当前工具的用途。
Tool path 工具对应的完整 API 请求路径。前半段默认为创建插件时设置的 API URL，你需要在后半段输入框内补全 API 请求路径。 路径填写说明： 如果你的 API 没有具体的路径，只有域名，则你可以在 Tool path 内填写 / 作为路径。这样工具会向插件内已设置好的 API URL 发送请求。 如果你需要在 API 的请求路径内插入变量（例如设置路径参数），可以使用大括号 {} 包裹变量名作为占位符，例如 https://www.example.com/api/{id}/getTime。此外，在后续添加输入参数时，你需要新增一个和变量名相同的输入参数，并将参数的 Method 设置为 Path。
Request Method API 的请求方式，你需要根据 API 的实际情况选择正确的请求方式。
  1. 在 Input parameters 界面，选择添加输入参数，并单击 Save and continue。如果 API 没有输入参数，则这里也无需添加输入参数。
配置项 说明
Parameter name 参数名称，支持字母、数字或下划线。
Parameter description 参数描述。准确的参数描述可以帮助用户或 LLM 理解当前参数的作用。
Parameter type 参数类型。可选值：
Method 参数传入方法。可选值： Body：请求参数 Path：路径参数 Query：查询参数 Header：请求头参数
Required 参数是否必填。 打开开关表示当前参数为必填参数。 关闭开关表示当前参数为选填参数。
Add subitem 当 Parameter type 选择 Object 类型时，该配置项会显示加号（+）图标。单击加号图标可在当前 Object 参数内添加子参数。
  1. 在 Output parameters 界面，设置输出参数，并单击 Save and continue。你可以单击 Auto parse，在对话框内填写输入参数调用 API，平台将会根据 API 响应结果自动配置输出参数。你也可以单击 Add parameter，手动设置输出参数。
配置项 说明
Parameter name 参数名称，支持字母、数字或下划线。参数名称
Parameter description 参数描述。准确的参数描述可以帮助用户或 LLM 理解当前参数的作用。
Parameter type 参数类型。
Required 参数是否必须输出。 打开开关表示当前参数为必须输出的参数。 关闭开关表示当前参数为可选输出的参数。
Add subitem 当 Parameter type 选择 Object 类型时，该配置项会显示加号（+）图标。单击加号图标可在当前 Object 参数内添加子参数。
  1. 在 Debug 界面，填写输入参数，并单击 Run。
  2. 在页面右侧，待调试成功后，单击 Done。如果 API 调用失败，根据错误信息修改 API 配置，直至 API 调试成功。

插件 - 图1

  1. 在插件详情页的右上角，单击 Publish。

使用代码注册插件

Coze 提供了代码解析器，支持解析 API 配置文件来创建插件。
  1. 登录 Coze。
  2. 在左侧导航栏的 My Workspace 区域，选择进入指定团队。
  3. 在页面顶部进入 Plugins 页面，并在右上角单击代码图标。插件 - 图2
  4. 填写配置项，并单击 Confirm。 1. 输入 API 的验证信息。 如果 API 使用 OAuth 身份验证，请提供对应的 client ID 和 client secret。 如果 API 使用服务身份验证，输入服务令牌以获得 API 访问权限。 * 如果 API 不需要身份验证，则无需填写 client_id, client_secret 和 service_token。 2. 在左侧面板中以 JSON 格式填入插件的配置信息。 3. 在右侧面板中以 YAML 格式填入 API 的配置信息。
  5. 在 Plugins 页面，单击插件进入详情页。插件 - 图3
  6. 查看 Tools 列表，在 Action 列单击调试图标。插件 - 图4
  7. 检查工具配置，在 Debug 页面，输入请求参数，然后单击 Run 查看工具是否可以成功调用。
  8. 如果工具调用成功，单击 Done。如果 API 调用失败，根据错误信息修改 API 配置，直至 API 调试成功。插件 - 图5
  9. 单击 Publish。

Last updated: 2024/2/26 10:58

3

使用插件

插件可以直接在 Bot 内使用，拓展 Bot 的能力边界。插件也可以作为节点添加到工作流，执行一个操作。

在 Bot 内使用插件

无论是 Coze 内置插件还是你创建的自定义插件，都可以添加到 Bot 内，扩展 Bot 的能力。
  1. 登录 Coze。
  2. 在左侧导航栏的 My Workspace 区域，选择进入指定团队。
  3. 在 Bots 页面，选择指定 Bot。
  4. 在 Bot 编排页面的 Plugins 区域，单击 + 图标添加插件，或者单击自动添加图标，让大语言模型自动添加适用的插件。使用大语言模型自动添加插件后，你需要检查被添加的插件是否可以正常使用。
  5. 在 Add Plugin 页面，展开目标插件查看工具，然后单击 Add。单击 My Tools，可查看当前团队下可用的插件。
  6. 在 Bot 的 Persona & Prompt 区域，定义插件的具体使用场景，然后在 Preview 区域测试插件功能是否符合预期。

在工作流中使用插件节点

Coze 支持你在工作流的 Plugins 列表中，选用插件节点。更多信息，请参考使用工作流。

插件 - 图6

Last updated: 2024/2/26 10:58