通过

Teams AI 库快速入门指南

  • 项目

使用 LightBot 示例开始使用 Teams AI 库，该示例旨在帮助你完成创建可控制灯光的应用的过程，例如使用 Teams AI 库打开和关闭它们。 机器人使用 gpt-3.5-turbo 模型与Microsoft Teams 用户聊天，并以礼貌和尊重的方式做出响应，保持在对话范围内。

先决条件

若要开始，请确保具有以下工具：

安装 用于使用...
Visual Studio Code JavaScript、TypeScript 和 Python 生成环境。 使用最新版本。
Teams 工具包 Microsoft Visual Studio Code扩展，用于为应用创建项目基架。 使用最新版本。
Git Git 是一种版本控制系统，可帮助你管理存储库中不同版本的代码。
Node.js 后端 JavaScript 运行时环境。 有关详细信息，请参阅 项目类型的Node.js 版本兼容性表。
Microsoft Teams 若要与每个人协作，可以在一个位置通过聊天、会议和通话应用与他们协作。
OpenAI 或 Azure OpenAI 首先创建 OpenAI API 密钥以使用 OpenAI 的 GPT。 如果要在 Azure Microsoft托管应用或访问资源，则必须创建 Azure OpenAI 服务。
Microsoft Edge（推荐）或 Google Chrome 包含开发人员工具的浏览器。
Microsoft 365 开发人员帐户 具有安装应用、 启用自定义 Teams 应用和启用自定义应用上传的适当权限的 Teams 帐户的访问权限。

如果已在运行示例之前或遇到运行时错误，请按照以下步骤重新开始操作：
  • 检查示例中的所有 .env 和 env/.env.*.* 文件，并删除任何自动填充的值，以确保 Teams 工具包为你生成新资源。
  • 如果不希望 Teams 工具包生成应用 ID 和密码，请使用自己的值更新 BOT_ID 文件中的 和 BOT_PASSWORD.env 。
  • 为文件中SECRET_BOT_PASSWORD和TEAMS_APP_UPDATE_TIME.env删除值或将值留空，以避免冲突。

Teams 工具包会自动预配 BOT_ID 和资源 BOT_PASSWORD 。 若要使用自己的资源，需要手动将它们添加到 .env 文件中。 Teams 工具包不会自动生成以下资源：

  • Azure OpenAI 或 OpenAI 密钥
  • 数据库或类似的存储选项

生成并运行示例应用

使用 LightBot 示例开始使用 Teams AI 库。 它使计算机的 localhost 能够快速执行基于 Teams AI 库的示例。

  1. 转到 示例。

  2. 运行以下命令以克隆存储库：

    git clone https://github.com/microsoft/teams-ai.git

  3. 转到Visual Studio Code。

  4. 选择“ 文件>打开文件夹”。

  5. 转到克隆 teams-ai 存储库的位置，然后选择 teams-ai 文件夹。

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

    屏幕截图显示 teams-ai 文件夹和“选择文件夹”选项。

  7. 选择“ 查看>终端”。 此时将打开终端窗口。

  8. 在终端窗口中，运行以下命令以转到 js 文件夹：

    cd .\js\

  9. 运行以下命令以安装依赖项：

    yarn install

  10. 运行以下命令以生成依赖项：

    yarn build

  11. 安装依赖项后，选择“ 文件>打开文件夹”。

  12. 转到 teams-ai > js > 示例> 03.ai-concepts> c.actionMapping-lightBot ，然后选择 “选择文件夹”。 LightBot 示例的所有文件都列在 Visual Studio Code 的 EXPLORER 部分下。

  13. 根据所选的 AI 服务更新以下步骤。

    1. 转到 文件夹并 env 更新 文件中的以下代码 ./env/.env.local.user ：

       SECRET_OPENAI_KEY=<your OpenAI key>

    2. 转到 infra 文件夹，并确保文件中的以下行 azure.bicep 已注释掉：

          // {
    //   name: 'AZURE_OPENAI_KEY'
    //   value: azureOpenAIKey
    // }
    // {
    //   name: 'AZURE_OPENAI_ENDPOINT'
    //   value: azureOpenAIEndpoint
    // }

  14. 在左窗格中，选择“ Teams 工具包”。

  15. 在 “帐户”下，登录到以下内容：

    • Microsoft 365 账户
    • Azure 帐户

  16. 若要调试应用，请选择 F5。

    浏览器选项卡将打开 Teams Web 客户端，以将机器人添加到租户。

  17. 选择“添加”。

    用于添加 LightBot 应用的应用详细信息对话框的屏幕截图。

    添加应用后，将显示用于选择所需范围的对话框。

  18. 选择“ 打开 ”以在个人范围内打开应用。

    或者，可以搜索并选择所需的范围，或者从列表中选择频道、聊天或会议，然后在对话框中移动以选择“ 转到”。

    “范围选择”对话框的屏幕截图，其中包含共享范围的列表。

    此时会打开聊天窗口。

  19. 在消息撰写区域中，发送消息以调用机器人。

    屏幕截图显示了 LightBot 输出的示例。

