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

Важно!

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

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

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

• Требования, указанные в разделе Требования к параметрам расширяемости Copilot
• Существующий REST API со спецификацией OpenAPI (в этом пошаговом руководстве используется пример API отслеживания бюджета)
• Visual Studio Code
• Microsoft 365 Agents Toolkit

Совет

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

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

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

Примечание.

Снимки экрана и ссылки на пользовательский интерфейс microsoft 365 Agents Toolkit (эволюция набора средств Teams) в этом документе были созданы с помощью последней версии выпуска 6.0. Предварительные версии Набора средств агентов могут отличаться от пользовательского интерфейса в этом документе.

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

• Спецификация OpenAPI для REST API.
• Манифест подключаемого модуля API, который ссылается на включенную спецификацию OpenAPI и описывает доступные операции, метод проверки подлинности и форматы ответов.

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

2. Щелкните значок Microsoft 365 Agents Toolkit на панели действий слева.

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

   

4. Выберите Декларативный агент.

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

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

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

   

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

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

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

Примечание.

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

# isPKCEEnabled: true

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

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

2. Щелкните значок Microsoft 365 Agents Toolkit на панели действий слева.

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

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

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

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

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

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

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

   

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

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

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

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

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

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

   

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

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