Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots
Kore.ai's Approach
Kore.ai Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Kore.ai Platform
How to Access Bot Builder
Working with Kore.ai Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Deprecations
Bot Builder
Creating a Bot
Design
Develop
Storyboard
Dialog Task
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Managing Dialogs
User Prompts
Alert Tasks
Alert Tasks
Ignore Words and Field Memory
Digital Forms
Digital Views
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Small Talk
Action & Information Task
Action Tasks
Information Tasks
Establishing Flows
Natural Language
Overview
Machine Learning
ML Model
Fundamental Meaning
NLP Settings and Guidelines
Knowledge Graph Training
Traits
Ranking and Resolver
NLP Detection
Advanced NLP Configurations
Bot Intelligence
Overview
Context Management
Session and Context Variables
Context Object
Dialog Management
Sub-Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Publishing your Bot
Analyzing your Bot
Overview
Dashboard
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Data Table
Universal Bots
Defining
Creating
Training
Customizing
Enabling Languages
Smart Bots
Defining
Sample Bots
Github
Asana
Travel Planning
Flight Search
Event Based Bot Actions
koreUtil Libraries
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Manage Sessions
Bot Management
Bot Versioning
Using Bot Variables
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
Bot Administration
Bots Admin Console
Dashboard
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Enrollment
Inviting Users
Bulk Invites
Importing Users
Synchronizing Users from AD
Security & Compliance
Using Single Sign-On
Security Settings
Cloud Connector
Analytics
Billing
How Tos
Creating a Simple Bot
Creating a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure Digital 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
  1. Home
  2. Docs
  3. Bots
  4. Bot Building
  5. Knowledge Graph
  6. ボットオントロジーのインポートとエクスポート

ボットオントロジーのインポートとエクスポート

ナレッジグラフを CSV または JSON 形式のファイルで構築して、ボットにアップロードすることができます。同様に、既存のナレッジグラフを CSV または JSON 形式でエクスポートすることができます。ナレッジグラフをエクスポートすると、スプレッドシートで編集したり、他のボットにインポートしたりすることができるようになります。

FAQ の数には最大 50,000 件、ノードの数には最大 20,000 個のプラットフォーム制限があります。この制限を超える数のファイルのインポートは拒否されます。

ナレッジグラフのインポート

  1. ナレッジグラフを開きます。
  2. ナレッジグラフの [インポート] オプションが表示されます。
  3. [インポート] をクリックします。
  4. 以下のうちいずれかを実行します。
    • ナレッジグラフを初めから作成する場合は、[続行] をクリックします。または、
    • 既存のナレッジグラフが存在する場合は、その CSV または JSON 形式のファイルのバックアップが保存されていることを確認してから、[続行] をクリックします。
      注意: ナレッジグラフのインポートは、既存のナレッジグラフを更新するのではなく全体を上書きします。
  5. [インポート] ウィンドウにファイルをドラッグアンドドロップするか、[参照] をクリックしてファイルを選択します。
  6. [次へ] をクリックして、インポートを開始します。
  7. インポートが完了すると、完了メッセージがダイアログに表示されます。[完了] をクリックします。
  8. ナレッジグラフに階層が表示され、編集やトレーニングができるようになります。

ナレッジグラフのエクスポート

ナレッジグラフをエクスポートするには、

  1. ナレッジグラフを開きます。
  2. ナレッジグラフのエクスポートオプションが表示されます。
  3. 希望する形式に応じて、[CSV でエクスポート] または [JSON でエクスポート] をクリックします。
  4. ナレッジグラフのファイルがパソコンにダウンロードされます。

ナレッジグラフの作成

プラットフォームの UI でナレッジグラフを作成する代わりに、スプレッドシードや JSON 形式で作業したい場合があります。プラットフォーム上でナレッジグラフをスプレッドシートで作成するか、JSON 形式で作成するかを選択してボットにインポートすることができます。

次のステップを実行します。

  1. サンプル CSV または JSON ファイルをダウンロードします。サンプルファイルは、空のナレッジグラフからもダウンロードできます。
  2. 質問、応答、同義語などに対応する行を追加して、ファイルを編集します。
  3. ファイルをボットにインポートします。

CSV ファイルからのインポート