注意

如果是首次生成机器人，建议使用适用于 Visual Studio Code 的 Teams 工具包扩展来生成机器人，请参阅使用 JavaScript 生成第一个机器人应用。

先决条件

若要开始，请确保具有以下工具：

安装 用于使用...
Visual Studio C Sharp 生成环境。 使用最新版本。
Teams 工具包 Microsoft Visual Studio Code扩展，用于为应用创建项目基架。 使用最新版本。
Git Git 是一种版本控制系统，可帮助你管理存储库中不同版本的代码。
Microsoft Teams 若要与每个人协作，可以在一个位置通过用于聊天、会议和通话的应用与他们协作。
OpenAI 或 Azure OpenAI 首先创建 OpenAI API 密钥以使用 OpenAI 的 GPT。 如果要在 Azure Microsoft托管应用或访问资源，则必须创建 Azure OpenAI 服务。
Microsoft Edge（推荐）或 Google Chrome 包含开发人员工具的浏览器。
Microsoft 365 开发人员帐户 具有安装应用、 启用自定义 Teams 应用和启用自定义应用上传的适当权限的 Teams 帐户的访问权限。

如果已在运行示例之前或遇到运行时错误，请按照以下步骤重新开始操作：
  • 检查示例中的所有 .env 和 env/.env.*.* 文件，并删除任何自动填充的值，以确保 Teams 工具包为你生成新资源。
  • 如果不希望 Teams 工具包生成应用 ID 和密码，请使用自己的值更新 MicrosoftAppId 文件中的 和 MicrosoftAppPassword.env 。
  • 为文件中SECRET_BOT_PASSWORD和TEAMS_APP_UPDATE_TIME.env删除值或将值留空，以避免冲突。

Teams 工具包会自动预配 MicrosoftAppId 和资源 MicrosoftAppPassword 。 若要使用自己的资源，需要手动将它们添加到 .env 文件中。 Teams 工具包不会自动生成以下资源：

  • Azure OpenAI 或 OpenAI 密钥
  • 数据库或类似的存储选项

生成并运行示例应用

  1. 转到 示例。

  2. 克隆存储库以测试示例应用。

    git clone https://github.com/microsoft/teams-ai.git

  3. 转到 dotnet 文件夹。

    cd teams-ai/dotnet

  4. 转到克隆存储库的文件夹，然后选择 04.ai.c.actionMapping.lightBot。

  5. 选择 “LightBot.sln”。 解决方案将在 Visual Studio 中打开。

  6. 在 Visual Studio 中 appsettings.Development.json ，更新 文件中与 OpenAI 相关的设置。

    "Azure": {
"OpenAIApiKey": "<your-azure-openai-api-key>",
"OpenAIEndpoint": "<your-azure-openai-endpoint>"
},

  7. 转到 Prompts/sequence/skprompt.txt 并更新 文件中的以下代码 skprompt.txt ：

    The following is a conversation with an AI assistant. 
