Microsoft Teamsにボット メニューを追加する

重要

この記事は、v3 Bot Framework SDK に基づいています。 SDK の現在のドキュメント バージョン 4.6 以降をお探しの場合は、「 会話ボット 」セクションを参照してください。

検出を支援し、ボットの機能についてユーザーを教育するために、ユーザーがボットと対話するたびに表示されるメニューを追加できるようになりました。 メニューにはコマンド テキストが表示され、使用例やコマンドの目的の説明などのヘルプ テキストも表示されます。

ユーザーがメニュー項目を選択すると、コマンド文字列がテキスト ボックスに挿入され、ボット メッセージのユーザー完了を支援します。

Teams モバイル アプリでのボット メニューのサポート

注:

ボット メニューはモバイル デバイスには表示されません。

アプリ マニフェスト

ボット メニューを作成するには、ボット セクションの下にあるアプリ マニフェストに新しい commandLists オブジェクトを追加します。 ボットがサポートするスコープ (personal、 groupChat、または team) ごとに個別のコマンドを使用して個々のメニューを宣言できます。各メニューでは、最大 10 個のコマンドがサポートされます。

マニフェストの抜粋 - 両方のスコープの 1 つのメニュー

{
  ⋮
  "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"
            }
          ]
        }
      ]
    }
  ],
  ...
}

ベスト プラクティス

• シンプルに保つ: ボット メニューは、ボットの主要な機能を示す意味があります。
• 簡単に言っておきます。メニュー オプションは、非常に長く複雑な自然言語ステートメントにしないでください。単純なコマンドにする必要があります。
• 常に使用可能: ボットのメニュー アクション/コマンドは、会話の状態やボットが存在するダイアログに関係なく、常に呼び出し可能である必要があります。