Создание расширений сообщений с помощью API

Примечание.

Расширения сообщений на основе API поддерживают только команды поиска.

Расширения сообщений, созданные с помощью API (на основе API), используют веб-службу для управления пользовательскими запросами и ответами и не требуют регистрации бота. Вы можете настроить и развернуть расширения сообщений на основе API с помощью портала разработчика для Teams и набора средств Teams для Visual Studio Code, интерфейса командной строки (CLI) или Visual Studio. Расширения сообщений на основе API помогают приложениям напрямую взаимодействовать со сторонними данными, приложениями и службами, расширяя их возможности. С помощью расширения сообщений на основе API вы можете:

• Получение информации в режиме реального времени, например последних новостей о запуске продукта.
• Получение информации на основе знаний, например файлов проектирования команды в Figma.

Расширение сообщений на основе API можно создать с помощью документа OpenAPI Description (OAD). После создания документа Описание OpenAPI используйте документ Описание OpenAPI, чтобы создать и интегрировать клиентский код в проект приложения. Создайте или создайте шаблон отрисовки ответа для управления ответами из API.

Дополнительные сведения о создании расширения для сообщений на основе API с помощью набора средств Teams см. в этом видео:

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

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

• Описание OpenAPI (OAD)
• Обновление манифеста приложения

Описание OpenAPI

Описание OpenAPI (OAD) — это стандартная спецификация, в которой подробно описана структура и структура файлов OpenAPI. Это не зависящий от языка, доступный для чтения формат для описания API. Как люди, так и компьютеры могут легко считывать и писать описание openAPI. Схема является машиночитаемой и может быть представлена в YAML или JSON. Перед созданием расширения сообщений на основе API требуется документ Описание OpenAPI.

Шаблон отрисовки ответа

Шаблон отрисовки ответа сопоставляет ответы JSON с карточкой предварительного просмотра и адаптивной карточкой. Когда пользователь выбирает результат поиска, карточки предварительного просмотра отображаются в виде результатов. Затем карточка предварительного просмотра разворачивается в адаптивную карточку в поле создания сообщения.

Каждая команда поиска должна иметь соответствующий шаблон отрисовки ответа, а каждая команда должна соответствовать операции в описании OpenAPI. Однако не каждая операция, определенная в описании OpenAPI, должна быть командой. Шаблон отрисовки ответа состоит из шаблона адаптивной карточки, шаблона карточки предварительного просмотра и метаданных и должен соответствовать схеме шаблона отрисовки ответа, размещенной в https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json.

Обновление манифеста приложения

Обновите манифест приложения (ранее — манифест приложения Teams) с composeExtensions помощью свойства . Следующий код является примером манифеста приложения со свойством composeExtensions :

{
  "composeExtensions": [
    {
      "composeExtensionType": "apiBased",
      "apiSpecificationFile": "aitools-openapi.yml",
      "commands": [
        {
          "id": "searchTools",
          "type": "query",
          "context": [
            "compose",
            "commandBox"
          ],
          "title": "search for AI tools",
          "description": "search for AI tools",
          "parameters": [
            {
              "name": "search",
              "title": "search query",
              "description": "e.g. search='tool to create music'"
            }
          ],
          "apiResponseRenderingTemplateFile": "response-template.json"
        }
      ]
    }
  ]
}

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

Создание расширения сообщений на основе API