The assistant can turn a light on or off.
The assistant must return the following JSON structure:

{"type":"plan","commands":[{"type":"DO","action":"<name>","entities":{"<name>":<value>}},{"type":"SAY","response":"<response>"}]}

The following actions are supported:

- LightsOn
- LightsOff
- Pause time=<duration in ms>
- LightStatus

The lights are currently {{getLightStatus}}.

Always respond in the form of a JSON based plan. Stick with DO/SAY.

  8. 在调试下拉菜单中，选择“开发隧道>创建隧道”。

    屏幕截图显示了 Visual Studio 中的“开发隧道”和“创建隧道”选项的示例。

  9. 选择用于创建隧道的 帐户 。 支持 Azure、Microsoft 帐户 (MSA) 和 GitHub 帐户。 更新以下选项：

    1. 名称：输入隧道的名称。
    2. 隧道类型：选择 “持久 ”或“ 临时”。
    3. 访问：选择“ 公共”。
    4. 选择“确定”。 Visual Studio 显示一条确认消息，指示已创建隧道。

    创建的隧道列在 开发隧道 > 下， (隧道) 的名称 。

  10. 转到解决方案资源管理器并选择项目。

  11. 右键单击菜单，然后选择 “Teams 工具包>准备 Teams 应用依赖项”。

    屏幕截图显示了 Visual Studio 中 Teams 工具包部分下的“已准备的 Teams 应用依赖项”选项的示例。

    如果出现提示，请登录到 Microsoft 365 帐户。 你会收到一条消息，指示已成功准备 Teams 应用依赖项。

  12. 选择“确定”。

  13. 选择 F5 或选择 调试>开始。

  14. 选择“ 添加 ”，将机器人添加到租户。

    用于添加 LightBot 应用的应用详细信息对话框的屏幕截图。

    添加应用后，将显示用于选择所需范围的对话框。

  15. 选择“ 打开 ”以在个人范围内打开应用。

    或者，可以搜索并选择所需的范围，或者从列表中选择频道、聊天或会议，然后在对话框中移动以选择“ 转到”。

    “范围选择”对话框的屏幕截图，其中包含共享范围的列表。

    此时会打开聊天窗口。

  16. 在消息撰写区域中，发送消息以调用机器人。

    屏幕截图显示了 LightBot 输出的示例。

还可以使用 Teams 工具包将示例部署到 Azure。 若要部署，请执行以下步骤：

  1. 在 Visual Studio 中，转到解决方案资源管理器并选择项目。
  2. 右键单击菜单，然后选择“云中的Teams 工具包>预配”。 工具包将示例预配到 Azure。
  3. 右键单击菜单，然后选择“Teams 工具包>部署到云”。

先决条件

若要开始，请确保具有以下工具：

安装 用于使用...
Visual Studio Code JavaScript、TypeScript 和 Python 生成环境。 使用最新版本。
Teams 工具包 Microsoft Visual Studio Code扩展，用于为应用创建项目基架。 使用最新版本。
Python Python 是一种具有动态语义的面向对象的解释编程语言。 使用 3.8 到 4.0 之间的版本。
诗歌 Python 的依赖项管理和打包工具。
Python VSCode 扩展 为 VSCode 上的 Python 提供丰富的支持。
Git Git 是一种版本控制系统，可帮助你管理存储库中不同版本的代码。
Microsoft Teams 若要与每个人协作，可以在一个位置通过用于聊天、会议和通话的应用与他们协作。
OpenAI 或 Azure OpenAI 首先创建 OpenAI API 密钥以使用 OpenAI 的 GPT。 如果要在 Azure Microsoft托管应用或访问资源，则必须创建 Azure OpenAI 服务。
Microsoft Edge（推荐）或 Google Chrome 包含开发人员工具的浏览器。
Microsoft 365 开发人员帐户 具有安装应用、 启用自定义 Teams 应用和启用自定义应用上传的适当权限的 Teams 帐户的访问权限。

