アルパカのメモ

会話の実装 (Dialog)

calendar_today (最終更新：)

はじめに

参考：

前提条件：

  • Windows 10
  • Visual Studio 2019
  • C#

Dialog は SDK の中核をなすもので、ユーザーとボットの会話のやり取りの管理を助けるライブラリである。 ステートレスなWebアプリにおいて、「今どこまで話したか？」を記憶・管理してくれる。 ボットの主な処理は Dialog クラスに実装するのがほとんどだと思う。

ライブラリの追加

ボットで Dialog を使うには、プロジェクトに下記 NuGet パッケージを追加する。

Microsoft.Bot.Builder.Dialogs

Dialogには色々な種類があるが、Adaptive Dialog が使えるなら Adaptive Dialog を主に使った方が良い。

Dialog の種類

現在色々な種類の Dialog があるが、まず使うのは Adaptive Dialog だと思う。複数の Dialog をまとめるための Component Dialog も使う。

  • Component Dialog
    • 複数の Dialog をひとまとめににできる Dialog。
  • Waterfall Dialog
    • 分岐やループのないシンプルな会話の流れを、ステップとして定義するDialog。Adaptive Dialog が上位互換になるので、新たに Waterfall Dialog を使うケースは少ないかもしれない。
  • Prompt Dialog
    • ユーザーへインプットを求め、回答を受け取るための小さな部品。Promptにはいくつか種類があり、それぞれ有効な入力値が得られるか、キャンセルされるまで自動的に質問を繰り返してくれる。Waterfall Dialogで使用するために設計された。
  • Adaptive Dialog
    • イベントトリガーを使って柔軟な会話を実装できる Dialog。大体の場合はこちらを使う。
  • Action Dialog
    • Adaptive Dialog で使用できる。Dialog の振る舞いが実装されたもの。メッセージ送信、条件分岐、ループなど、多彩なサブクラスがある。
  • Input Dialog
    • Adaptive Dialog で使用できる。Prompt の上位互換のようなもの。

WaterfallDialog

WaterfallDialogとは、決まった順番でユーザーへ質問を行い、回答を収集するようなケースで使用する。 このダイアログでは「ステップ」になるメソッドを定義して、それを順番に並べて定義する。

上記の例では、ステップが3つある。まず1番目のステップで最初の質問を行う。 2番目のステップで、最初の質問の回答を受け取り、保存するなどの処理をする。そして続けて次の質問を行う。

ComponentDialogを作成する

Dialogを実装する場合、まずラッパーとなる ComponentDialog クラスを作成し、その中にDialogを作りこんでいく。基本的な作り方は下記のサンプルの通り。
※ UserDataは UserState に保存するオブジェクト。

using Microsoft.Bot.Builder;
using Microsoft.Bot.Builder.Dialogs;

public class WaterfallSampleDialog : ComponentDialog
{
    private static readonly string DIALOG_ID = "WaterfallSampleDialog";

    private readonly IStatePropertyAccessor<UserData> _accessor;

    // コンストラクタ
    // ユーザーから得た回答は何かしら保存する必要があるため、UserStateやConversationStateを引数で受け取ることが多いと思う。
    public WaterfallSampleDialog(UserState userState) : base(DIALOG_ID)
    {
        _accessor = userState.CreateProperty<UserData>("UserData");
    }
}

ステップを作成する

ステップはメソッドとして定義する。メソッドの引数、戻り値は下記サンプルの通り。

private async Task<DialogTurnResult> XXXStepAsync(WaterfallStepContext stepContext, CancellationToken cancellationToken)
{
}

参考：WaterfallStep Delegate (Microsoft.Bot.Builder.Dialogs) | Microsoft Docs

今回のサンプルの場合、最初のステップでユーザーの名前を聞く。テキストの回答を受け付ける場合は、TextPrompt を使用する。

private async Task<DialogTurnResult> Step1Async(WaterfallStepContext stepContext, CancellationToken cancellationToken)
{
    var prompt = MessageFactory.Text("あなたの名前は？");
    var options = new PromptOptions
    {
        Prompt = prompt
    };
    return await stepContext.PromptAsync("TextPrompt", options, cancellationToken);
}

2番目のステップでは、名前を受け取りつつ次の質問をする。

private async Task<DialogTurnResult> Step2Async(WaterfallStepContext stepContext, CancellationToken cancellationToken)
{
    // 回答を保存する
    var name = (string)stepContext.Result;

    var userData = await _accessor.GetAsync(stepContext.Context, () => new UserData());
    userData.name = name;

    // 追加でメッセージを送ることも可能
    var msg = MessageFactory.Text($"{name}さん こんにちは！");
    await stepContext.Context.SendActivityAsync(msg, cancellationToken);

    // 次の質問をする
    var prompt = MessageFactory.Text("好きな色は？");
    var choices = ChoiceFactory.ToChoices(new List<string> { "赤", "青", "黄" });
    var options = new PromptOptions
    {
        Prompt = prompt,
        Choices = choices
    };
    return await stepContext.PromptAsync("ChoicePrompt", options, cancellationToken);
}

