このハウツーでは、Bot関数を使用して機能の一部を再利用できるバンキングBotのシナリオについてご説明します。支出レポートを関数としてプログラムし、普通預金口座とクレジットカードの両方に使用する方法を説明していきます。Bot関数とは何か、またKore.aiのBotプラットフォームにどのように実装されているかについての詳細は、こちらを参照してください。

例題

バンキングBotには、レポートタスクがあります。

1. 月次報告書は、特定の口座番号の毎月の残高を表示します。
2. クレジットカード明細書には、特定のクレジットカードの費用の概要が記載されています。
3. どちらのレポートも円グラフとして表示され、入力は月と金額の値を持つ配列となっています。

このドキュメントでは、Bot関数を使用してコーディング作業の重複を回避し、均一な表示を確保する方法を説明します。

Pre-requisites

• Botビルドナレッジ
• 動作可能なBot。ここでは、こちらのバンキングBotを使用します。
• 以下は、メッセージテンプレートを使用してデータを表示する2つの関数を含むスクリプトファイルです（メッセージテンプレートの詳細については、こちらを参照してください）。
  • tableTemplate-2次元の配列を取り、コンテンツを表形式で表示します
  • pieTemplate–2次元の配列を取り、コンテンツを円形式で表示します

  次の内容をコピーして、.jsファイル（たとえばfunctionEX.jsなど）として保存します。

  function tableTemplate(data){ var message = { "type": "template", "payload": { "template_type": "mini_table", "layout": "vertical", "text":"Monthly Balance Statement", "elements": [] } }; for (i=0; i < data.length; i++) { var j=0; var element = { "primary":[[data[i][j]],[data[i][j+1],"right"]], "additional":[[data[i][j+2],data[i][j+3]],[data[i][j+4],data[i][j+5]]] }; message.payload.elements.push(element); } return JSON.stringify(message); }; function pieTemplate(data){ var message = { "type": "template", "payload": { "template_type": "piechart", "pie_type": "regular", "text": "Monthly Expense Report", "elements": [] } }; for (i=0; i < data.length; i++) { var element = { "title": data[i][0], "value": data[i][1] }; message.payload.elements.push(element); } return JSON.stringify(message); };

導入

1. バンキングBotを開く
2. 設定 -> 構成設定からBot関数セクションを選択します。
3. インポートをクリックすると、「カスタムスクリプトのインポート」ウィンドウが開きます。
4. 「前提条件」セクションから保存したスクリプトファイルをドラッグアンドドロップするか参照して、インポートをクリックします。
5. 成功メッセージが表示されたら、完了をクリックします。
6. スクリプトファイルを使用する準備が整いました。
7. Botタスクページを開き、月次報告書という名前の新しいダイアログタスクを作成します。
   1. 口座番号と口座タイプを取得するエンティティを追加します。
   2. 理想的には、毎月の残高の詳細を取得するためのサービスコールが必要です。ここでは、デモンストレーションの目的で静的な値を使用します。
   3. スクリプトノードを追加し、次の内容を入力します（1月、2月、3月の残高を格納する配列を宣言しています）。 context.monthlyBal = [["Jan",100],["Feb",200],["Mar", 300]];
   4. メッセージノードを追加して、以前に宣言したBot関数にこのデータを送信し、レポートを取得します。
      • Botの応答セクションから応答の管理をクリックします。
      • Bot応答を追加し、ウェブ/モバイルクライアントをチャネルとして選択し、JavaScriptタブに切り替えて、次のコードを入力して値を表形式で表示します。 var info = context.monthlyBal; print(tableTemplate(info));
   5. 別のメッセージノードを追加して、以前に宣言したBot関数にこのデータを送信し、レポートを取得します。
      • Botの応答セクションから応答の管理をクリックします。
      • Bot応答を追加し、ウェブ/モバイルクライアントをチャネルとして選択し、JavaScriptタブに切り替えて、次のコードを入力して値を円グラフで表示します。 var info = context.monthlyBal; print(pieTemplate(info));
8. ダイアログタスクを閉じて、Botタスクページに戻ります。
9. 「クレジットカード明細書」という名前の新規ダイアログタスクを作成します。
   1. 口座番号を取得するエンティティを追加します。
   2. 理想的には、毎月の支出の値を取得するためのサービスコールが必要です。ここでは、デモンストレーションの目的で静的な値を使用します。
   3. スクリプトノードを追加し、次の内容を入力します（すべての月の支出値を繰り越す配列を宣言しています）。 context.monthlyExpenses = [["Jan",100],["Feb",200],["Mar", 300],["Apr",100],["May",400],["June", 500],["Jul",100],["Aug",200],["Sept", 300],["Oct",100],["Nov",100],["Dec", 300]];
   4. メッセージノードを追加して、以前に宣言したBot関数にこのデータを送信し、レポートを取得します。
      • Botの応答セクションから応答の管理をクリックします。
      • Bot応答を追加し、ウェブ/モバイルクライアントをチャネルとして選択し、JavaScriptタブに切り替えて、次のコードを入力して値を円グラフで表示します。ご覧のとおり、前のダイアログタスクで呼び出されたものと同じ関数を使用しています。 var info = context.monthlyExpenses; print(pieTemplate(info));
