Anatomia chatbota – część 5: przejścia między dialogami

W ostatnim wpisie poruszyłem tematy podstawowych operacji w ramach pojedynczego dialogu. Oczywiście umieszczenie całej logiki w ramach jednego dialogu jest mało przejrzyste i nie ułatwia ponownego wykorzystania kodu, stąd nawet przy małych projektach absolutnie konieczne (i bardzo praktyczne) staje się podzielenie konwersacji na poszczególne dialogi.

Przejścia między dialogami są obsługiwane przez następujące metody obiektu context:

Call – wywołuje nowy dialog i przekazuje mu kontrolę. Nowy dialog otrzyma następną wiadomość od użytkownika.
Forward – wywołuje nowy dialog i przekazuje mu kontrolę, jednocześnie przekazując mu bieżącą wiadomość od użytkownika.
Done – kończy dany dialog, zwracając wynik do dialogu nadrzędnego, z którego dany dialog został wywołany.
Fail – przekazuje do dialogu nadrzędnego informację o niepowodzeniu danego dialogu.

Zobaczmy jak to działa w praktyce. Poniżej dialog PromptTimeDialog (z mojej paczki nugetowej Tomaszkiewicz.BotFramework zawierającej różne fajne dodatki i rozszerzenia – szczegóły w przyszłych wpisach):

[Serializable]
public class PromptTimeDialog : IDialog<DateTime>
{
    private readonly string _prompt;
    private readonly string _retry;
    private readonly int _attemps;

    public PromptTimeDialog(string prompt, string retry = null, int attemps = 3)
    {
        _prompt = prompt;
        _attemps = attemps;
        _retry = retry;
    }

    public Task StartAsync(IDialogContext context)
    {
        PromptForTime(context);
        return Task.CompletedTask;
    }

    private void PromptForTime(IDialogContext context)
    {
        PromptDialog.Text(context, ValidateTime, _prompt, _retry, _attemps);
    }

    private async Task ValidateTime(IDialogContext context, IAwaitable<string> result)
    {
        var str = await result;
        DateTime time;
        if (DateTime.TryParse(str, out time))
        {
            context.Done(time);
            return;
        }
        PromptForTime(context);
    }
}

Powyższy dialog – jak sama jego nazwa wskazuje – służy do zapytania użytkownika o godzinę. Warto zwrócić uwagę na kilka rzeczy:

Dialog implementuje interfejs IDialog<DateTime> co powoduje, że operacja context.Done oczekuje przekazania na wyjściu z dialogu obiektu typu DateTime.
Zwrócenie podanej przez użytkownika godziny następuje w linii 32 poprzez wywołanie context.Done(time). Wynik ten zostanie przekazany do dialogu nadrzędnego – zaraz zobaczymy to na przykładzie.
W linii 23 mamy nowy element – wywołanie statycznej metody klasy PromptDialog – klasa ta dostarcza kilka gotowych narzędzi do pobierania informacji od użytkownika. O jej możliwościach będzie jeden z kolejnych wpisów.

Przejdźmy do przykładu wywołania tego dialogu:

[Serializable]
public class SampleDialog : IDialog<object>
{
    public Task StartAsync(IDialogContext context)
    {
        context.Wait(MessageReceivedAsync);
        return Task.CompletedTask;
    }

    private async Task MessageReceivedAsync(IDialogContext context, IAwaitable<IMessageActivity> result)
    {
        await result;
        context.Call(new PromptTimeDialog("Na którą zamówić budzenie ?"), OnTimeProvided);
    }

    private async Task OnTimeProvided(IDialogContext context, IAwaitable<DateTime> result)
    {
        var time = await result;
        await context.PostAsync($"Ok, obudzę Cię o godzinie {time:HH:mm} :)");
    }
}

Linia 13 powoduje przekazanie kontroli do PromptTimeDialog, aby następnie przetworzyć wynik tego dialogu w metodzie OnTimeProvided. Dalej jest już standardowo – awaitujemy result i używamy go dalej w logice aplikacji – w powyższym przykładzie po prostu wysyłamy użytkownikowi potwierdzenie.

W następnych częściach…

… zajmiemy się klasą PromptDialog, aby następnie przejść do problemu serializacji dialogów w kontekście wstrzykiwania zależności.

A w dalszej przyszłości przejdziemy do sztucznej inteligencji w zastosowaniach związanych z chatbotami :)

Aby nie przegapić kolejnych wpisów zapraszam do śledzenia tego bloga, czy to przez kanał RSS, czy też poprzez stronę na Facebooku.