通过

使用 Microsoft 365 Agents Playground 调试 AI 聊天机器人

使用 Teams AI 聊天机器人应用开始Microsoft Teams 应用开发，并使用 Microsoft 365 Agents Playground (以前称为 Teams 应用测试工具) 进行调试。 Agents Playground 使调试基于机器人的应用变得轻松。 无需Microsoft 365 开发人员帐户、隧道或 Teams 应用和机器人注册即可使用 Agents Playground。

你可以与机器人聊天，并在 Teams 中查看消息和自适应卡片。 还可以使用活动触发器在 Agents Playground 中模拟活动。

注意

  • 代理演练仅在 Microsoft 365 代理工具包的 v5.4.0 中可用， (以前称为 Teams 工具包) 。
  • 仅桌面和 Web 客户端支持 Agents Playground。

本分步指南可帮助你使用代理工具包生成 AI 聊天机器人，并使用测试工具进行调试。 完成本指南后，你将看到以下输出，用户可以在其中访问和使用 AI 聊天机器人：

屏幕截图显示了在测试工具中打开的机器人。

先决条件

确保安装以下用于生成和部署应用的工具。
安装 用于使用...
Visual Studio Code或 Visual Studio JavaScript、TypeScript 或 C# 生成环境。 使用最新版本。
Microsoft 365 代理工具包 Microsoft Visual Studio Code扩展，用于为应用创建项目基架。 使用代理工具包 v5.4.0。 有关详细信息，请参阅 安装代理工具包。
Node.js 后端 JavaScript 运行时环境。 有关详细信息，请参阅 项目类型的Node.js 版本兼容性表。
OpenAI 或 Azure OpenAI 首先创建 OpenAI API 密钥以使用 OpenAI 的 GPT。 如果要在 Azure 中托管应用或访问资源，则必须创建Azure OpenAI 服务。
Microsoft Edge（推荐）或 Google Chrome 包含开发人员工具的浏览器。

为 AI 聊天机器人应用创建项目工作区

让我们创建 AI 聊天机器人应用。

Teams 应用的机器人功能可创建聊天机器人或对话机器人。 它与 Web 服务通信，促进其服务的使用。 机器人可以执行简单的自动化任务，例如交付客户服务。 可以获取天气预报、进行预订或使用对话机器人提供的任何其他服务。

屏幕截图显示了具有三个功能的应用。突出显示了机器人。

由于已准备好创建这些应用，因此可以设置用于创建 AI 聊天机器人应用的新 Teams 项目。

在本教程中，了解：

  1. 创建机器人项目工作区。
  2. 浏览机器人应用源代码。

创建机器人项目工作区

如果先决条件已到位，让我们开始吧！

  1. 打开 Visual Studio Code。

  2. 在Visual Studio Code活动栏中选择“Microsoft 365 代理工具包”图标。

  3. 选择 “创建新代理/应用”。

    屏幕截图显示了代理工具包边栏中“创建新项目”链接的位置。

  4. 选择“Teams> 代理Azure OpenAI> 立即输入输入Azure API 服务密钥

    显示代理工具包应用模板的屏幕截图。

  5. 选择“ Teams 的基本代理”。 如果需要机器人的其他功能，请选择所需的选项。

    屏幕截图显示要添加到新应用的应用功能。

  6. 选择编程语言作为 JavaScript。

    屏幕截图显示了用于选择编程语言的选项。

  7. 选择“ 默认文件夹”。

    屏幕截图显示了默认位置的选择。

若要更改默认位置，请执行以下步骤：

  1. 选择“ 浏览”。

    屏幕截图显示了选择的浏览位置选项。

  2. 选择项目工作区的位置。

  3. 选择 “选择文件夹”。

    屏幕截图显示要选择的文件夹。

  4. 为应用输入合适的 名称，然后选择 Enter 键。

    屏幕截图显示输入应用名称的位置。

    此时会显示一个对话框，你需要选择“是”或“否”来信任此文件夹中文件的作者。

    屏幕截图显示了要信任或不信任此文件夹中文件的作者的对话框。

