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

新しいボットとしてボットをインポートするAPI

[新しいボットとしてボットをインポート] は、ファイルをローカルサーバーにアップロードすることで生成されたファイルIDを使用し、アカウントオーナーのビルダーツールで新しいボットを作成するために使用されます。ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。

このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ボット定義] の [ボットをインポート] の管理APIスコープを必要とします。

ポスト https://{{host}}/api/public/bot/import

クエリパラメータ

パラメータ 説明
ホスト 環境URL(例: https://bots.kore.ai)

本文パラメータ

パラメータ 説明
botDefinition 「ボットの定義ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。
configInfo 「ボットの設定ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。
botFunctions(任意) 「ボットの機能ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。
icon 「ボットのアイコンファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。
name(任意) 「ボット名」 指定されていない場合は、既存のボットのコピーから取得されます。
purpose(任意) 「カスタマー」/「従業員」 指定されていない場合は、既存のボットのコピーから取得されます。

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ https://{{host}}/api/public/bot/import \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \ -d '{ "botDefinition" : "5b7ed3c87cab5c48ea9794f9", "configInfo" : "5b7ed2w77cab5c48ea9794fa", "botFunctions":["5b7ed13a86a5fc48f4777ea6"], "icon":"5b7ed3837cab5c48ea9794fb" }'

サンプル応答

{ "streamRefId": "f6e21f2d-cf90-52b0-bbc5-638add8dba26", "statusLogs": [ { "taskType": "importRequest", "taskName": "SampleTaskName", "status": "success" } ], "createdBy": "u-3ae8bd39-a65b-5b2c-b66b-85864a8202c3", "requestType": "Botimport", "_id": "bir-32a5ed0d-6181-5a0a-9f21-1bf872290029", "status": "pending", "createdOn": "2018-12-05T07:28:46.113Z", "__v": 0 }
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

Import Bot as a New Bot API

Import Bot as a New Bot API is used to create a new bot in the account owner’s Builder Tool using the File IDs generated by uploading the files to the local server. Refer to Upload File API on how to upload and obtain the File Id.

This API requires JWT generated by an application created only from Bot Admin Console.
To use this API, app needs the Admin API Scope of Bot Import under Bot Definition.

POST https://{{host}}/api/public/bot/import

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai

Body Parameters

Parameter Description
botDefinition “Bot definition file id”
Refer to Upload File API on how to upload and obtain the File Id.
configInfo “Bot configuration file id”
Refer to Upload File API on how to upload and obtain the File Id.
botFunctions (optional) “ Bot fuctions File id”
Refer to Upload File API on how to upload and obtain the File Id.
icon “Bot icon File id”
Refer to Upload File API on how to upload and obtain the File Id.
name (optional) “Bot name”
If not provided they will be taken from the existing bot copy
purpose (optional) “customer”/”employee”
If not provided they will be taken from the existing bot copy

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response content type

application/json

Sample Request

curl -X POST \
  https://{{host}}/api/public/bot/import \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
   -H 'content-type: application/json' \
   -d '{
  "botDefinition" : "5b7ed3c87cab5c48ea9794f9",
  "configInfo" : "5b7ed2w77cab5c48ea9794fa",
  "botFunctions":["5b7ed13a86a5fc48f4777ea6"],
  "icon":"5b7ed3837cab5c48ea9794fb"
}'

Sample Response

{
    "streamRefId": "f6e21f2d-cf90-52b0-bbc5-638add8dba26",
    "statusLogs": [
        {
            "taskType": "importRequest",
            "taskName": "SampleTaskName",
            "status": "success"
        }
    ],
    "createdBy": "u-3ae8bd39-a65b-5b2c-b66b-85864a8202c3",
    "requestType": "Botimport",
    "_id": "bir-32a5ed0d-6181-5a0a-9f21-1bf872290029",
    "status": "pending",
    "createdOn": "2018-12-05T07:28:46.113Z",
    "__v": 0
}