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

FAQの取得 – ナレッジグラフ

[ナレッジタスク] で質問とノードのリストを取得します。

このAPIを使用するために、アプリは [ナレッジグラフ] の [管理者APIスコープ] を必要とします。

GET https://{{host}}/api/public/bot/{{botId}}/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en

パスパラメータ

パラメータ 必須/任意 説明
ホスト 必須 環境URL(例: https://bots.kore.ai)
botId 必須 ボットID。ボットの [一般設定] ページからアクセスすることができます。

クエリパラメータ

パラメータ 必須/任意 説明
ktId 必須 FAQのリスト化が要求されるナレッジタスクID。
limit 任意 指定されていない場合、取得されるレコード数は50に設定されます。
offset 任意 指定されていない場合、スキップされるレコード数は0に設定されます
parentId 必須 親IDです。
withallchild 任意 子ノードを含める必要があるかどうか
type 任意 取得されるFAQのタイプです。
language 必須 ボットの言語(例:英語の「en」、ドイツ語の「de」)です。
search 任意 参照IDまたは表示名になります。

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ https://{{host}}/api/public/bot/{{bot_id}}/faqs?ktId=5afxxxxxf&limit=30&offset=0&parentId=xxxxx-xxx-xxx-xxx-xxxxx&withallchild=true&type=all&language=en \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json'

サンプル応答

{ "faqs": [ { "_id": "5e0ef00f41c79c0a7c3a729a", "subAnswers": [], "editLocked": false, "isPublished": true, "questionPayload": { "question": "銀行のインターネットバンキングとは何ですか?", "tagsPayload": [] }, "answerPayload": [ { "_id": "mt-95deca18-9b2a-5c5e-970e-566ef678e270", "channel": "default", "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "lModBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "lMod": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)", "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "createdOn": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)", "text": "銀行のインターネットバンキングとは、PCまたはタブレットを使用して、いつでもどこでも、ご自宅からでも銀行取引を行うことができる便利な方法です。", "type": "basic" } ], "knowledgeTaskId": "5afa79639466e4369e3c809f", "subQuestions": [], "responseType": "message", "referenceId" :"12xxx32", "label" :"displayname", "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "parent": "xxxxx-xxx-xxx-xxx-xxxxx", "leafterm": "yes", "language": "en", "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "lastModifiedBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "createdOn": "2020-01-03T07:41:03.017Z", "modifiedOn": "2020-01-03T07:41:03.017Z", "sortId": 1578037263017, "botName": "BankingBot", "refId": "xxxxx-xxx-xxx-xxx-xxxxx", "__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

Get FAQs – KG

To get a list of questions and nodes under the Knowledge task.

To use this API, the app needs the Admin API Scope of KnowlegdeGraph.

GET https://{{host}}/api/public/bot/{{botId}}/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en

Path Parameters

Parameter Required/Optional Description
host Required Environment URL, for example, https://bots.kore.ai
botId Required Bot ID. You can access it from the General Settings page of the bot.

Query Parameters

Parameter Required/Optional Description
ktId Required Knowledge task id from where the FAQs are required to be listed.
limit Optional Number of records to be fetched, if not provided set to 50.
offset Optional Number of records to be skipped, if not provided set to 0
parentId Required Parent id.
withallchild Optional Whether child nodes need to be included
type Optional Type of FAQs to be fetched.
language Required The bot language, for example, “en” for English and “de” for German.
search Optional Can be reference id or display name.

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/{{bot_id}}/faqs?ktId=5afxxxxxf&limit=30&offset=0&parentId=xxxxx-xxx-xxx-xxx-xxxxx&withallchild=true&type=all&language=en \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' 

Sample Response

{
    "faqs": [
        {
            "_id": "5e0ef00f41c79c0a7c3a729a",
            "subAnswers": [],
            "editLocked": false,
            "isPublished": true,
            "questionPayload": {
                "question": "What is Bank Internet Banking?",
                "tagsPayload": []
            },
            "answerPayload": [
                {
                    "_id": "mt-95deca18-9b2a-5c5e-970e-566ef678e270",
                    "channel": "default",
                    "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
                    "lModBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
                    "lMod": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)",
                    "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
                    "createdOn": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)",
                    "text": "Bank Internet banking is a convenient way to bank anytime, anywhere even from the comfort of your home using your PC or Tab.",
                    "type": "basic"
                }
            ],
            "knowledgeTaskId": "5afa79639466e4369e3c809f",
            "subQuestions": [],
            "responseType": "message",
            "referenceId" :"12xxx32",
            "label" :"displayname",
            "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
            "parent": "xxxxx-xxx-xxx-xxx-xxxxx",
            "leafterm": "yes",
            "language": "en",
            "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "lastModifiedBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "createdOn": "2020-01-03T07:41:03.017Z",
            "modifiedOn": "2020-01-03T07:41:03.017Z",
            "sortId": 1578037263017,
            "botName": "BankingBot",
            "refId": "xxxxx-xxx-xxx-xxx-xxxxx",
            "__v": 0
        }]
}