ボットからダウンロードできるサンプルスプレッドシートを使って、ナレッジグラフを作成することができます。ナレッジグラフを頻繁に変更することが予想される場合は、スプレッドシートで作成しておくとアプリケーションの UI よりも一括更新が容易になります。

ナレッジグラフをスプレッドシートで作成するには、以下の手順に従います。

サンプル CSV ファイルのダウンロード

  1. ナレッジグラフを開きます。
  2. 左側のセクションで、[インポート] をクリックします。
  3. 続行する前にナレッジグラフのバックアップの作成を求める画面が表示されます。CSV または JSON のいずれかのバックアップファイル形式を選択します。
  4. バックアップが作成できたら、[続行] をクリックします。
  5. 次のダイアログで、[サンプル CSV] を選択します。CSV ファイルがローカルコンピューターにダウンロードされます。

CSV でのナレッジグラフの構築 (リリース 7.3 以降)

ボットプラットフォームのバージョン 7.3 以降、CSV ファイルのフォーマット変更により代替の回答、拡張応答、高度な応答に対応しました。以前のフォーマットについては、以下をご覧ください。以前のフォーマットは今後のリリースで非推奨となる可能性があるため、新しいフォーマットのご利用を強くお勧めします。

  • 以下の種類のエントリに対応しています。
    • FAQ − 質問と回答のリーフレベルノードです。
    • ノード − ノード/タグ、トレイト、前提条件、出力コンテキストなどを指します。
    • 同義語
    • ナレッジグラフパラメータ
    • トレイト
  • 上記のカテゴリはいずれも、適切なヘッダーで始まっている必要があります。
  • プラットフォームは、JSON ファイルのバージョンが新しいのか古いのかをヘッダーで特定します。

以下に、それぞれのセクションについての詳細情報と期待される内容を説明しています。

FAQ

FAQは質問と回答およびそれらの代替質問、代替回答と拡張回答です。

それぞれの詳細を以下の表に示します。

  • FAQ − ヘッダーの必須項目です。それ以下の行では空白になっていなければなりません。
  • Que ID − 質問ごとにプラットフォームが生成する、質問 IDです。
  • パス − その項目が属する FAQ までのパスです。
    • 必須のノード名は「**」で始まり、
    • オーガナイザーノード名は「!!」で始まっていなければなりません。
  • プライマリの質問 − ユーザーの問い合わせとして予想される質問です。空白にすると、回答列の内容が前のプライマリの質問の代替回答とみなされます。
  • 代替質問 − オプション − プライマリの質問の代替質問です。代替質問が複数ある場合は、それぞれ別の行に入力されている必要があります。
  • タグ − それぞれの質問と代替質問に付与します。
  • 回答 − 質問に対する回答です。プライマリの質問フィールドを空白にすると、代替回答として扱われます。回答のフォーマットは、
    • テキスト形式
    • 「SYS_SCRIPT」のプレフィックスがついたスクリプト (例: SYS_SCRIPT <JavaScript 形式の回答>)
    • 「SYS_CHANNEL_<チャネル名>」のプレフィックスがついたチャネル別形式の回答。回答はシンプルまたはスクリプト形式が利用できます。
      • SYS_CHANNEL_<チャネル名> SYS_TEXT <回答>
      • SYS_CHANNEL_<チャネル名> SYS_SCRIPT <JavaScript 形式の回答>
    • ダイアログをトリガーし、SYS_INTENTのプレフィックスを付与します。 (例: SYS_INTENT )
  • 拡張回答 − 1 − 応答が長くなる場合にオプションとして使用します。
  • 拡張回答 − 2 − 応答が長くなる場合にオプションとして使用します。

ノード

このセクションは、ノードとタグの設定で構成されています。

  • ノード − ヘッダーの必須項目です。それ以下の行では空白になっていなければなりません。
  • Que ID − タグの設定を指定する際に必須となる項目です。ノードの場合は空白にしておきます。
  • ノードパス − ノード/タグに到達するまでのパスです。
  • タグ − タグの設定に必須となる項目です。ノードの場合は空白にしておきます。
  • 前提条件 − このノード/タグの条件を指定します。
  • 出力コンテキスト − このノード/タグにより設定されるコンテキストです。
  • トレイト − このノード/タグのトレイトです。

同義語