现在，已成功创建 AI 聊天机器人项目工作区。

我遇到了问题

浏览机器人应用源代码

完成基架搭建后，在Visual Studio Code的“资源管理器”部分中浏览项目目录和文件。

屏幕截图显示 Teams 工具包示例机器人文件夹结构。

文件夹或文件名 目录
env/.env.playground 包含可提交到 Git 的环境变量的配置文件。
env/.env.playground.user 包含环境变量（包括凭据）的配置文件，默认情况下不会提交到 Git。
appPackage 应用清单模板文件和应用图标 (color.png 和 outline.png) 。
appPackage/manifest.json 用于在本地和远程环境中运行应用的应用清单。
src/app.js 处理 AI 聊天机器人的业务逻辑。
m365agents.yml 这是代理工具包的主要项目文件。 项目文件定义了两个主要内容：属性和配置和阶段定义。
m365agents.local.yml 这将替代 m365agents.yml 启用本地执行和调试的作。
m365agents.playground.yml 这将替代 m365agents.yml 在测试工具中启用本地执行和调试的作。

返回页首

生成并运行 AI 聊天机器人应用

使用 Agents Toolkit 设置项目工作区后，生成 AI 聊天机器人项目。

为 AI 聊天机器人创建 Open AI 密钥和终结点

  1. 转到Azure 门户。

  2. 选择“创建资源”并搜索“Azure Open AI”。

  3. 选择“Azure打开 AI”，然后选择“创建”。

    屏幕截图显示了在 Azure 门户 中打开 AI Azure。

  4. 填写所需的详细信息，然后选择“ 下一步”。

    屏幕截图显示打开 AI 订阅和资源组Azure。

  5. 选择“ 所有网络（包括 Internet）都可以访问此资源 ”，然后选择“ 下一步”。

    屏幕截图显示打开 AI 网络Azure详细信息。

  6. 填写所需的详细信息，然后选择“ 下一步”。

    屏幕截图显示打开 AI 标记Azure详细信息。

  7. 选择“创建”。

    显示预览和创建Azure打开 AI 的屏幕截图。

已成功为 AI 聊天机器人创建密钥和终结点。

屏幕截图显示了Azure开放 AI 的部署。

注意

还可以获取 OpenAI API 密钥来调试 AI 聊天机器人。 有关详细信息，请参阅 设置 API 密钥。

我遇到了问题

获取 Azure Open AI 密钥和终结点

  1. 选择“ 转到资源”。

    显示开放 AI Azure部署的屏幕截图。

  2. 从左窗格中选择“ 密钥和终结点 ”，然后复制 “密钥 和 终结点”。 可以复制 KEY 1 或 KEY 2。

    屏幕截图显示了密钥和终结点。

    保存 KEY 和 终结点 以供进一步使用。

  3. 从左窗格中选择 “模型部署 ”，然后选择“ 管理部署”。

    屏幕截图显示Azure开放 AI 的模型部署。

    此时会显示Azure“打开 AI 工作室”窗口。

  4. 从左窗格中选择“ 部署 ”，然后选择“ + 创建新部署”。

    屏幕截图显示了Azure开放 AI 的模型部署。

  5. 选择以下详细信息：

  6. 从“选择模型”下拉列表中选择 gpt-35-turbo。

    注意

    AI 聊天机器人仅支持 gpt-35-turbo 模型。

  7. 从“模型版本”下拉列表中选择“0301 (默认) ”。

  8. 输入 “部署名称 ”，然后选择“ 创建”。

    屏幕截图显示Azure开放 AI 部署的模型和版本。

  9. 复制并保存 部署名称 以供进一步使用。

    屏幕截图显示Azure开放式 AI 部署的部署名称。

我遇到了问题

更新Azure Open AI 密钥和终结点

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

  2. 在“资源管理器”下，转到 env.env.playground.user> 文件。

  3. 输入 SECRET_AZURE_OPENAI_API_KEY 和 SECRET_AZURE_OPENAI_ENDPOINT。

    ...
