プロンプトの提案を作成する

プロンプト候補は、Microsoft Teams チャットでユーザーに提示されるコマンドです。

プロンプトの提案は、魅力的で洞察に富んだユーザー エクスペリエンスを作成し、会話を促すことでボットの価値を示すことで、ボットがユーザーを取得して保持するのに役立ちます。 プロンプトの提案を使用して、ユーザーがボットとの会話を開始し、ボットと対話する方法を学習するのに役立ちます。

次の 2 種類のプロンプト候補を使用できます。

スタート画面を表示する

プロンプト スターターは、ユーザーがボットとの会話を開始するのに役立ちます。

推奨されるアクション

推奨されるアクションは、ユーザーがボットとの会話を続けるのに役立ちます。

スタート画面を表示する

注:

• ボットでは、プロンプト スターターまたはウェルカム メッセージを使用できます。 ボットでプロンプト スターターを使用する場合は、ボットがウェルカム メッセージを送信しないことを確認します。

• プロンプト スターターは、1 対 1 のチャット ボットでのみサポートされます。

プロンプト スターターを有効にするには、ボットのアプリ マニフェストで commands プロパティを定義します。 各コマンドには、 title と descriptionが含まれています。 titleはプロンプトであり、descriptionはユーザーが何を達成するかについて説明します。 ユーザーがプロンプト スターターを選択すると、プロンプトの title が作成ボックスに入力されます。 アプリ マニフェストで commands を定義するには、 開発者ポータル を使用するか、アプリ マニフェストに手動で追加します。

開発者ポータル

開発者ポータルを使用してプロンプト スターターを作成するには:

1. Teams を開き、左側のウィンドウから [アプリ] を選択します。 [ アプリ ] ページで、 開発者ポータルを検索し、[ 開く] を選択します。

   

2. 開発者ポータルで、[アプリ] タブを選択します。既存のアプリ パッケージがない場合は、既存のアプリを作成またはインポートできます。 詳細については、「 Teams 用開発者ポータル」を参照してください。

3. [ アプリ ] タブを選択し、左側のウィンドウで [ アプリ機能 ] を選択し、[ ボット] を選択します。

4. [ コマンド] で、[ コマンドの追加] を選択します。

   

5. 次のフィールドの値を入力します。

   • コマンド: ボットのプロンプトとして表示されます。
   • 説明: コマンドの目的の簡単な説明。

6. 個人用スコープを選択し、[ 追加] を選択します。 これにより、コマンド メニューを表示する必要がある場所が定義されます。

   

アプリ マニフェストで手動で

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

• command プロパティでは、最大 10 個のコマンドがサポートされます。
• すべてのスコープで動作するプロンプト スターターを作成するか、スコープごとに異なるプロンプト スターターを作成できます。

プロンプト スターターのマニフェストの例

プロンプト スターターのマニフェストサンプル コードは次のとおりです。

{
  ⋮
  "bots":[
    {
      "botId":"[Microsoft App ID for your bot]",
      "scopes": [
        "personal"
      ],
      "commandLists":[
        {
          "scopes":[
            "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"
            }
          ]
        }
      ]
    }
  ],
  ...
}

注:

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

次に、プロンプトの候補の例を示します。

デスクトップ

モバイル

会話中に [新規作成] ボックスの上にある [ビュー プロンプト] ポップアップにプロンプト スターターが再び表示され、ボットとの対話中にユーザーがプロンプトを確認できるようになります。

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

ボットで commands を処理する

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

注:

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

C#

• SDK レファレンス

• サンプル コード リファレンス

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

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

// Remove recipient mention text from Text property.
// Use with caution because this function is altering the text on the Activity.
var modifiedText = turnContext.Activity.RemoveRecipientMention();

JavaScript

• SDK レファレンス

• サンプル コード リファレンス

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

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

// Remove mention text from Text property, this function is altering the text on the Activity.
const modifiedText = TurnContext.removeMentionText(turnContext.activity, turnContext.activity.recipient.id);

Python

• SDK レファレンス

