Меню "Добавление бота" в Microsoft Teams

Важно!

Эта статья основана на пакете SDK Bot Framework версии 3. Если вы ищете текущую документацию по пакету SDK версии 4.6 или более поздней, см. раздел Боты для беседы .

Чтобы помочь в обнаружении и помочь пользователям узнать о функциях бота, теперь можно добавлять меню, которые отображаются при каждом взаимодействии пользователя с ботом. В меню отобразится текст команды, а также текст справки, например пример использования или описание назначения команды.

Снимок экрана: меню бота

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

Поддержка меню бота в мобильном приложении Teams

Примечание.

Меню бота не отображаются на мобильных устройствах.

Манифест приложения

Чтобы создать меню бота, добавьте новый commandLists объект в манифест приложения в разделе бота. Вы можете объявить отдельные меню с отдельными командами для каждой области, поддерживаемых ботом (personal, groupChatили team). Каждое меню поддерживает до 10 команд.

Фрагмент манифеста — одно меню для обеих областей

{
  ⋮
  "bots":[
    {
      "botId":"[Microsoft App ID for your bot]",
      "scopes": [
        "personal",
        "team"
      ],
      "commandLists":[
        {
          "scopes":[
            "team",
            "personal"
          ],
          "commands":[
            {
              "title":"Help",
              "description":"Displays this help message"
            },
            {
              "title":"Search Flights",
              "description":"Search flights from Seattle to Phoenix May 2-5 departing after 3pm"
            },
            {
              "title":"Search Hotels",
              "description":"Search hotels in Portland tonight"
            },
            {
              "title":"Best Time to Fly",
              "description":"Best time to fly to London for a 5 day trip this summer"
            }
          ]
        }
      ]
    }
  ],
  ...
}

Фрагмент манифеста — отдельное меню для каждой области

{
  ...
  "bots":[
    {
      "botId":"[Microsoft app ID for your bot]",
      "scopes": [
        "groupChat",
        "team"
      ],
      "commandLists":[
        {
          "scopes":[
            "team"
          ],
          "commands":[
            {
            "title":"help",
            "description":"Displays this help message for channels"
            }
          ]
        },
        {
          "scopes":[
            "groupChat"
          ],
          "commands":[
            {
            "title":"help",
            "description":"Displays this help message for group chat"
            }
          ]
        }
      ]
    }
  ],
  ...
}

Лучшие методики

  • Не усложняйте: меню бота предназначено для представления основных возможностей бота.
  • Оставьте его коротким: параметры меню не должны быть очень длинными и сложными операторами естественного языка — они должны быть простыми командами.
  • Всегда доступно: действия и команды меню бота должны всегда вызываться независимо от состояния беседы или диалога, в которой находится бот.