テキストメッセージを送受信する

[アーティクル]
12/26/2023

この記事の対象: SDK v4

ボットでユーザーと通信し、同様にボットで通信を受け取る主要な方法は、メッセージ アクティビティを利用することです。メッセージにはプレーンテキストのみで構成されているものもあれば、カードや添付ファイルなど、よりリッチなコンテンツが含まれるものもあります。ボットのターンハンドラーでは、ユーザーからメッセージを受け取ります。そこからユーザーに応答を送信できます。ターンコンテキストオブジェクトによって、ユーザーにメッセージを戻すためのメソッドが与えられます。この記事では、プレーンテキストメッセージを送信する方法について説明します。

Markdown はほとんどのテキストフィールドでサポートされていますが、サポート状況はチャネルごとに異なる場合があります。

メッセージを送受信する実行中のボットについては、目次の一番上にあるクイックスタートを実行するか、ボットの動作方法に関するの記事を確認してください。これは、ご自身で実行する場合にご利用いただけるサンプルへもリンクされています。

Note

Bot Framework JavaScript SDK、C#、Python SDK は引き続きサポートされますが、Java SDK については、最終的な長期サポートは 2023 年 11 月に終了する予定です。このリポジトリ内の重要なセキュリティとバグの修正のみが行われます。

Java SDK を使用して構築された既存のボットは引き続き機能します。

新しいボットの構築については、Power Virtual Agents の使用を検討し、適切なチャットボットソリューションの選択についてお読みください。

詳細については、「The future of bot building」をご覧ください。

テストメッセージを送信

テキストメッセージを送信するには、送信する文字列をアクティビティとして指定します。

ボットのアクティビティハンドラーで、ターンコンテキストオブジェクトの SendActivityAsync メソッドを使用して、1 つのメッセージ応答を送信します。オブジェクトの SendActivitiesAsync メソッドを使用して一度に複数の応答を送信することもできます。

await turnContext.SendActivityAsync($"Welcome!");

ボットのアクティビティハンドラーで、ターンコンテキストオブジェクトの sendActivity メソッドを使用して、1 つのメッセージ応答を送信します。オブジェクトの sendActivities メソッドを使用して一度に複数の応答を送信することもできます。

await context.sendActivity("Welcome!");

turnContext.sendActivity("Welcome!");

ボットのアクティビティハンドラーで、ターンコンテキストオブジェクトの send_activity メソッドを使用して、1 つのメッセージ応答を送信します。

await turn_context.send_activity("Welcome!")

言語の生成 (LG) では、合成と展開に使用されるテキストバリエーションが 1 つ以上含まれるテンプレートが提供されます。提供されるバリエーションの 1 つが、LG システムによってランダムに選択されます。

次の例は、2 つのバリエーションが含まれるボット応答のテンプレートを示しています。

# GreetingPrefix
- Hi
- Hello

テキストメッセージの受信

テキストメッセージを処理するには、アクティビティ オブジェクトの テキスト プロパティを使用します。

ボットのアクティビティハンドラーで、次のコードを使用してメッセージを受信します。

var responseMessage = turnContext.Activity.Text;

ボットのアクティビティハンドラーで、次のコードを使用してメッセージを受信します。

let text = turnContext.activity.text;

ボットのアクティビティハンドラーで、次のコードを使用してメッセージを受信します。

String responseMessage = turnContext.getActivity().getText();

ボットのアクティビティハンドラーで、次のコードを使用してメッセージを受信します。

response = context.activity.text

次の LG テンプレートをお使いの .lg ファイルに追加して、メッセージを受信します。

# EchoMessage
You said '${turn.activity.text}'

入力インジケーターの送信

ユーザーはメッセージに対するタイムリーな応答を期待しています。ボットがユーザーからの指示を受け取ったということをユーザーに表示することなく、サーバーの呼び出しやクエリの実行などの実行時間の長いタスクを実行すると、ユーザーはしびれを切らして追加のメッセージを送信したり、単にボットが壊れていると推測する可能性があります。

Web チャットおよび Direct Line チャネルのボットは、メッセージが受信され、処理中であることをユーザに示す入力表示の送信をサポートできます。ただし、ボットはターンを 15 秒以内に終了させる必要があります。そうしないと、コネクタサービスがタイムアウトになります。より長いプロセスについては、プロアクティブメッセージの送信の詳細を参照してください。

次の例は、入力表示を送信する方法を示しています。

protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
{
    if (string.Equals(turnContext.Activity.Text, "wait", System.StringComparison.InvariantCultureIgnoreCase))
    {
        await turnContext.SendActivitiesAsync(
            new Activity[] {
                new Activity { Type = ActivityTypes.Typing },
                new Activity { Type = "delay", Value= 3000 },
                MessageFactory.Text("Finished typing", "Finished typing"),
            },
            cancellationToken);
    }
    else
    {
        var replyText = $"Echo: {turnContext.Activity.Text}. Say 'wait' to watch me type.";
        await turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken);
    }
}

this.onMessage(async (context, next) => {
    if (context.activity.text === 'wait') {
        await context.sendActivities([
            { type: ActivityTypes.Typing },
            { type: 'delay', value: 3000 },
            { type: ActivityTypes.Message, text: 'Finished typing' }
        ]);
    } else {
        await context.sendActivity(`You said '${ context.activity.text }'. Say "wait" to watch me type.`);
    }
    await next();
});

@Override
protected CompletableFuture<Void> onMessageActivity(TurnContext turnContext) {
    if (turnContext.getActivity().getText().toLowerCase().equals("wait")) {
        List<Activity> activities = new ArrayList<Activity>();
        activities.add(new Activity(ActivityTypes.TYPING));
        activities.add(new Activity(ActivityTypes.DELAY) {{setValue(3000);}});
        activities.add(MessageFactory.text("Finished typing", "Finished typing", null));
        return turnContext.sendActivities(activities).thenApply(result -> null);
    } else {

        return turnContext.sendActivity(MessageFactory.text("Echo: " + turnContext.getActivity().getText()))
            .thenApply(sendResult -> null);
    }
}

async def on_message_activity(self, turn_context: TurnContext):
    if turn_context.activity.text == "wait":
        return await turn_context.send_activities([
            Activity(
                type=ActivityTypes.typing
            ),
            Activity(
                type="delay",
                value=3000
            ),
            Activity(
                type=ActivityTypes.message,
                text="Finished Typing"
            )
        ])
    else:
        return await turn_context.send_activity(
            f"You said {turn_context.activity.text}.  Say 'wait' to watch me type."
        )

# TypingIndicator
[Activity
    Type = typing
]

その他のリソース

次のステップ

メッセージにメディアを追加する

テキスト メッセージを送受信する

テスト メッセージを送信

テキスト メッセージの受信

入力インジケーターの送信

その他のリソース

次のステップ

その他のリソース

テキストメッセージを送受信する

テストメッセージを送信

テキストメッセージの受信