前回は単純なダイアログを紹介しましたが、今回はより複雑なダイアログを見ていきます。

ウォーターフォールダイアログ

複数のステップを順次処理する用のダイアログ。各ステップでは以下のような処理が行われる。

プロンプトをユーザーに送信
ユーザーからの入力を処理
ウォーターフォール処理の完了

ウォーターフォールステップ

ウォーターフォールダイアログはウォーターフォールステップと呼ばれるメソッドを実行順に持ちます。ウォーターフォールステップは以下のシグネチャを持っています。

Task<DialogTurnResult> StepName(WaterfallStepContext stepContext, CancellationToken cancellationToken)

これらのステップを WaterfallStep 配列に設定して、ウォーターフォールダイアログを作成します。

var waterfallSteps = new WaterfallStep[]
{
    Step1,
    Step2,
    Step3,
    ....
};

dialogs.Add(new WaterfallDialog("dialog_name", waterfallSteps));

WaterfallStepContext

DialogContext を継承しており、前処理の結果などウォーターフォールダイアログ実行に必要な情報を含んでいます。

GitHub : WaterfallStepContext

コンポーネントダイアログ

再利用可能なダイアログを作成するための仕組みとして、コンポーネントダイアログが提供されています。DialogSet を独自に持てるため、ダイアログ名などの競合を避けることができる他、DialogContext も分離されます。

ウォーターフォールダイアログを使ったボットの開発

前回は名前を聞くプロンプトダイアログを実装しましたが、今回はウォーターフォールダイアログを使って、ユーザープロファイルを聞くボットを実装します。

モデルの追加とステート管理の更新

まずはユーザープロファイル用のクラス追加とアクセサーを更新します。

1. Models フォルダを追加して、UserProfile.cs を追加。以下のコードを追加。

public class UserProfile
{
    public string Name { get; set; }

    public int Age { get; set; }
}

2. MyStateAccessors.cs ファイルを以下コードで差し替え。

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

public class MyStateAccessors
{
        public MyStateAccessors(
            UserState userState,
            ConversationState conversationState)
        {
            UserState = userState ?? throw new ArgumentNullException(nameof(userState));
            ConversationState = conversationState ?? throw new ArgumentNullException(nameof(conversationState));
        }

        public IStatePropertyAccessor<UserProfile> UserProfile { get; set; }
        public IStatePropertyAccessor<DialogState> ConversationDialogState { get; set; }
        public UserState UserState { get; }
        public ConversationState ConversationState { get; }
}

3. Startup.cs の ConfigureServices を以下の様に変更してアクセサーの変更を反映。

public void ConfigureServices(IServiceCollection services)
{
    services.AddBot<MyBot>(options =>
    {
        options.Middleware.Add(new MyLoggingMiddleware());
        options.Middleware.Add(new MyMiddleware());

        // ストレージとしてインメモリを利用
        IStorage dataStore = new MemoryStorage();
        var userState = new UserState(dataStore);
        var conversationState = new ConversationState(dataStore);
        options.State.Add(userState);
        options.State.Add(conversationState);
    });

    // MyStateAccessors を IoC に登録
    services.AddSingleton(sp =>
    {
        // AddBot で登録した options を取得。
        var options = sp.GetRequiredService<IOptions<BotFrameworkOptions>>().Value;
        if (options == null)
        {
            throw new InvalidOperationException("BotFrameworkOptions を事前に構成してください。");
        }
        var userState = options.State.OfType<UserState>().FirstOrDefault();
        if (userState == null)
        {
            throw new InvalidOperationException("UserState を事前に定義してください。");
        }

        var conversationState = options.State.OfType<ConversationState>().FirstOrDefault();
        if (conversationState == null)
        {
            throw new InvalidOperationException("ConversationState を事前に定義してください。");
        }

        var accessors = new MyStateAccessors(userState, conversationState)
        {
            // DialogState を作成
            ConversationDialogState = conversationState.CreateProperty<DialogState>("DialogState"),
            // UserProfile を作成
            UserProfile = userState.CreateProperty<UserProfile>("UserProfile")
        };

        return accessors;
    });
}