このセクションで、同義語をキーと値のペアで入力します。

  • 同義語 − ヘッダーの必須項目です。それ以下の行では空白になっていなければなりません。
  • フレーズ − 同義語が挿入されるフレーズです。
  • 同義語 − コンマで区切られた値です。

ナレッジグラフの用語識別におけるボットの同義語の使用は、以下を使用して有効にすることができます。

  • 確信度設定 − ヘッダーの必須項目です。それ以下の行では空白になっていなければなりません。
  • パラメータ − この場合は、「useBotSynonyms」となります。
  • 値 − TRUE または FALSEの値です。

ナレッジグラフパラメータ

  • ナレッジグラフパラメータ − ヘッダーの必須項目です。それ以下の行では空白になっていなければなりません。
  • 言語 − ボットの言語コードです。英語であれば「en」となります。
  • ストップワード − コンマで区切られた値です。

トレイト

トレイトに関連した情報は、以下のように指定できます。

  • トレイト − ヘッダーの必須項目です。それ以下の行では空白になっていなければなりません。
  • 言語 − ボットの言語コードです。英語であれば「en」となります。
  • グループ名 − トレイトのグループ名です。
  • 一致戦略 − 機械学習ベースのパターンまたは確率です。
  • スコアしきい値 − 上層の一致戦略が機械学習ベースに設定されている場合のしきい値 (0 から 1 までの間で指定) です。
  • トレイト名 − トレイトの名前です。
  • トレーニングデータ − トレイトのための発話です。

JSONファイルからのインポート

Kore.ai では、ナレッジグラフを JSON 形式で作成してアップロードすることができます。ボットからサンプル JSON をダウンロードして、その構造を確認してください。

JSON でナレッジグラフを作成するには、以下の手順に従います。

サンプル JSON のダウンロード

  1. ナレッジグラフを開きます。
  2. 左側のセクションで、[インポート] をクリックします。
  3. 続行する前にナレッジグラフのバックアップを作成することを求める画面が表示されます。CSV または JSON のいずれかのバックアップファイル形式を選択します。
  4. バックアップが作成できたら、[続行] をクリックします。
  5. 次のダイアログで、[サンプル JSON] を選択します。JSON ファイルがローカルコンピューターにダウンロードされます。

JSON リファレンス

プロパティ名 タイプ 説明
FAQ 配列 以下で構成されます。

  • 質問
  • 回答
  • パス内の第 1 レベルのノードまでのリーフと親の用語
  • 代替質問
質問 文字列 FAQ 配列に含まれるプライマリの質問です。
回答 文字列 FAQ 配列に含まれるボットの応答です。
用語 配列 質問が追加されるリーフノードとその第 1 レベルのノードまでの親を含みます。
代替質問 配列 代替質問と用語で構成されます。リーフから第 1 レベルのノードまでの用語を含みます。
同義語 オブジェクト 用語とその同義語の配列で構成されます。
非マッピングパス 配列 質問と第 1 レベルまでのすべての親を含まないノードの配列で構成されます。
トレイト オブジェクト キーとしてのトレイト名と、値としての発話の配列で構成されます。

CSV でのナレッジグラフの構築 (リリース 7.3以前)

注意: このフォーマットは今後のリリースで非推奨となります。

ダウンロードしたサンプル CSV ファイルを開きます。

CSV ファイルの各行に入力する内容は、情報の種類によって異なります。たとえば、FAQ (質問、回答、ノード、代替質問) に必要な内容は同義語 (用語、同義語) に必要な内容とは異なります。

ボットは、行の 1 列目にある情報の種類に基づいて CSV ファイルの各行にあるデータを解釈します。以下は、異なる情報の種類を表す CSV ファイルの 1 列目の有効なエントリです。

  • FAQ: ナレッジグラフのプライマリまたは代替質問を表します。
  • 非マッピングパス: 質問が関連付けられていないノードを表します。
  • 同義語: 用語のグローバル同義語を表します。
  • クラス: トレイト名と、それに関連付けられた発話を表します。