• サンプル コード リファレンス

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

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

# Remove recipient mention text from Text property, this function is altering the text on the Activity.
modified_text = TurnContext.remove_recipient_mention(turn_context.activity)

推奨されるアクション

推奨されるアクションは、ユーザーが前の応答や会話に基づいて、次に何を尋ねるかを考えるのに役立ちます。 ボットは、一般的なものや固定された提案ではなく、コンテキスト固有の提案をユーザーに提供する必要があります。 ボットの大きな言語モデル (LLM) を使用して、応答と共に最大 3 つの提案を生成できます。 次に、これらの提案を抽出し、ユーザーが選択するオプションとして提示できます。

重要

ボットは最大 3 つのアクションを解析できます。 3 つ以上のアクションを含める場合でも、Teams には最初の 3 つのアクションのみが表示されます。

ユーザーがボタンを選択すると、リッチ カードで表示され、アクセス可能なままになります。 推奨されるアクションは、すべてのスコープでサポートされています。

• personal: 1 対 1 のチャットでは、アクションはスマート応答として表示されるため、最後のメッセージのアクションのみが表示されます。
• team groupChat: グループ チャットとチャネルでは、アクションは常にメッセージと共に保存されます。

個人用チャット

デスクトップ:

モバイル:

グループ チャット

デスクトップ:

モバイル:

チャネル

デスクトップ:

モバイル:

注:

SuggestedActions は、任意の会話の種類の添付ファイルを含むチャット ボットではサポートされていません。

次に、 imBack と Action.Composeを使用して推奨されるアクションを実装およびエクスペリエンスする方法を示す例をいくつか示します。

imBack

メッセージに推奨されるアクションを追加するには、アクティビティ オブジェクトの suggestedActions プロパティに対してユーザーに表示するボタンを表すカードアクション オブジェクトの一覧を指定します。

次に、 imBackを使用して推奨されるアクションを実装する例を示します。

{
  "type": "message",
  "from": {
    "id": "12345678",
    "name": "sender's name"
  },
  "conversation": {
    "id": "abcd1234",
    "name": "conversation's name"
  },
  "recipient": {
    "id": "1234abcd",
    "name": "recipient's name"
  },
  "text": "What are the tasks for the day.",
  "inputHint": "expectingInput",
  "suggestedActions": {
    "actions": [
      {
        "type": "imBack",
        "title": "Create a new query identifying overdue tasks",
        "value": "Create a new query identifying overdue tasks"
      },
      {
        "type": "imBack",
        "title": "Create a new work item for this feature",
        "value": "Create a new work item for this feature"
            }
        ]
    },
  "replyToId": "5d5cdc723"
}

Action.Compose

Action.Composeを使用して、新規作成ボックスにメッセージを挿入できます。これは、新しいアクションの種類を追加するのに役立ちます。 このアクションを使用すると、タグなどのセマンティック オブジェクト、チャットやチャネルメンションユーザー、絵文字や gif などのその他のリッチ オブジェクトを含めることができます。

次のコード スニペットは、 Action.Composeを実装する例を示しています。

{ 
   Type: “Action.Compose”, 
   Title: “button title”, 
   Value: { 
      type: “Teams.chatMessage”, 
      data: <GraphAPI Chat Message Object> 
   } 
}

value オブジェクトは、Graph API内のchatMessage オブジェクトに従う必要があります。

詳細については、 コード サンプルに関するページを参照してください。

注:

メッセージがサポートされていないハブで受信された場合、アプリにエラー メッセージが表示されます。 ボットは、その投稿先のチャネルを認識しています。

コード サンプル

サンプルの名前	説明	.NET	Node.js
スタート ボットのプロンプト	[コマンドの作成] メニュー Microsoft Teams、ボットのアプリ マニフェストにプロンプト スターターを実装します。	表示	表示

関連項目

• Teams 用のボットを構築する
• Teams のアプリ マニフェストのスキーマ
• ボットの会話内のメッセージ
• ボット開発者向けのアダプティブ カード