Поделиться через

Создание подключаемых модулей API из существующего API для Microsoft 365 Copilot

  • Статья

Важно!

Подключаемые модули API поддерживаются только как действия в декларативных агентах. Они не включены в Microsoft 365 Copilot.

Подключаемые модули API подключают существующий REST API к Microsoft 365 Copilot. Набор средств Teams можно использовать для создания подключаемого модуля на основе существующего REST API со спецификацией OpenAPI.

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

Совет

Чтобы получить наилучшие результаты, убедитесь, что спецификация OpenAPI соответствует рекомендациям, описанным в разделе Как сделать документ OpenAPI эффективным при расширении Copilot.

Чтобы выполнить инструкции из этого руководства, скачайте пример API "Средство отслеживания бюджета" и настройте его для запуска на локальном компьютере разработки. Создайте пример хотя бы один раз, чтобы создать файл BudgetTracker.json для API.

Включение разработки подключаемого модуля в наборе средств Teams

  1. Откройте Visual Studio Code. Если набор средств Teams еще не установлен, см. инструкции по установке набора средств Teams .

  2. Выберите Файл ->Параметры ->Параметры. В окне Параметры найдите copilot параметр Fx-extension: Develop Copilot Plugin ( Разработка подключаемого модуля Copilot ). Если параметр еще не включен, включите параметр .

  3. В окне Параметры найдите kiota параметр Fx-extension: Enable Microsoft Kiota ( Включить Microsoft Kiota ). Если вы хотите включить Kiota, включите этот параметр. В противном случае отключите его. Дополнительные сведения см. в разделе Преимущества включения Microsoft Kiota.

  4. Если вы внесли какие-либо изменения в параметры, перезапустите Visual Studio Code, прежде чем продолжить.

Преимущества включения Microsoft Kiota

Включение Microsoft Kiota в Teams Toolkit имеет следующие преимущества.

  • Пользовательский интерфейс для выбора операций из документа OpenAPI заменяется обозревателем API, который лучше подходит для больших документов OpenAPI.
  • Разработчик может искать общедоступные описания OpenAPI с помощью команды поиска Kiota.

Создание подключаемого модуля

Подключаемые модули API — это ZIP-файл, содержащий следующие файлы.

  • Спецификация OpenAPI для REST API.
  • Манифест подключаемого модуля API, который ссылается на включенную спецификацию OpenAPI и описывает доступные операции, метод проверки подлинности и форматы ответов.
  • Манифест приложения Microsoft 365 (например, ) со свойством, manifest.jsonссылающимся copilotExtensions на манифест подключаемого модуля API.

  1. Откройте Visual Studio Code. Если набор средств Teams еще не установлен, см. инструкции по установке набора средств Teams .

  2. Щелкните значок Набора средств Teams на панели действий слева.

  3. Выберите Создать новое приложение в области задач Набор средств Teams.

    Снимок экрана: интерфейс набора средств Teams

  4. Выберите Агент, а затем — Декларативный агент.

  5. Выберите Добавить подключаемый модуль, а затем выберите Начать с документом описания OpenAPI.

Следующие шаги различаются в зависимости от того, включили ли вы Microsoft Kiota.

  1. Выберите Обзор и перейдите к расположению спецификации OpenAPI из примера Средства отслеживания бюджета, расположенного по адресу ./openapi/BudgetTracker.json.

  2. Выберите все операции, которые необходимо включить для подключаемого модуля.

    Пользовательский интерфейс набора средств Teams для выбора операций

  3. Выберите расположение для проекта подключаемого модуля API.

  4. Введите Budget Tracker имя подключаемого модуля.

После выполнения этих действий Набор средств Teams создает необходимые файлы для подключаемого модуля и открывает новое окно Visual Studio Code с загруженным проектом подключаемого модуля.

Примечание.

Если серверу удостоверений требуется ключ проверки подлинности для Обмена кодом (PKCE), раскомментируйте следующую строку в teamsapp.yml в проекте подключаемого модуля API.

# isPKCEEnabled: true

Упаковка и загрузка неопубликованного подключаемого модуля

  1. Откройте проект подключаемого модуля в Visual Studio Code.

  2. Щелкните значок Набора средств Teams на панели действий слева.

  3. В области Учетные записи выберите Войти в Microsoft 365. (Если вы уже вошли в систему, перейдите к следующему шагу.

  4. Убедитесь, что в вашей учетной записи Microsoft 365 отображаются настраиваемые функции отправки приложений и доступ Copilot. В противном случае проверка с администратором организации. Дополнительные сведения см. в разделе Требования к параметрам расширяемости Copilot.

  5. В области Жизненный цикл выберите Подготовка.

  6. При запросе введите идентификатор клиента для регистрации OAuth..., введите идентификатор клиента подключаемого модуля.

  7. При запросе ввести секрет клиента для регистрации OAuth..., введите секрет клиента подключаемого модуля.

  8. Прочтите сообщение в диалоговом окне и нажмите кнопку Подтвердить , чтобы продолжить.

  9. Дождитесь, пока набор средств сообщит о завершении подготовки.

    Сообщение набора средств Teams, подтверждающее успешную подготовку

Теперь подключаемый модуль доступен для тестирования с учетной записью пользователя в Microsoft 365 Copilot в Microsoft Teams.

Использование подключаемого модуля

  1. Откройте Teams в браузере и войдите с помощью учетной записи Microsoft 365, которую вы использовали для отправки подключаемого модуля.

  2. Выберите Чат на панели действий слева.

  3. Выберите Copilot в области Чат .

  4. Выберите Средство отслеживания бюджета в списке Агенты справа. Если список недоступен, щелкните значок Чати Copilot и другое в правом верхнем углу.

    Снимок экрана: список агентов в Microsoft Teams

  5. Задайте вопрос о бюджетах. Например, попробуйте .How much is left in the Fourth Coffee lobby renovation budget? При появлении запроса выберите Всегда разрешать или Разрешить один раз , чтобы продолжить.

  6. При запросе на вход выберите Войти в средство отслеживания бюджета.