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

Важно!

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

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

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

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

Совет

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

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

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

Примечание.

Снимки экрана и ссылки на пользовательский интерфейс набора средств агентов Microsoft 365 в этом документе созданы с использованием последней версии выпуска , 6.0. Предварительные версии набора средств агентов могут отличаться от пользовательского интерфейса в этом документе.

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

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

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

2. Выберите значок набора средств агентов Microsoft 365 на панели действий слева.

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

   

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

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

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

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

   

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

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

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

Примечание.

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

isPKCEEnabled: false

Упакуйте и загрузите неопубликованный плагин

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

2. Выберите значок набора средств агентов Microsoft 365 на панели действий слева.

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. На панели действий слева выберите пункт Chat.

3. Выберите Copilot на панели Chat.

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

   

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

6. Когда вам будет предложено войти, выберите "Войти в средство отслеживания бюджета".