从现有 API 生成 api 插件,用于智能 Microsoft 365 Copilot 副驾驶®

重要

API 插件仅支持作为 声明性代理中的作。 智能 Microsoft 365 Copilot 副驾驶®中未启用它们。

API 插件将现有 REST API 连接到智能 Microsoft 365 Copilot 副驾驶®。 可以使用 Microsoft 365 Agents Toolkit (Teams 工具包) 的演变 ,从具有 OpenAPI 规范的现有 REST API 生成插件。

先决条件

提示

为了获得最佳结果,请确保 OpenAPI 规范遵循 如何使 OpenAPI 文档在扩展 Copilot 时有效中详述的准则。

若要遵循本指南,请下载 预算跟踪器示例 API 并将其配置为在本地开发计算机上运行。 至少生成一次示例,以生成 API 的 BudgetTracker.json 文件。

创建插件

注意

Microsoft 365 Agents Toolkit 的屏幕截图和对用户界面的引用 (本文档中 Teams 工具包) 的演变是 使用最新版本 6.0 生成的。 代理工具包的预发行版本可能与本文档中的用户界面不同。

API 插件是包含以下文件的 ZIP 文件。

  • REST API 的 OpenAPI 规范。
  • 一个 API 插件清单 ,它引用了包含的 OpenAPI 规范,并描述了可用的作、身份验证方法和响应格式。
  1. 打开 Visual Studio Code。 如果尚未安装代理工具包,请参阅 安装代理工具包 以获取安装说明。

  2. 选择左侧活动栏中 的“Microsoft 365 代理工具包 ”图标。

  3. 在“代理工具包”任务窗格中 选择“创建新代理/应用 ”。

    代理工具包界面的屏幕截图

  4. 选择“ 声明性代理”。

  5. 选择“ 添加作”,然后选择“ 使用 OpenAPI 说明文档开始”。

  6. 从预算跟踪器示例中选择“ 浏览 ”并浏览到 OpenAPI 规范的位置,该位置位于 ./openapi/BudgetTracker.json

  7. 选择要为插件启用的所有作。

    用于选择作的代理工具包 UI

  8. 选择 API 插件项目的位置。

  9. 输入 Budget Tracker 作为插件的名称。

完成这些步骤后,Agents Toolkit 将生成插件所需的文件,并打开加载插件项目的新Visual Studio Code窗口。

注意

如果标识服务器需要代码交换 (PKCE) 的证明密钥,请在 API 插件项目中取消注释 m365agents.yml 中的以下行。

# isPKCEEnabled: true

打包并旁加载插件

  1. 在 Visual Studio Code 中打开插件项目。

  2. 选择左侧活动栏中 的“Microsoft 365 代理工具包 ”图标。

  3. 在“ 帐户 ”窗格中,选择“ 登录到 Microsoft 365”。 (如果已登录,请继续执行下一步) 。

  4. 确认“ 已启用自定义应用上传”“已启用 Copilot 访问” 显示在 Microsoft 365 帐户下。 如果没有,请与组织管理员检查。有关详细信息,请参阅 Copilot 扩展性选项的要求

  5. 在“ 生命周期 ”窗格中,选择“ 预配”。

  6. 当系统要求 输入 OAuth 注册的客户端 ID 时,请输入 插件客户端 ID

  7. 当系统要求 输入用于 OAuth 注册的客户端密码时,请输入 插件客户端密码

  8. 阅读对话框中的消息,然后选择“ 确认 ”以继续。

  9. 等待工具包报告已完成预配。

    确认预配成功的代理工具包消息

现在,可以使用 Microsoft Teams 智能 Microsoft 365 Copilot 副驾驶® 中的用户帐户测试插件。

使用插件

  1. 在浏览器中打开 Teams,并使用用于上传插件的 Microsoft 365 帐户登录。

  2. 在左侧活动栏中选择“ 聊天 ”。

  3. “聊天”窗格中选择“Copilot”。

  4. 在右侧的“代理”列表中选择“ 预算跟踪器 ”。 如果列表不可用,请选择右上角的 Copilot 聊天和更多 图标。

    Microsoft Teams 中的代理列表的屏幕截图

  5. 询问有关预算的问题。 例如,请尝试 How much is left in the Fourth Coffee lobby renovation budget?。 出现提示时,选择“ 始终允许”“允许一次 ”继续作。

  6. 当系统要求登录时,请选择“ 登录到预算跟踪器”。