10. ダイアログタスクを終了します。
11. Botに話しかけ、両方のダイアログを試してみましょう。このように、同じ関数を使用して複数の場所にレポートを表示できます。

In this How-To, we will explore a scenario in a Banking Bot, where Bot Functions can be used to reuse a piece of functionality. We will see how the expenditure report can be programmed as a function and can be used for both Savings Account and Credit Card.

For details on what Bot Functions are and how they are implemented in the Kore.ai Bots platform, refer here.

Problem Statement

In our Banking Bot, we have a reporting task:

1. Monthtly Statement which gives the monthly balance amounts for a given Account number.
2. Credit Card Statement gives an overview of the expenses for a given Credit Card.
3. Both the reports are presented as pie chart and the input in both the cases is an array with month, amount values.

In this document, we will see how Bot Function can be used to avoid duplication of coding effort and ensure uniform presentation.

Pre-requisites

• Bot building knowledge
• A working bot. We will be using the Banking Bot from here.
• Following is the Script file with two functions using the message templates to display the data (see here for more on message templates):
  • tableTemplate – takes an two-dimensional array and displays the content in a tabular format
  • pieTemplate – takes an two-dimensional array and displays the content in a pie format

  Copy the following content and save it as a .js file (say, functionEX.js)

  function tableTemplate(data){
   var message = {
     "type": "template",
     "payload": {
     "template_type": "mini_table",
     "layout": "vertical",
     "text":"Monthly Balance Statement",
     "elements": []
    }
   };
   for (i=0; i < data.length; i++) {
     var j=0;
     var element = {
       "primary":[[data[i][j]],[data[i][j+1],"right"]],
       "additional":[[data[i][j+2],data[i][j+3]],[data[i][j+4],data[i][j+5]]]
     };
   message.payload.elements.push(element);
   }
   return JSON.stringify(message);
  };
  
  function pieTemplate(data){
    var message = {
     "type": "template",
     "payload": {
     "template_type": "piechart",
     "pie_type": "regular",
     "text": "Monthly Expense Report",
     "elements": []
     }
    };
   for (i=0; i < data.length; i++) {
    var element = {
     "title": data[i][0],
     "value": data[i][1]
     };
    message.payload.elements.push(element);
   }
   return JSON.stringify(message);
  };

Implementation

1. Open the Banking Bot
2. Select the Build tab from the top menu
3. From Configurations select the Bot Functions section.
4. Click Import (or Import New) to open the Import Custom Script window
5. Drag and drop or Browse the script file that you saved from the Pre-requisites section and click Import.
6. Once the success message is displayed click Done.
7. Your Script file is ready to use.
   
8. Open the Dialog Tasks page and create a New Dialog Task called “Monthly Statement”.
   1. Add entities to capture the Account Number and Account Type.
   2. Ideally, there would be a service call to fetch the monthly balance details. Here we will use static values for demonstration purposes.
   3. Add a Script node using the Bot Action and enter the following – we are declaring an array carrying the balances for the months of January, February and March:
      context.monthlyBal = [["Jan",100],["Feb",200],["Mar", 300]];
   4. Add a Message node to send this data to the Bot Function declared earlier and get the report.
      • From Bot Responses section, click Manage Responses
      • Add Bot Response, select Web/Mobile Client as the Channel, switch to JavaScript tab and enter  the following code to display the values in a tabular format:
        var info = context.monthlyBal;
print(tableTemplate(info));
   5. Add another Message node to send this data to the Bot Function declared earlier and get the report.
      • From Bot Responses section, click Manage Responses
      • Add Bot Response, select Web/Mobile Client as the Channel, switch to JavaScript tab and enter  the following code to display the values in a pie chart:
        var info = context.monthlyBal;
print(pieTemplate(info));
9. Close the dialog task and return to the Dialog Tasks page
10. Create a New Dialog Task called “Credit Card Statement”.
    1. Add entities to capture the Account Number.
    2. Ideally, there would be a service call to fetch the monthly expenditure values. Here we will use static values for demonstration purposes.
    3. Add a Script node within Bot Action node and enter the following – we are declaring an array carrying the expenditure values for all the months:
       context.monthlyExpenses = [["Jan",100],["Feb",200],["Mar", 300],["Apr",100],["May",400],["June", 500],["Jul",100],["Aug",200],["Sept", 300],["Oct",100],["Nov",100],["Dec", 300]];
    4. Add a Message node to send this data to the Bot Function declared earlier and get the report.
       • From Bot Responses section, click Manage Responses
       • Add Bot Response, select Web/Mobile Client as the Channel, switch to JavaScript tab and enter the following code to display the values in a pie chart. As you can see we are using the same function that was invoked in the previous dialog task.
         var info = context.monthlyExpenses;
print(pieTemplate(info));
11. Close the Dialog Task
12. Talk to Bot and try both the dialogs. Thus we have used the same function to display the reports in multiple places.