最後のステップでは、2番目の回答の保存と、会話の終了をさせる。

private async Task<DialogTurnResult> Step3Async(WaterfallStepContext stepContext, CancellationToken cancellationToken)
{
    // 回答を保存する
    var choice = (FoundChoice)stepContext.Result;

    var userData = await _accessor.GetAsync(stepContext.Context, () => new UserData());
    userData.color = choice.Value;

    var msg = MessageFactory.Text($"{choice.Value}が好きなんですね");
    await stepContext.Context.SendActivityAsync(msg, cancellationToken);

    // 会話の終わり
    return await stepContext.EndDialogAsync(cancellationToken: cancellationToken);
}

ステップの戻り値

ステップのメソッドは、必ず DialogTurnResult を返す。 DialogTurnResult に持たせるパラメータによって、次のステップへ進むか、Dialogの流れを終わらせるか、などを制御できる。

大体の戻り値は、引数の stepContext のメソッドを呼び出せばよい。

以下に戻り値のパターンのサンプルを示す：

// ユーザーにPromptを送り、入力を待つ。
// ユーザーの入力が正しい場合、次のステップへ進む。正しくない場合はPromptによって当ステップが繰り返される。
return await stepContext.PromptAsync("TextPrompt", promptOptions, cancellationToken);

// ユーザーの入力を待つ
return new DialogTurnResult(DialogTurnStatus.Waiting);

// 当ステップを飛ばす
// 第1引数は、次のステップへ渡すResultを指定する。
return await stepContext.NextAsync(null, cancellationToken);

// Dialogを終わらせる。最後のステップの戻り値はこれでないといけない
return await stepContext.EndDialogAsync(cancellationToken: cancellationToken);

// 現在の Dialog を終了させ、他の Dialog を開始する。
return await stepContext.ReplaceDialogAsync(DIALOG_ID, null, cancellationToken);

参考： DialogTurnStatus Enum (Microsoft.Bot.Builder.Dialogs) | Microsoft Docs

Dialogを定義する

ComponentDialog のコンストラクタで、今まで定義したステップをつかってWaterfallDialogを作成する。作成した Dialog はComponentDialogへ登録し、ステップ中で使用する Prompt も同じように ComponentDialog へ登録する。

// コンストラクタ
public WaterfallSampleDialog(UserState userState) : base(DIALOG_ID)
{
    _accessor = userState.CreateProperty<UserData>("UserData");

    // dialogの登録
    var steps = new WaterfallStep[] { Step1Async, Step2Async, Step3Async };

    AddDialog(new WaterfallDialog("WaterfallDialog1", steps));
    AddDialog(new TextPrompt("TextPrompt"));
    AddDialog(new ChoicePrompt("ChoicePrompt"));

    // 最初に実行するdialogを指定する
    InitialDialogId = "WaterfallDialog1";
}

これで Dialog は完成となる。

ボットからDialogを呼び出す

できあがった Dialog をボットから実行する。DialogはDIでインスタンスを取得し、OnMessageActivityAsync で呼び出す。 その際、Dialog自身の状態管理に ConversationState が必要なので、一緒に渡す。

public class SampleBot : ActivityHandler
{
    private readonly ConversationState _conversationState;
    private readonly UserState _userState;
    private readonly WaterfallSampleDialog _dialog;

    public SampleBot(ConversationState conversationState, UserState userState, WaterfallSampleDialog dialog)
    {
        _conversationState = conversationState;
        _userState = userState;
        _dialog = dialog;
    }

    protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
    {
        var dialogState = _conversationState.CreateProperty<DialogState>(nameof(DialogState));
        await _dialog.RunAsync(turnContext, dialogState, cancellationToken);
    }

    public override async Task OnTurnAsync(ITurnContext turnContext, CancellationToken cancellationToken = default)
    {
        await base.OnTurnAsync(turnContext, cancellationToken);

        // state保存
        await _conversationState.SaveChangesAsync(turnContext, false, cancellationToken);
        await _userState.SaveChangesAsync(turnContext, false, cancellationToken);
    }
}

DialogをDIに登録する

Startup.cs の ConfigureServices メソッドで、Dialogクラスをサービスに登録する。

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<WaterfallSampleDialog>();
}

実行してみる

こちらから話しかけないとDialogが始まらないが、ステップ1～3の会話ができている。