Краткое руководство по использованию API помощников с библиотекой ИИ Teams

Начало работы с API OpenAI или Azure OpenAI Assistants с библиотекой ИИ Teams в учебнике по математике помощник пример. В этом руководстве используется средство "Интерпретатор кода OpenAI" для создания помощник, специализирующегося на математике. Бот использует модель gpt-3.5-turbo, чтобы общаться с пользователями Microsoft Teams и реагировать вежливо и уважительно, оставаясь в область беседы.

Предварительные условия

Чтобы приступить к работе, убедитесь, что у вас есть следующие средства:

Установка	Для использования...
Visual Studio Code	Среды сборки JavaScript, TypeScript или C Sharp. Используйте последнюю версию.
Набор средств Teams	Расширение Microsoft Visual Studio Code, которое создает шаблон проекта для вашего приложения. Используйте последнюю версию.
Git	Git — это система управления версиями, которая помогает управлять различными версиями кода в репозитории.
Node.js	Серверной среды выполнения JavaScript. Дополнительные сведения см . вNode.js таблице совместимости версий для типа проекта.
Microsoft Teams	Для совместной работы со всеми пользователями вы работаете с помощью приложений для чата, собраний и звонков в одном месте.
OpenAI или Azure OpenAI	Сначала создайте ключ API OpenAI, чтобы использовать GPT OpenAI. Если вы хотите разместить приложение или получить доступ к ресурсам в Azure, необходимо создать службу Azure OpenAI.
Microsoft Edge (рекомендуется) или Google Chrome	Браузера со средствами разработчика.
Учетная запись разработчика Microsoft 365	Доступ к учетной записи Teams с соответствующими разрешениями для установки приложения, включения пользовательских приложений Teams и включения отправки пользовательских приложений.

Если вы уже выполняли примеры ранее или столкнулись с ошибкой среды выполнения, выполните следующие действия, чтобы начать заново:

• Проверьте все .env файлы и env/.env.*.* в примере и удалите автоматически заполненные значения, чтобы убедиться, что Набор средств Teams создает новые ресурсы.
• Если вы не хотите, чтобы Teams Toolkit создавал идентификатор и пароль приложения, обновите MicrosoftAppId и MicrosoftAppPassword в .env файле своими собственными значениями.
• Удалите значения или оставьте их пустыми для SECRET_BOT_PASSWORD и TEAMS_APP_UPDATE_TIME в .env файле, чтобы избежать конфликтов.

Набор средств Teams автоматически подготавливает ресурсы и MicrosoftAppPassword ресурсыMicrosoftAppId. Если вы хотите использовать собственные ресурсы, необходимо вручную добавить их в .env файл. Набор средств Teams не создает следующие ресурсы автоматически:

• Ключ Azure OpenAI или OpenAI
• База данных или аналогичные варианты хранения

Создание и запуск примера приложения

Начните работу с библиотекой ИИ Teams с помощью примера помощник учебника по математике. Это позволяет локальному хосту компьютера быстро выполнить пример на основе библиотеки ИИ Teams.

1. Перейдите к примеру.

2. Выполните следующую команду, чтобы клонировать репозиторий:

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

3. Перейдите к Visual Studio Code.

4. Выберите Файл>Открыть папку.

5. Перейдите в расположение, в котором вы клонировали репозиторий teams-ai, и выберите папку teams-ai .

6. Выберите Выбрать папку.

   

7. Выберите Просмотреть>терминал. Откроется окно терминала.

8. В окне терминала выполните следующую команду, чтобы перейти в папку js :

   cd .\js\
   

9. Выполните следующую команду, чтобы установить зависимости:

   yarn install
   

10. Выполните следующую команду, чтобы создать зависимости:

    yarn build
    

11. После установки зависимостей выберите Файл>Открыть папку.

12. Перейдите в teams-ai > js > samples > 04.ai-apps > d.assistants-mathBot и выберите Выбрать папку. Все файлы для примера преподавателя по математике помощник перечислены в разделе EXPLORER Visual Studio Code.

13. В обозревателе дублируйте sample.env файл и обновите его до .env.

14. Обновите следующие шаги на основе выбранной службы ИИ.

    Ключ OpenAI

    1. Перейдите в папку env и обновите следующий код в ./env/.env.local.user файле:

       SECRET_OPENAI_KEY=<your OpenAI key>
       ASSISTANT_ID=<your Assistant ID>
       

    2. Перейдите в папку infra и убедитесь, что следующие строки в azure.bicep файле закомментированы:

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

    Azure OpenAI

    1. Перейдите в папку env и обновите следующий код в ./env/.env.local.user файле:

       SECRET_AZURE_OPENAI_KEY=<your Azure OpenAI key>
       SECRET_AZURE_OPENAI_ENDPOINT=<your Azure OpenAI Endpoint>
    

    1. Перейдите в teamsapp.local.yml файл и измените последний шаг, чтобы использовать переменные Azure OpenAI:

       - uses: file/createOrUpdateEnvironmentFile
       with:
          target: ./.env
          envs:
          BOT_ID: ${{BOT_ID}}
          BOT_PASSWORD: ${{SECRET_BOT_PASSWORD}}
          #OPENAI_KEY: ${{SECRET_OPENAI_KEY}}
          AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}}
          AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}}
       

    2. Перейдите в папку infra и убедитесь, что следующие строки в azure.bicep файле закомментированы:

           // {
           //   name: 'OPENAI_KEY'
           //   value: openAIKey
           // }
       

    3. Перейдите к infra>azure.parameters.json и замените строки с 20 на 25 следующим кодом:

             "azureOpenAIKey": {
             "value": "${{SECRET_AZURE_OPENAI_KEY}}"
             },
             "azureOpenAIEndpoint": {
             "value": "${{SECRET_AZURE_OPENAI_ENDPOINT}}"
             }
       

15. Скопируйте пример в новый каталог, который не является подкаталогом teams-ai.

16. В левой области выберите Набор средств Teams.

17. В разделе УЧЕТНЫЕ ЗАПИСИ войдите в следующую команду:

    • Учетная запись Microsoft 365
    • Учетная запись Azure

18. Чтобы отладить приложение, выберите клавишу F5 .

    Вкладка браузера открывает веб-клиент Teams с запросом на добавление бота в клиент.

19. Нажмите Добавить.

    

    Откроется окно чата.

20. В области создания сообщения отправьте сообщение для вызова бота.

    

Примечание.

Если вы создаете бот впервые, рекомендуется использовать расширение Teams Toolkit для Visual Studio Code для создания бота. См. статью Создание первого приложения бота с помощью JavaScript.

Дополнительные средства

Для запуска и настройки примера можно также использовать следующие средства:

1. Teams Toolkit CLI. Вы можете использовать интерфейс командной строки набора средств Teams для создания приложений Microsoft Teams и управления ими из командной строки. Дополнительные сведения см. в разделе Инструкции по настройке интерфейса командной строки набора средств Teams.

2. Bot Framework Emulator: Bot Framework Emulator — это классическое приложение, которое позволяет тестировать и отлаживать бота локально. Вы можете подключиться к боту, введя URL-адрес конечной точки бота, а также идентификатор и пароль приложения Майкрософт. Затем вы можете отправлять сообщения боту и просматривать его ответы в режиме реального времени. Дополнительные сведения см. в разделе инструкции по настройке Bot Framework Emulator.

3. Ручная настройка. Если вы предпочитаете настраивать ресурсы вручную, это можно сделать, следуя инструкциям, предоставленным соответствующими службами. Дополнительные сведения см. в руководстве по настройке вручную.

Следующее действие

API помощников