如果已在运行示例之前或遇到运行时错误，请按照以下步骤重新开始操作：
  • 检查示例中的所有 .env 和 env/.env.*.* 文件，并删除任何自动填充的值，以确保 Teams 工具包为你生成新资源。
  • 如果不希望 Teams 工具包生成应用 ID 和密码，请使用自己的值更新 BOT_ID 文件中的 和 BOT_PASSWORD.env 。
  • 为文件中SECRET_BOT_PASSWORD和TEAMS_APP_UPDATE_TIME.env删除值或将值留空，以避免冲突。

Teams 工具包会自动预配 BOT_ID 和资源 BOT_PASSWORD 。 若要使用自己的资源，需要手动将它们添加到 .env 文件中。 Teams 工具包不会自动生成以下资源：

  • Azure OpenAI 或 OpenAI 密钥
  • 数据库或类似的存储选项

生成并运行示例应用

  1. 转到 示例。

  2. 克隆存储库以测试示例应用。

    git clone https://github.com/microsoft/teams-ai.git

  3. 转到 python 文件夹。

    cd teams-ai/python

  4. 转到克隆存储库的文件夹，然后选择 04.ai.c.actionMapping.lightBot。 LightBot 示例的所有文件都列在 Visual Studio Code 的 EXPLORER 部分下。

  5. 在 “资源管理器”下，复制 sample.env 文件并将重复文件更新为 .env。

    转到 文件夹并 env 更新 文件中的以下代码 ./env/.env.local.user ：

    SECRET_OPENAI_KEY=<your OpenAI key>

  6. 若要安装以下依赖项，请转到 “查看>终端” 并运行以下命令：

    相关性 命令
    python-dotenv pip install python-dotenv
    load-dotenv pip install load-dotenv
    teams-ai pip install teams-ai
    botbuilder-core pip install botbuilder-core

  7. 使用模型部署名称更新 config.json 和 bot.py 。

  8. 转到 “查看>命令面板...” 或选择 Ctrl+Shift+P。

  9. 输入 “Python：创建环境 ”以创建虚拟环境。

  10. 若要调试应用，请选择 F5。

    浏览器选项卡将打开 Teams Web 客户端，以将机器人添加到租户。

  11. 选择“添加”。

    用于添加 LightBot 应用的应用详细信息对话框的屏幕截图。

    添加应用后，将显示用于选择所需范围的对话框。

  12. 选择“ 打开 ”以在个人范围内打开应用。

    或者，可以搜索并选择所需的范围，或者从列表中选择频道、聊天或会议，然后在对话框中移动以选择“ 转到”。

    “范围选择”对话框的屏幕截图，其中包含共享范围的列表。

    此时会打开聊天窗口。

  13. 在消息撰写区域中，发送消息以调用机器人。

    屏幕截图显示了 LightBot 输出的示例。

其他工具

还可以使用以下工具来运行和设置示例：

  1. Teams 工具包 CLI：可以使用 Teams 工具包 CLI 从命令行创建和管理 Teams 应用。 有关详细信息，请参阅 Teams 工具包 CLI 设置说明。

  2. Bot Framework Emulator：Bot Framework Emulator是一个桌面应用程序，可用于在本地测试和调试机器人。 可以通过输入机器人的终结点 URL 和Microsoft应用 ID 和密码来连接到机器人。 然后，可以向机器人发送消息并实时查看其响应。 有关详细信息，请参阅Bot Framework Emulator设置说明。

  3. 手动设置：如果希望手动设置资源，可以按照相应服务提供的说明进行操作。 有关详细信息，请参阅 手动设置说明。

后续步骤

选择以下选项之一作为下一步：

若要了解如何使用 Teams AI 库创建 AI 支持的机器人，请选择以下项：
使用 Teams AI 库进行生成

如果要使用 Teams 工具包生成自定义引擎代理，请选择以下项：
生成自定义引擎代理