OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Create a Simple Bot
SKILLS
Storyboard
Dialog Tasks
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Train
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Introduction
How to Configure Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Bot Versioning
Collaborative Development
Plan Management
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Create a Simple Bot
Create a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
RELEASE NOTES

データテーブルのデータの追加方法

このハウツーでは、顧客の口座関連データが保存されるデータテーブルのバンキングBotのシナリオを調査します。ユーザーから収集された必須情報を保存できる方法を確認します。データテーブルおよびKore.ai Botプラットフォームでどのように導入されているかの詳細については、こちらを参照してください

例題

以下のデータを保存する必要がある指定顧客のバンキングBotを考えてください。

  1. ID
  2. 名前
  3. メールID
  4. アドレス、および
  5. タイプ

Pre-requisites

  • Botビルドナレッジ
  • バンキングBot

設定

次の各シナリオを1つずつ考えてみましょう。

  1. 上記の要件でのデータテーブルの定義
  2. ダイアログタスク:
    1. 必須情報の収集、および
    2. サービスを呼び出し、顧客情報を更新

データテーブル設定

以下の情報を保持するデータテーブルを作成します。

  • CustId – 顧客の一意の識別子
  • CustName – 顧客名
  • CustEmail – 顧客のメールID
  • CustType – 顧客のタイプ – 通常、推奨など
  • アドレス – 顧客のアドレス

テーブル作成

  1. Kore.ai Botビルダープラットフォームにログインします。
  2. データタブを選択します。
  3. 新しいテーブルボタンをクリックします。
  4. 新しいテーブルページに、以下を入力します。
    1. 名前、たとえばcustomertable
    2. 説明、たとえば 顧客詳細を含むテーブル
  5. セクションに、以下の詳細を追加します。
    列名 タイプ 必須 追加設定
    CustId あり 暗号化および最大長5
    CustName 文字列 あり
    アドレス 文字列 なし
    CustType 文字列 なし 推奨としてのデフォルト値
    CustEmail 文字列 なし

  6. インデックスセクションに、 CustIdのインデックスを一意に追加します。
  7. 作成をクリックすると、テーブルが準備できます。
  8. Bot割当に、このテーブル、たとえばバンキングBotを使用するBotを追加し、 読み取り書き込みおよび削除権を付与します。データは削除しないため、削除権はオプションです。

ダイアログタスクの設定

必須情報を収集するダイアログタスクを作成し、サービスノードを使用して収集した値でデータテーブルを更新します。

ダイアログタスクの作成

  1. 左のナビゲーションメニューからBotタスク -> ダイアログタスクを選択します。
  2. ダイアログタスクに対して+をクリックして、新しいタスクを作成します。
    • IntentName、たとえばAddCustomerを入力します。
    • 作成および続行して、ダイアログビルダーページを開きます。
  3. インテントノードのデフォルト設定を保持し、インテントノードを閉じます。
  4. インテントノードの隣の+をクリックし、以下のように4つのエンティティを追加します。
    エンティティ名 タイプ ユーザープロンプト
    CustName 文字列 名前を入力
    CustEmail メール メールIDを入力
    CustAddress 市内 市内住所を入力
    CustType 項目リスト(列挙) 所得範囲を選択

    CustTypeは、顧客の所得レベルに基づき、基本、推奨またはプレミアムにできます。この目的のために、静的リストを使用して、以下のようにCustType値を入力しました。

  5. CustIDを生成するために、テーブルの最後の顧客IDを取得し、追加する必要があります。このため、まずテーブルからデータを取得し、スクリプトノードを使用してIDを処理します。

データの取得