重要なメモ
以下のボットエレメントについては、CSV やスプレッドシートを使用してインポートまたはエクスポートすることができません。

  • 代替応答: スプレッドシートは FAQ の代替質問の入力に対応していますが、代替応答の入力やボットへのインポートはできません。
  • 分割応答: 複数の連続メッセージに分割された FAQ 応答を入力またはインポートすることはできません。
  • 高度な応答: CSV インポートは、JavaScript を使用して高度な応答モードで記述された応答には対応していません。

以下のセクションでは、各情報タイプに必要な詳細の残りの部分について説明します。

FAQ

プライマリの質問



注意
: パス内の第 1 レベルノードまでのすべての親ノードの名前を、別々の列に入力してください。

代替質問

注意: 代替質問は、それぞれプライマリの質問の下の別々の行に入力してください。

 

用語/タグ

  • 必須のタグと用語にはプレフィックス「**」を付与します。
  • オーガナイザータグと用語にはプレフィックス「!!」を付与します。

非マッピングパス

非マッピングパスは、質問が追加されていないノードを参照します。

注意: 第 1 レベルノードまでの階層のすべての親ノードの名前を入力してください。ルートノード名を入力するとそれ以下を複製してしまうため、ルートノード名は入力しないでください。

グローバル同義語

注意: 同義語はそれぞれ別の列に入力してください。

 

パス同義語

トレイト

用語またはタグをトレイトに関連付けるには、次のエントリを使用します。<tag/term-name>:<class-name>>
注意: 発話はそれぞれ別の列に入力してください。

Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots
Kore.ai's Approach
Kore.ai Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Kore.ai Platform
How to Access Bot Builder
Working with Kore.ai Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Deprecations
Bot Builder
Creating a Bot
Design
Develop
Storyboard
Dialog Task
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Managing Dialogs
User Prompts
Alert Tasks
Alert Tasks
Ignore Words and Field Memory
Digital Forms
Digital Views
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Small Talk
Action & Information Task
Action Tasks
Information Tasks
Establishing Flows
Natural Language
Overview
Machine Learning
ML Model
Fundamental Meaning
NLP Settings and Guidelines
Knowledge Graph Training
Traits
Ranking and Resolver
NLP Detection
Advanced NLP Configurations
Bot Intelligence
Overview
Context Management
Session and Context Variables
Context Object
Dialog Management
Sub-Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Publishing your Bot
Analyzing your Bot
Overview
Dashboard
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Data Table
Universal Bots
Defining
Creating
Training
Customizing
Enabling Languages
Smart Bots
Defining
Sample Bots
Github
Asana
Travel Planning
Flight Search
Event Based Bot Actions
koreUtil Libraries
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Manage Sessions
Bot Management
Bot Versioning
Using Bot Variables
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
Bot Administration
Bots Admin Console
Dashboard
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Enrollment
Inviting Users
Bulk Invites
Importing Users
Synchronizing Users from AD
Security & Compliance
Using Single Sign-On
Security Settings
Cloud Connector
Analytics
Billing
How Tos
Creating a Simple Bot
Creating a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure Digital 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
  1. Home
  2. Docs
  3. Bots
  4. Bot Building
  5. Knowledge Graph
  6. Importing and Exporting Bot Ontology

Importing and Exporting Bot Ontology

You can build a Knowledge Graph in a CSV or JSON file and upload it to a bot. Similarly, you can export the existing Knowledge Graph to CSV or JSON. Exporting a Knowledge Graph helps you edit it in a spreadsheet or import it to another Bot.

There is a platform restriction of a maximum of 50k FAQs spread across a maximum of 20k nodes. Import of files exceeding these numbers is rejected.

Importing Knowledge Graph

  1. On the left pane, click Bot Tasks > Knowledge Graph.
  2. You can find the Import option on the respective Knowledge Graph.
  3. Click Import.
  4. On the Import dialog box, do one of the following:
    • If you are creating the Knowledge Graph from scratch, click Proceed.
      (or)
    • If you have an existing Knowledge Graph, make sure to take a backup of the same to a CSV or JSON file, and then Proceed.
      Note: Importing a Knowledge Graph does not update it but replaces the entire existing Knowledge Graph.
  5. Drag and drop the file in the Import window or click Browse to locate the file.
  6. Click Next to begin the import.
  7. After the import is complete, the success message appears in a dialog box. Click Done.
  8. The hierarchy is displayed in the Knowledge Graph and you can edit and train the same.

Exporting Knowledge Graph

