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

BotKit SDK のインストール

Kore.ai BotKit SDKは、Node.js アプリケーションとして動作します。独自のリバース プロキシ、ファイアウォール、ロードバランサーを追加することで、可用性、スケーラビリティ、パフォーマンスなどの関数要件を満たすことができます。このセクションでは、BotKit SDK のインストールと設定に関する詳細な概要を説明します。Kore.ai サンプル ボットを使ったインストールとセットアップの詳細なエンド ツー エンドのチュートリアルについては、Kore.ai BotKit SDK Tutorial をご覧ください。BotKit SDK をインストールするには、以下が必要です:

  • ボットを作成し、そのボットを Web/モバイル チャネル用に設定して、Kore.ai ボット プラットフォームにアプリケーションを登録します。
  • BotKit SDK ライブラリをダウンロードしてデプロイします。
  • config.json ファイルの設定を行います。

承認

BotKit SDK のインストールの前提として、Kore.ai ボットビルダー ツールを使って、SDK アプリを Kore.ai ボット プラットフォームに登録する必要があります。ボットビルダーではボットを作成し、[API 拡張] > [BotKit SDK] セクションでそのボット用のアプリを登録または作成して、アプリと ボット プラットフォーム間の通信のための相互 SSL 認証や、SDK から Kore.ai ボット プラットフォームへの API 呼出しの認証に使用される ClientIDクライアント シークレットのセキュリティ資格情報を生成することができます。 SDK の config.json ファイルでは、ボットビルダーから以下の認証キーをコピーする必要があります。

  • appId = ClientID
  • appKey ー クライアント シークレット

<span style="font-weight: 400">詳しくは、 </span><a href="/docs/bots/kore-web-sdk/sdk-app-registration/"><span style="font-weight: 400">「SDKアプリの登録」</span></a><span style="font-weight: 400">をご覧ください。</span>詳しくは SDKアプリの登録をご覧ください。

インストールとセットアップ

Kore.ai BotKit SDK のライブラリは、以下の GitHub リポジトリからダウンロードできます。https://github.com/Koredotcom/BotKit SDK を設定するには、config.json ファイルに以下のキーを定義して、BotKit を稼働させる必要があります。

キー 説明
"server": { "port": } BotKit Node.js アプリを実行するポートを指定します。
app": { "apiPrefix” : } Node.js express ルートの API パスのプレフィックスを指定します。
"credentials": { "appId": } SDK アプリの登録時に Kore ボットビルダーで生成されるクライアント ID の値です。

JWT トークンの有効期限は、デフォルトで 60 秒です。これは以下の KoreConfig の設定で変更できます:

"botkit":{ "jwt_expiry": 300 //seconds }

BotKit SDK を実行するには、ターミナル ウィンドウで、次のように入力します: node app.js

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

Installing the BotKit SDK

The Kore.ai BotKit SDK runs as Node.js application. You can add your own reverse proxy, firewall, and load balancer to meet your functional requirements for availability, scalability, and performance.
This section provides a high-level overview of BotKit SDK installation and configuration.
For a detailed end-to-end tutorial on installation and setup using our Kore.ai Sample Bots, see the Kore.ai BotKit SDK Tutorial.
To install the BotKit SDK, you will need to:

  • Register your application on the Kore.ai Bots Platform by creating a bot, and then configuring that bot for the Web/Mobile channel.
  • Download and deploy the BotKit SDK libraries.
  • Configure the config.json file.

Authorization

As a prerequisite for BotKit SDK installation, you need to register your SDK app with the Kore.ai Bots Platform using the Kore.ai Bot Builder tool.
In Bot Builder you need to create a bot, and then from API Extensions -> BotKit SDK section, register/create an app for that bot to generate the ClientID and Client Secret security credentials used for mutual SSL authentication for communication between your app and the Bots Platform and to authorize API calls from your SDK to the Kore.ai Bots Platform. 
In the config.json file in the SDK, you will need to copy the following authentication keys from Bot Builder.

  • appId = ClientID
  • appKey – Client Secret

For more information, see SDK App Registration.

Installation and Setup

The Kore.ai BotKit SDK libraries can be downloaded from the Github repository at:
https://github.com/Koredotcom/BotKit
To configure your SDK, you need to define the following keys in your config.json file to get your BotKit up and running.

Key Description
"server": {
“port”:
}
Specifies the port to run the BotKit NodeJS app .
app": {
“apiPrefix” :
}
Specifies the API path prefix to the NodeJS express route.
"credentials": {
“appId”:
}
The Client ID value generated in Kore Bot Builder when registering your SDK app.

Note that the JWT token would expire in 60 seconds, by default. You can change this using the following KoreConfig setting:

"botkit":{
       "jwt_expiry": 300 //seconds
  }

To run BotKit SDK, in a Terminal window, enter:
node app.js