サービスコールを使用して、テーブルからデータを取得できます。

  1. 最後のエンティティノードに対して、+をクリックします。
  2. サービス -> 新しいサービスノード オプションを選択します。
  3. 基本設定セクションから、以下を設定します。
    • 名前、たとえばGetLastCustId
    • 表示名、たとえば顧客データ取得
    • サービスタイプで、データサービスを選択
    • タイプで、テーブルを選択
  4. 要求定義で、要求を追加をクリックして要求を定義し、テーブルからデータを取得します。
  5. データサービス要求定義ページに、以下を入力します。
      • 顧客テーブルとしての テーブル名の選択
      • データ取得としてのアクション
  6. 定義をテストおよび保存し、サービスノードを 終了します
  7. スクリプトノードを追加して、データサービスから取得した値を処理し、以下のスクリプトを使用して次の顧客IDの値を取得します。
    var resultSet = context.GetLastCustId.response.body.queryResult; var id = 0; if (!resultSet.length) { id=1; } else { for (var i=0; i<resultSet.length; i++) { if (id < resultSet[i].CustId) { id = resultSet[i].CustId; } } id++; } context.lastID = id;
  8. これでテーブルに追加するすべての必須データがあります。

データの追加

サービスコールを使用して、テーブルにデータを追加します。

  1. 上で追加した最後のエンティティノードに対して、+ をクリックします。
  2. サービス -> 新しいサービスノード オプションを選択します。
  3. 基本設定セクションから、以下を設定します。
    • 名前、たとえばAddCustData
    • 表示名、たとえば顧客データ追加
    • サービスタイプで、データサービスを選択
    • タイプで、テーブルを選択
  4. 要求定義で、要求を追加をクリックして要求を定義し、テーブルへデータを追加します。
  5. データサービス要求定義ページに、以下を入力します。
    • 前に定義した顧客テーブルとしての テーブル名の選択
    • データ追加としてのアクション
    • 以下のように定義したエンティティから値を割り当てます。
      エンティティコンテキスト
      CustName {{context.entities.CustName}}
      CustEmail {{context.entities.CustEmail}}
      アドレス {{context.entities.CustAddress}}
      CustType {{context.entities.CustType}}
      CustId {{context.lastID}}

  6. メッセージノードを追加し、以下の応答フォーマットを使用して追加した値を表示します。 'Customer account created for: {{context.GetCustData.response.body.queryResult[0].CustName}}, {{context.GetCustData.response.body.queryResult[0].CustEmail}}, {{context.GetCustData.response.body.queryResult[0].CustAddress}}, {{context.GetCustData.response.body.queryResult[0].CustType}}'
  7. Botとの会話オプションを使用して、プロンプト表示されたら値を入力し、表示されるメッセージを確認します。

結論

この投稿では、以下を確認しました。

  • データテーブルの作成方法
  • テーブルへの列の追加
  • サービスノードを使用してテーブルからのデータの取得方法、およびそれを使用して追加処理する方法
  • サービスノードを使用してダイアログタスクからテーブルへデータを追加する方法

次のステップ

  • データテーブルを更新する方法に関するステップについては、こちらをクリックしてください。
  • デジタルフォームから取得したデータの追加方法に関するステップについては、こちらをクリックしてください。
OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Create a Simple Bot
SKILLS
Storyboard
Dialog Tasks
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Train
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Introduction
How to Configure Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Bot Versioning
Collaborative Development
Plan Management
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Create a Simple Bot
Create a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
RELEASE NOTES

How to Add Data to Data Tables

In this How-To, we will explore a scenario in a Banking Bot, where the account-related data for a customer is stored in a Data Table. We will see how the required information gathered from the user can be stored.

For details on what Data Tables are and how it is implemented in the Kore.ai Bots platform, refer here.

Problem Statement

Consider a Banking Bot, for a given customer, the following data needs to be stored:

  1. Id;
  2. Name;
  3. Email id;
  4. Address; and
  5. Type

Pre-requisites

  • Bot building knowledge;
  • A Banking Bot.

Configurations

Let us consider each of the following scenarios one by one:

  1. Define Data Table with the above requirements;
  2. Dialog Task to:
    1. gather required information; and
    2. invoke a service to update the customer information.

Data Table Configuration

Create a Data Table to hold the following information:

  • CustId – A unique identifier for a customer;
  • CustName – Name of the customer;
  • CustEmail – Email id of the customer;
  • CustType – Type of customer – Regular, Preferred, etc.
  • Address – Customer Address;