To export a Knowledge Graph, follow the below steps:

  1. On the left pane, click Bot Tasks > Knowledge Graph.
  2. You can find the Export option on the respective Knowledge Graph.
  3. Based on the preferred format: click Export JSON or Export CSV.
  4. The Knowledge Graph file is downloaded to your machine.

Creating a Knowledge Graph

Instead of creating the Knowledge Graph from the platform UI, you can work in your preferred editor like Spreadsheet or as a JSON file. The platform gives you the option to create a Knowledge Graph in a spreadsheet or JSON and use the same to import it into the bot.

To import, follow the below steps:

  1. Download sample CSV or a JSON file. You can download these sample files from a blank Knowledge Graph too.
  2. Edit the file by adding rows corresponding to the questions, responses, synonyms, etc.
  3. Import the file to your bot.

From a CSV File

You can create the Knowledge Graph using a sample spreadsheet that you can download from the bot. If you anticipate frequent changes to the Knowledge Graph, we recommend you to create it in a spreadsheet as it is easier to perform bulk updates compared to the application UI.

Follow the instructions below to build your Knowledge Graph in a spreadsheet.

Download the Sample CSV file

  1. On the left pane, click Bot Tasks > Knowledge Graph.
  2. You can find the Import option on the respective Knowledge Graph.
  3. You are prompted to back up the Knowledge Graph before proceeding. Choose the CSV or JSON format for the backup.
  4. After backup, click Proceed.
  5. On the corresponding dialog box, click Sample CSV. The CSV file is downloaded to your local computer.

Build the Knowledge Graph in a CSV (post v7.3)

The format for the CSV file is modified in v7.3 of the bots platform to cater for details regarding alternate answers, extended responses, and advanced responses. See below for the older format.  You are strongly recommended to use the new format since the older format will be deprecated in the upcoming releases.

  • The following types of entries are supported:
    • Faq – The leaf level nodes with questions and answers.
    • Node – For node/tags, traits, preconditions, and output context.
    • Synonyms
    • KG Params
    • Traits
  • Each of the above categories needs to be preceded by the appropriate header.
  • The header helps identify the new vs old versions of the JSON file by the platform.

The following is the detailed information for each section and the content expected for each.

FAQ

This contains the actual questions and answers along with the alternate questions, answers, and extended answers.

Following are the column-wise details that can be given:

  • Faq – Mandatory entry in the header, must be left blank in the following rows.
  • Que ID – The question ID generated by the platform for each question.
  • Path – To which the FAQ belongs
    • Mandatory node names must be prefixed with ** and organizer nodes with !!
  • Primary Question – The actual question user might ask: When left blank, the entry in the Answer column is considered as the alternative answer to the previous primary question.
  • Alternate Question – Optional: Alternate question to the primary question if there are multiple alternate questions, they must be given in multiple rows.
  • Tags – For each question or alternate question.
  • Answer – Answer to the question serves as an alternate answer when the primary question field is left blank. Answer format can be:
    • Plain text
    • Script with SYS_SCRIPT prefix i.e. SYS_SCRIPT <answer in javascript format>
    • Channel-specific formatted response when prefixed with SYS_CHANNEL_<channel-name>, the answer can be simple or in script format:
      • SYS_CHANNEL_<channel-name> SYS_TEXT <answer>
      • SYS_CHANNEL_<channel-name> SYS_SCRIPT <answer in javascript format>
    • Trigger a dialog then prefix with SYS_INTENT i.e. SYS_INTENT <dialog ref id>
  • Extended Answer-1: Optional to be used in case the response is lengthy.
  • Extended Answer-2: Optional to be used in case the response is lengthy.

Nodes

This section includes settings for both nodes and tags.

  • Node – Mandatory entry in the header must be blank in the following rows.
  • Que ID – Mandatory when specifying settings for tags, leave blank for nodes.
  • Nodepath – Path for reaching the node/tag.
  • Tag – Mandatory for tag settings, leave blank for node.
  • Precondition – For qualifying this node/tag.
  • outputcontext – Context to be populated by this node/tag.
  • Traits – for this node/tag.

Synonyms

Use this section to enter the synonyms as key-value pairs.

  • Synonyms – Mandatory entry in the header, must be blank in the following rows.
  • Phrase – for which the synonym needs to be entered.
  • Synonyms – Comma-separated values.

