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を考えてください。このデータは顧客の要求により更新する必要があります。顧客はメールIDおよびアドレス詳細のみを更新できます。

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

Pre-requisites

  • Botビルドナレッジ
  • 上記テーブルへのアクセス権付きバンキングBot、そのテーブルにあるデータ(データを作成および追加するユースケースは、こちらを参照してください)。

設定

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

  1. ダイアログタスク:
    1. 必須情報の収集、および
    2. サービスを呼び出し、顧客情報を更新

ダイアログタスクの設定

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

ダイアログタスクの作成

  1. 左のナビゲーションメニューからBotタスク -> ダイアログタスクを選択します。
  2. ダイアログタスクに対して+をクリックして、新しいタスクを作成します。
    • IntentName、たとえばUpdateCustomerを入力します。
    • 作成および続行して、ダイアログビルダーページを開きます。
  3. インテントノードのデフォルト設定を保持し、インテントノードを閉じます。
  4. インテントノードの隣の+をクリックし、エンティティを追加して顧客IDを取得します。
    エンティティ名 タイプ ユーザープロンプト
    CustId 文字列 顧客IDの入力
  5. 最初に、指定した顧客IDのテーブルからデータを取得し、ロジックノードを使用してプロセスフローを制御します。

データの取得

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

  1. エンティティノードに対して、+をクリックします。
  2. サービス -> 新しいサービスノード オプションを選択します。
  3. 基本設定セクションから、以下を設定します。
    • 名前、たとえばGetCustomerData
    • 表示名、たとえば顧客データ取得
    • サービスタイプで、データサービスを選択
    • タイプで、テーブルを選択
  4. 要求定義で、要求を追加をクリックして要求を定義し、テーブルからデータを取得します。
  5. データサービス要求定義ページに、以下を入力します。
    • 顧客テーブルとしての テーブル名の選択
    • データ取得としてのアクション
    • フィルタを選択して CustId = {{context.entities.CustId}}を選択

  6. 定義を保存し、サービスノードを 閉じます
  7. 1つのレコードのみをフェッチし、行に対する静的 [0] 参照を使用しているため、メッセージノードを追加し、 以下のコンテキスト変数を使用してレコードの取得を表示します。 'For the customer number entered, we have the following details: {{context.GetCustomerData.response.body.queryResult[0].CustName}}, {{context.GetCustomerData.response.body.queryResult[0].CustEmail}}, {{context.GetCustomerData.response.body.queryResult[0].Address}}, {{context.GetCustomerData.response.body.queryResult[0].CustType}}'

データの更新

エンティティノードとロジックノードを使用して、顧客からの入力を取得し、プロセスフローを制御します。

  1. 上で追加した最後のメッセージに対して、+ をクリックします。
  2. エンティティノードを選択し、以下が設定された項目リスト(列挙) 型エンティティを追加します。
    表示名
    メールID メールID
    アドレス アドレス
  3. ロジックノードを追加し、上のエンティティノードからの値に基づき、顧客からメールIDまたはアドレスのいずれかを取得します。このCustEmail および CustAddressは、顧客のメールIDおよび顧客のアドレスを取得するエンティティです。
  4. コンテキスト変数も現在の詳細で入力し、これらの変数はデータテーブルを更新するために使用されます。
  5. メールIDおよびアドレスから、エンティティはスクリプトノードをトリガーし、以下のスクリプトを使用して適切にコンテキスト変数を変更します。
    if (context.entities.CustUpdateChoice == 'Address') { context.custAdd = context.entities.CustAddress; } else { context.custEmail = context.entities.CustEmail; }
  6. サービス -> 新しいサービスノード オプションを選択します。
  7. 基本設定セクションから、以下を設定します。
    • 名前、たとえばUpdateCust
    • 表示名、たとえばUpdate Customer Data
    • サービスタイプで、データサービスを選択
    • タイプで、テーブルを選択
  8. 要求定義で、要求を追加をクリックして要求を定義し、テーブルへデータを追加します。
  9. データサービス要求定義ページに、以下を入力します。
    • 前に定義した顧客テーブルとしての テーブル名の選択
    • データ更新としてのアクション
    • 以下のように定義されたエンティティからの値の割り当て。 すべてのフィールドとその値を含める必要があることを覚えておいてくださいい。そうしないと、フィールドはnul値に設定されます。
      エンティティコンテキスト
      CustName {{context.CustName}}
      CustEmail {{context.CustEmail}}
      アドレス {{context.CustAddress}}
      CustType {{context.CustType}}
      CustId {{context.CustId}}

  10. メッセージノードを追加して、成功メッセージを表示します。
  11. 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 Update Data in 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 data can be updated by a request from the user.

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 is stored. This data needs to be updated as per customer request. Customers can update only email id and address details.

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

Pre-requisites

  • Bot building knowledge;
  • A Banking Bot with access to the above-mentioned table, and data existing in that table (refer here for use case example to create and add data).

Configurations

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

  1. Dialog Task to:
    1. gather required information; and
    2. invoke a service to update the customer information.

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, UpdateCustomer
    • 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 an Entities to capture the customer id:
    Entity Name Type User Prompts
    CustId String Enter your customer id
  5. First, we will fetch data from the table for the given Cust Id and then use a Logic node to control the process flow.

Fetch Data

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

  1. Click the + against the entity node.
  2. Select Service -> New Service Node option.
  3. From the General Settings section configure the following:
    • Name say GetCustomerData
    • 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
    • Choose Filters to select the CustId = {{context.entities.CustId}}

  6. Save the definition and close the service node.
  7. Add a Message Node to display the records fetches using the following context variable values, since we are fetching only one record, we are using a static [0] reference to the row:
    'For the customer number entered, we have the following details: {{context.GetCustomerData.response.body.queryResult[0].CustName}}, {{context.GetCustomerData.response.body.queryResult[0].CustEmail}}, {{context.GetCustomerData.response.body.queryResult[0].Address}}, {{context.GetCustomerData.response.body.queryResult[0].CustType}}'

Update Data

We will be using an entity node and a logic node to capture the inputs from the customer and to control the process flow:

  1. Click the + against the last message node added above.
  2. Select an Entity Node and add a List of Items (enumerated) type entity with the following settings.
    Display Name Value
    Email Id Email Id
    Address Address
  3. Add a Logic Node and based upon the value from the entity node above fetch either Email ID or Address from the customer, here CustEmail and CustAddress are the entities to capture customer email id and customer address.
  4. Also populate the context variables with the current details, these variables would be used to update the data table.
  5. From the Email Id and Address entity trigger a Script Node to modify the context variables appropriately using the following script:
    if (context.entities.CustUpdateChoice == 'Address') {
        context.custAdd = context.entities.CustAddress;
      }
    else {
       context.custEmail = context.entities.CustEmail;
     }
  6. Select Service -> New Service Node option.
  7. From the General Settings section configure the following:
    • Name say UpdateCust
    • Display Name say Update Customer Data
    • Service Type select Data Service
    • Type select Table
  8. Under Request Definition click Add Request to define a request to add data to the table.
  9. In the Data Service Request Definition page, enter the following:
    • Choose Table Name as customertable defined earlier
    • Actions as Update Data
    • Assign Values from the entities defined as follows, remember you need to include all the fields and their values, else the field would be set to null value:
      Column Entity context
      CustName {{context.CustName}}
      CustEmail {{context.CustEmail}}
      Address {{context.CustAddress}}
      CustType {{context.CustType}}
      CustId {{context.CustId}}

  10. Add a Message node to display the success message.
  11. 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 fetch the data from the table using a service node and use it for further processing;
  • How to update data to the table from the Dialog task using a service node;