Table Creation

  1. Log in to the Kore.ai Bot Builder platform.
  2. Select the Data tab.
  3. Click the New Table button.
  4. In the New Table page enter the following:
    1. Name, say customertable;
    2. Description, say Table containing customer details;
  5. Under the Column section add the following details:
    Column Name Type Required Additional Settings
    CustId number Yes Encrypted & Max Length of 5
    CustName string Yes
    Address string No
    CustType string No Default Value as Preferred
    CustEmail string No

  6. Under the Indexes section add an index for CustId to be unique.
  7. Click Create and your table is ready.
  8. Under the Bot Assignments add the bot which would be using this table, say Banking Bot, and give Read, Write and Delete permissions. Deletepermission is optional since we would not be deleting data.

Dialog Task Configuration

We will be creating a dialog task to gather the required information, and use a Service node to update the data table with the values thus gathered.

Create Dialog Task

  1. From the left navigation menu, select Bot Tasks -> Dialog Tasks.
  2. Click the + against the Dialog Tasks to create a new Task
    • Enter IntentName, say, AddCustomer
    • Create & Proceed to open the dialog builder page.
  3. Retain the Intent Node default settings, and close the Intent Node.
  4. Click the + next to the intent node and add four Entities as follows:
    Entity Name Type User Prompts
    CustName String Enter your name
    CustEmail Email Enter your email id
    CustAddress City Enter your address city
    CustType List of items (enumerated) Select your income range

    CustType can be Basic, Preferred, or Premium based on the income level of the customer. For this purpose, we have used a static list to populate the CustType value as follows:

  5. For generating the CustID, we need to get the last customer id in the table and add one to it. For this, we will first fetch data from the table and then use a Script node to process the id.

Fetch Data

You can use a Service call to fetch data from the table:

  1. Click the + against the last entity node.
  2. Select Service -> New Service Node option.
  3. From the General Settings section configure the following:
    • Name say GetLastCustId
    • Display Name say Get Customer Data
    • Service Type select Data Service
    • Type select Table
  4. Under Request Definition click Add Request to define a request to fetch data from the table.
  5. In the Data Service Request Definition page, enter the following:
      • Choose Table Name as customertable
      • Actions as Get Data
  6. Test and Save the definition and close the service node.
  7. Add a Script node to process the values fetched from the data service to obtain the value for the next customer id using the following script:
    var resultSet = context.GetLastCustId.response.body.queryResult;
    var id = 0;
    
    if (!resultSet.length) {
        id=1;
    } else {
        for (var i=0; i<resultSet.length; i++) {
            if (id < resultSet[i].CustId) {
                id = resultSet[i].CustId;
             }
            }
        id++;    
        }
    context.lastID = id;
  8. Now we have all the required data to add to the table.

Add Data

We will be using a Service call to add data to the table:

  1. Click the + against the last Entity node added above.
  2. Select Service -> New Service Node option.
  3. From the General Settings section configure the following:
    • Name say AddCustData
    • Display Name say Add Customer Data
    • Service Type select Data Service
    • Type select Table
  4. Under Request Definition click Add Request to define a request to add data to the table.
  5. In the Data Service Request Definition page, enter the following:
    • Choose Table Name as customertable defined earlier
    • Actions as Add Data
    • Assign Values from the entities defined as follows:
      Column Entity context
      CustName {{context.entities.CustName}}
      CustEmail {{context.entities.CustEmail}}
      Address {{context.entities.CustAddress}}
      CustType {{context.entities.CustType}}
      CustId {{context.lastID}}

  6. Add a Message node to display the values added using the following response format:
    'Customer account created for: {{context.GetCustData.response.body.queryResult[0].CustName}}, {{context.GetCustData.response.body.queryResult[0].CustEmail}}, {{context.GetCustData.response.body.queryResult[0].CustAddress}}, {{context.GetCustData.response.body.queryResult[0].CustType}}'
  7. Using Talk to bot option, enter the values when prompted and see the message being displayed.

Conclusion

In this post, we have seen:

  • How to create a Data Table;
  • Add columns to the Table;
  • How to fetch the data from the table using a service node and use it for further processing;
  • How to add data to the table from the Dialog task using a service node;

Next Steps

  • Click here for steps on how to update the data table.
  • Click here for steps on how to add data obtained from the digital forms.