Execution Function

Execution関数は、Action実行のエンドポイントです。Actionの実行完了を定義します。Actionの実際の実行を処理し、Action完了後にユーザーに最終的な成功または失敗メッセージを返します。ユーザーへの応答は、テキストまたはカードのコレクションなどの視覚要素のいずれかです。

呼び出しポイント

Execution関数は、Actionのエンドポイントで呼び出されます。デフォルトでは、Actionのエンドポイントは、すべてのparam値がプロンプトされ、適切な値で入力された後に来ます。または、Context Handler関数 (“todo” : “execute”)からエンドポイントをトリガーすることもできます。Execution関数が呼び出された後、Actionは完了し、ユーザーからのさらなる会話は新しいActionとして扱われます。

システム定義入力引数は、Execution関数の入力引数としてのみ利用可能です。

戻り値

Execution関数は、以下の形式のマップを返します：

{
"message" : "The reply message.",
"card" : { },
"broadcast" : { },
"followup" : { }      
}

Execution関数が返すマップに含まれるキーについて以下で説明します：

message

ユーザーへの返信としてテキストメッセージを提供します。このキーは必須です。ConvoKraftでは以下のテキストフォーマットオプションがサポートされています。これらのオプションのいずれかをテキストメッセージで使用できます。

以下は、message引数のサンプル値です：

message : "Your event has been created successfully"

card

ユーザーへの返信として視覚的にフォーマットされたメッセージを提供します。cardは、テーブル、画像などの視覚要素のコレクションです。このキーの値はマップオブジェクトのリストです。各マップオブジェクトは、カード内のUI要素を表します。1つのカードには同じ型の複数の要素を含めることができます。カード内のすべての要素は返信メッセージで上から下に順に表示されます。このキーは任意です。

ConvoKraftの返信メッセージcardでサポートされるUI要素のリストの詳細については、こちらのページを参照してください。

以下は、card引数のサンプル値です：

"card" : {
"type" : "note", 
"content" : "Your event details are displayed below"
{
"type" : "image", 
"image" : "event_details.png"
}
//マップオブジェクトを追加する
}

broadcast

現在のActionの実行後にBotが記憶する必要があるデータを渡します。値はマップ形式で、セッション全体のすべての連続するActionsで利用可能になります。このキーは任意です。broadcastの詳細については、こちらのページをご覧ください。

以下は、broadcast引数のサンプル値です。

"broadcast" : {
"user_level" : "admin", 
"status" : "booked"
}

followup

現在のAction実行の完了後に、Botが提案リストを表示するか、特定のActionをフォローアップとして呼び出すようユーザーにプロンプトするかを設定できます。このキーは任意です。Action Followupsとこのキーの値の構造の詳細については、こちらのページをご覧ください。

以下は、card引数のサンプル値です：

"followup":{
"suggestions":[
{
"message":"Would you like to set a reminder for this event",
"action":{
"name":"schedule remainder",
"params":[ 
{
"name":"event time",
"value":"11:00 am"
} 
//必要に応じて他のパラメータを追加する  
]
}
}

実装

ConvoKraft BotのActionを作成し、Business Logicに基づいて応答を設定することを選択したら、Sample Sentencesとそれぞれのparamを定義する必要があります。Execution関数を実装するには、以下の手順に従ってください：

1. Actionに必要なSample Sentencesとparamを設定して保存した後、Actionの詳細ページが表示されます。Functionsタブに切り替え、Execution functionセクションのEdit Functionをクリックします。

2. ConvoKraft Delugeエディタが開き、Business Logicをコーディングしてスクリプトを保存できます。Delugeエディタの詳細については、こちらのページをご覧ください。Test this bot機能を使用して、変更を並行してテストできます。