Use of bot synonyms in KG term identification can be enabled using the following:

  • confidenceConfigs – Mandatory entry in the header, must be blank in the following rows.
  • parameter – useBotSynonyms in this case
  • value – true or false

KG Params

  • KG Params – mandatory entry in the header, must be blank in the following rows.
  • lang – Bot language code. For example, en for English.
  • stopwords – Comma-separated values.

Traits

Trait related information can be specified as follows:

  • Traits – Mandatory entry in the header, must be blank in the following rows.
  • lang – Bot language code. For example, en for English.
  • GroupName – Trait group name.
  • matchStrategy – Pattern or probability (for ML-based).
  • scoreThreshold – Threshold value (between 0 and 1) when the matchStrategy above is set to ML-based.
  • TraitName – The name of the trait.
  • Training data – Utterances for the trait.

From a JSON file

Kore.ai allows you to create the Knowledge Graph in JSON and upload it. You can download a sample JSON from the bot to understand its structure.

Follow the instructions below to build your Knowledge Graph using JSON:

Downloading the JSON sample

  1. On the left pane, click Bot Tasks > Knowledge Graph.
  2. You can find the Import option on the respective Knowledge Graph.
  3. You are prompted to back up the Knowledge Graph before proceeding. Choose the CSV or JSON format for the backup.
  4. After backup, click Proceed.
  5. On the corresponding dialog box, click Sample JSON. The JSON file is downloaded to your local computer.

JSON Reference

Property Name Type Description
FAQ Array Consists of the following:

  • Question
  • Answer
  • Leaf and parent terms up to the First-level node in the path
  • Alternative question
Question String Primary question; included in the FAQ array.
Answer String Bot response; included in the FAQ array.
Terms Array Includes the leaf node to which the question is added, and its parents up to the First-level node.
Alternate Questions Array Consists of alternative question and terms. Include terms from leaf to the First-level node.
Synonyms Object Consists of arrays of terms and their synonyms.
Unmappedpath Array Consists of arrays of nodes that do not have any questions, and all their parents up to the First-level node.
Traits Object Consists of trait names as keys and an array of utterances as values.

Building the Knowledge Graph in a CSV (before v7.3)

NOTE: This format will be deprecated in upcoming releases.

Open the downloaded Sample CSV file.

The details that you need to enter in each row of the CSV file differ based on the type of information. For example, the details you need to enter for an FAQ (Question, Answer, Nodes, Alternate Questions) differ from the details you need to enter for Synonyms (Term, Synonyms).

The bot interprets the data present in each row of the CSV file, depending on the information type specified in Column # 1 of the row. Below are the valid entries for Column#1 of the CSV file, which represent the different information types:

  • faq: Represents a primary or alternate question in the Knowlege Graph.
  • unmappedpath: Represents nodes with no questions associated with them.
  • synonyms: Represents global synonyms for terms.
  • classes: Represents the trait names and their associated utterances.

Important Notes
You cannot import or export the following bot elements using a CSV or spreadsheet.

  • Alternative Responses: While the spreadsheet support entering alternative questions for an FAQ, you cannot enter alternative responses in the spreadsheet and import them into the bot.
  • Split Responses: You cannot enter or import FAQ responses that are split into multiple consecutive messages.
  • Advanced Responses: The CSV import does not support responses written in the advanced mode using JavaScript.

The following sections provide the remaining details that you must fill in for each information type:

FAQ

Primary Question



Note
: Enter the names of all the parent nodes in separate columns until you reach the First-level node in the path.

Alternate Questions

Note: You need to enter each alternative question in a separate row below the primary question.

 

Terms/Tags

  • Mandatory tags and terms can be prefixed with **
  • Organizer tags and terms can be prefixed with !!

Unmappedpath

Unmappedpath refers to nodes for which no question is added.

Note: Enter the names of all parent nodes in the hierarchy up to the First-level node. Do not enter the name of the root node as it creates a duplicate node below the root node.

Global Synonyms

Note: Enter each synonym in a separate column.

 

Path Synonyms

Traits

To associate a term or tag with a trait use the entry as: <tag/term-name>:<class-name>>
Note: Enter each utterance in a separate column.

Menu