Bot コマンドメニュー

[アーティクル]
04/28/2022

重要

このセクションのコードサンプルは、バージョン 4.6 以降のバージョンの Bot Framework SDK に基づいて作成されます。以前のバージョンのドキュメントを探している場合は、ドキュメントの Resources フォルダーの「bots - v3 SDK」セクションを参照してください。

ボットが応答できる一連のコアコマンドを定義するには、ボットのコマンドのドロップダウンリストを含むコマンドメニューを追加します。コマンドの一覧は、ボットと会話しているときに、メッセージ作成領域のユーザーに表示されます。一覧からコマンドを選択して、メッセージの作成ボックスにコマンド文字列を挿入し、[ 送信] を選択します。

デスクトップ
モバイル

コマンドメニューは、アプリマニフェストで定義されます。 App Studio を使用して作成するか、アプリマニフェストに手動で追加できます。

ボットのコマンドメニューを作成するための前提条件は、既存のアプリマニフェストを編集する必要があるということです。コマンドメニューを追加する手順は、新しいマニフェストを作成するか、既存のマニフェストを編集するかに関係なく、同じです。

App Studio を使用してボットのコマンドメニューを作成するには

Teams開き、左側のウィンドウで [アプリ] を選択します。 [ アプリ] ページで App Studio を検索し、[ 開く] を選択します。

注意

App Studio をお持ちでない場合は、ダウンロードできます。詳細については、 App Studio のインストールに関するページを参照してください。
App Studio で、[マニフェストエディター] タブを選択します。既存のアプリパッケージがない場合は、既存のアプリを作成またはインポートできます。詳細については、「アプリパッケージの更新」を参照してください。
マニフェストエディター の左側のウィンドウで、[機能] セクションで [ボット] を選択します。
マニフェストエディター の右側のウィンドウで、[コマンド] セクションで [追加] を選択します。 [新しいコマンド] 画面が表示されます。
ボットの コマンド メニューとして表示する必要があるコマンドテキストを入力します。
メニューのコマンドテキストの下に表示する必要がある ヘルプ テキストを入力します。 ヘルプテキスト は、コマンドの目的を簡単に説明する必要があります。
[ スコープ ] チェックボックスをオンにして、このコマンドメニューを表示する必要がある場所を選択し、[保存] を選択 します。

コマンドメニューを作成するもう 1 つの方法は、ボットのソースコードの開発中にマニフェストファイルに直接作成することです。このメソッドを使用するには、次の点に従います。

各メニューでは、最大 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"
            }
          ]
        }
      ]
    }
  ],
  ...
}

ユーザーからのメッセージを処理するときは、ボットコード内のメニューコマンドを処理する必要があります。メッセージテキストのメンション部分を解析することで、@ ボットコード内のメニューコマンドを処理できます。

グループまたはチャネル内のボットは、メッセージに記載されている @botname 場合にのみ応答します。グループスコープまたはチャネルスコープ内でボットによって受信されたすべてのメッセージには、メッセージテキストにその名前が含まれています。返されるコマンドを処理する前に、メッセージ解析でボットが受信したメッセージをその名前で処理する必要があります。

注意

コード内のコマンドを処理するために、通常のメッセージとしてボットに送信されます。ユーザーからの他のメッセージを処理する場合と同様に、それらを処理する必要があります。コード内のコマンドは、テキストボックスに事前構成されたテキストを挿入します。その後、ユーザーはそのテキストを他のメッセージと同様に送信する必要があります。

Microsoft Bot Frameworkで提供される静的メソッドを使用して、メッセージテキストのメンション部分を解析できます。@ という名前RemoveRecipientMentionのクラスのActivityメソッドです。

メッセージテキストのメンション部分を @ 解析する C# コードは次のとおりです。

var modifiedText = turnContext.Activity.RemoveRecipientMention();

Bot Framework で提供される静的メソッドを @ 使用して、メッセージテキストのメンション部分を解析できます。という名前removeMentionTextのクラスのTurnContextメソッドです。

メッセージテキストのメンション部分を @ 解析する JavaScript コードは次のとおりです。

const modifiedText = TurnContext.removeMentionText(turnContext.activity, turnContext.activity.recipient.id);

Bot Framework で提供される静的メソッドを使用して、メッセージテキストの @Mention 部分を解析できます。という名前remove_recipient_mentionのクラスのTurnContextメソッドです。

メッセージテキストのメンション部分を @ 解析する Python コードは次のとおりです。

modified_text = TurnContext.remove_recipient_mention(turn_context.activity)

ボットコードの円滑な機能を有効にするには、従う必要があるベストプラクティスがいくつかあります。

コマンドメニューのベストプラクティスを次に示します。

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

注意

マニフェストからコマンドを削除する場合は、変更を実装するためにアプリを再デプロイする必要があります。一般に、マニフェストに変更を加える場合は、アプリを再デプロイする必要があります。

次の手順

チャネルとグループ会話

Bot コマンドメニュー

ボットのコマンドメニューを作成する

App Studio を使用してボットのコマンドメニューを作成する

Manifest.json を編集してボットのコマンドメニューを作成する

両方のスコープの単一メニューのマニフェストの例

各スコープのメニューのマニフェストの例

ボットコードでメニューコマンドを処理する

コマンドメニューのベストプラクティス

次の手順

Bot コマンド メニュー

このページはお役に立ちましたか?

ボットのコマンド メニューを作成する

App Studio を使用してボットのコマンド メニューを作成する

Manifest.json を編集してボットのコマンド メニューを作成する

両方のスコープの単一メニューのマニフェストの例

各スコープのメニューのマニフェストの例

ボット コードでメニュー コマンドを処理する

コマンド メニューのベスト プラクティス

次の手順

Bot コマンドメニュー

ボットのコマンドメニューを作成する

App Studio を使用してボットのコマンドメニューを作成する

Manifest.json を編集してボットのコマンドメニューを作成する

ボットコードでメニューコマンドを処理する

コマンドメニューのベストプラクティス