Virtual Assistants

Get KnowledgeTasks – KG

To get a listing knowledge Tasks with the nodes. To use this API, the app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/bot/{{botId}}/knowledgeTasks?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…

Get Extraction Questions – KG

To get a Get KG Extraction Questions. To use this API, app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=&offset= Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai streamId Required Bot ID or Stream ID. You can access it from the General Settings page of…

Get Extractions History – KG

To get a list of KG Extractions history. To use this API, app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/stream/{{streamId}}/qna/history?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai streamId Required Bot ID or Stream ID. You can access it from the General Settings page…

Extraction from file or URL – KG

To import the extract using file or URL. To use this API, the app needs the Admin API Scope of KnowlegdeGraph. POST https://{{host}}/api/public/bot/{{botId}}/qna/import?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…

User Engagement Trend API

To provide the number of users who have interacted with the bot in a given period across different time intervals. To use this API, the app needs the Bot Scope. POST https://{{host}}/api/public/bot/{{BotID}}/userEngagementTrend?aggregation_type={{type}}&start_date={{from}}&end_date={{to}}&channels={{channel}} Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream…

Get Analytics API

To extract the metrics data related to the intent detection and task performance using API. It can be used to retrieve metrics information related to Intents Found, Intents not Found, Failed Tasks, Successful Tasks, and Performance Logs To use this API, the app needs the Bot Scope of Metrics. POST…

Conversation Session Closure API

This API In-activates current active session based on session Id and bot Id. This API is available in the BT app scopes. To use this API, the app needs the Bot Builder API scope of Bot sessions. PUT https://{{host}}/api/public/bot/{{BotID}}/session Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotId Bot…

How to Add Data into Data Tables from Digital Forms

In this How-To, we will explore a scenario in a Banking Bot, where the user can create an additional account. We will see how data collected from the Digital Forms can be used to create the account in a Data Table. For details on what Digital Forms are and how…

Adding Data into Data Tables from UI Forms

In this How-To, we will explore a scenario in a Banking Bot, where the user can create an additional account. We will see how data collected from the UI Forms can be used to create the account in a Data Table. For details on what UI Forms are and how…

Updating 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…
Menu