SECRET_AZURE_OPENAI_API_KEY=<azure-openai-api-key>
SECRET_AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>

  4. 转到 src>app.js 文件。

  5. 注释 OpenAI 代码并取消注释 Azure OpenAI 代码。

  6. 在 中azureDefaultDeployment输入Azure Open AI 部署名称。

    ...
// Use OpenAI
// apiKey: config.openAIKey,
// defaultModel: "gpt-3.5-turbo",

azureApiKey: config.azureOpenAIKey,
azureDefaultDeployment: "gpt-35-turbo",
azureEndpoint: config.azureOpenAIEndpoint,
...

调试并运行 AI 聊天机器人应用

  1. 在左窗格中，选择“ 运行和调试 ” (Ctrl+Shift+D) ，然后从下拉列表中选择“ 在代理场中调试 ”。

    屏幕截图显示用于在“代理演练”中选择“调试”的选项。

  2. Agents Playground 在网页中打开 AI 聊天机器人。

    屏幕截图显示了在测试工具中打开的机器人。

我遇到了问题

返回页首

活动触发器

可以使用活动触发器在 Agents Playground 中模拟活动。

有两种类型的活动触发器：

  1. 预定义的活动触发器
  2. 自定义活动触发器

预定义的活动触发器

Agents Playground 提供预定义的活动触发器来测试机器人的功能。

类别 活动 处理程序
触发安装更新活动 安装机器人


卸载机器人		 onInstallationUpdate
onInstallationUpdateAdded

onInstallationUpdate
onInstallationUpdateRemove
触发对话更新活动 添加用户


添加机器人


添加通道		 onMembersAdded
onTeamsMembersAddedEvent

onMembersAdded
onTeamsMembersAddedEvent

onTeamsChannelCreatedEvent
删除用户


删除机器人


删除频道

删除团队		 onMembersRemoved
onTeamsMembersRemovedEvent

onMembersRemoved
onTeamsMembersRemovedEvent

onTeamsChannelDeletedEvent

onTeamsTeamDeletedEvent
重命名通道

重命名团队		 onTeamsChannelRenamedEvent

onTeamsTeamRenamedEvent

注意

并非所有范围都提供所有类型的活动。 例如，不能在个人聊天或群组聊天中添加或删除频道。

预定义的活动触发器可在代理场的 “模拟活动 ”菜单中使用。

若要模拟 “添加用户” 活动，请执行以下步骤：

  1. 在“代理演练”中，转到 模拟活动>添加用户。

    屏幕截图显示模拟活动下的“添加用户”选项。

    此时会显示一个对话框来预览活动处理程序。

  2. 选择“ 发送活动”。

    屏幕截图显示用于为预定义的模拟活动添加用户发送活动的选项。

    机器人发送以下响应：

    屏幕截图显示了预定义的模拟活动添加用户的响应。

我遇到了问题

自定义活动触发器

例如，可以使用 自定义活动 来自定义活动触发器， reactionsAdded 以满足机器人应用的要求。 Agents Playground 会自动填充活动的必需属性。 还可以修改活动类型并添加更多属性。

  1. 选择模拟 活动>自定义活动。

    屏幕截图显示模拟活动下的选项列表。

  2. 添加 messageReaction 以在 属性下 type 自定义活动：

    {
    "type": "messageReaction",
    "reactionsAdded": [
    {
        "type": "like"
    }
    ],
    "replyToId": "d60fd1cb-3e8f-44ef-849c-404806ba1b47"
}

  3. 选择“ 发送活动”。

    屏幕截图显示自定义模拟活动后发送活动的选项。

    机器人在响应中发送 onReactionsAdded 处理程序。

    屏幕截图显示了自定义模拟活动的响应。

我遇到了问题

返回页首

完成挑战

测试应用 你想出了这样的输出吗？

屏幕截图显示了在测试工具中打开的机器人。

恭喜！ 已成功创建 AI 聊天机器人应用。 现在，你已了解如何在 Agents Playground 中调试 AI 聊天机器人应用。

返回到 Microsoft 365 代理场

  • Last updated on