APIリスト

以下は、Kore.aiボットプラットフォームで利用できるAPIのリストです。APIの機能や使用方法の詳細はこちらを参照してください。

これらのAPIは、Postmanの設定でのテストに使用することができます。設定の詳細については、こちらをご確認ください。対応する機能に基づいて、APIは次のように分類されます。

ボット定義機能に関連するAPI。詳細
NLPトレーニングに関連するAPI。詳細
ボットのパフォーマンスや動作を分析するのに役立つAPI。詳細
管理者コンソールの機能に関連するAPI。詳細
データテーブルからのデータアクセスに関連するAPI。詳細

ボット定義API

API	説明	関連するアプリのスコープ
		ボットビルダー	ボット管理
ファイルをアップロード	`botdefinition`、`botconfig`、`botfunction`ファイル（あれば）、およびボットアイコンをローカルサーバーにアップロードし、インポートボットAPIで使用するファイルIDを取得します。	NA	[ボット定義] の [ボットをインポート]
新しいボットとしてボットをインポート	ファイルをアップロードすることで生成されたファイルIDを使用し、アカウントオーナーのビルダーツールで新しいボットを作成します。	NA	[ボット定義] の [ボットをインポート]
既存のボットにボットをインポートする	新バージョンへのアップグレードまたは旧バージョンへの復元のために、既存のボットにボット定義ファイルをインポートします。	NA	[ボット定義] の [ボットをインポート]
ボットのインポートのステータス	ボットのインポートリクエストのステータスを取得します。	NA	[ボット定義] の [ボットをインポート]
サンプルボットをインストール	サンプルボットをインストールします。	NA	[ボット定義] の [ボットを作成]
ボットのエクスポート	ボット定義および関連するすべてのコンポーネントをエクスポートします。	ボットのエクスポート	[ボット定義] の [ボットのエクスポート]
ボットのエクスポート – ステータス	ボットのエクスポートリクエストのステータスを取得し、エクスポートが完了した後に、ボットのエクスポートコピーのダウンロードリンクを提供します。	ボットのエクスポート	[ボット定義] の [ボットのエクスポート]
チャネルの有効化	ボットのチャネルを有効化または更新します。	NA	[ChannelManagement] の [チャネル管理]
ボットを公開	ボットへの公開リクエストを開始します。	NA	[ボットを公開] の [公開]
ボット変数のインポート	グローバル変数やコンテンツ変数をボットにインポートします。	変数をインポート	NA
バッチテストの実行	バッチテストスイートの実行を呼び出します。	バッチテストの実行	NA
バッチテストの実行のステータス	一意のテストリクエストIDに対する実行のステータスを把握します。	バッチテストの実行	NA
バッチテストスイートを取得	あるボットで利用可能なバッチテストスイートのリストを取得します	バッチテストの管理	バッチテストの管理
バッチテストスイートをエクスポート	特定のバッチテストスイートのテストケースをエクスポートします	バッチテストの管理	バッチテストの管理
バッチテストスイートをインポート	バッチテストスイートをインポートします	バッチテストの管理	バッチテストの管理
バッチテストスイートを削除	バッチテストスイートを削除します	バッチテストの管理	バッチテストの管理
バッチテストスイートの抽出を削除	バッチテストスイートの特定の実行を呼び出します。	バッチテストの管理	バッチテストの管理

NLPトレーニングAPI

API	説明	関連するアプリのスコープ
		ボットビルダー	ボット管理
機械学習の発話のインポート	ボットに機械学習の発話をインポートします。	発話のインポート	[テストおよびトレーニング] の [発話のインポート]
機械学習の発話のインポートのステータス	[機械学習の発話のAPIをインポート] で行った機械学習の発話のインポートリクエストのステータスを取得します。	発話のインポート	[テストおよびトレーニング] の [発話のインポート]
機械学習の発話のトレーニング	ボットの機械学習の発話を開始します。	機械学習をトレーニング	[テストおよびトレーニング] の [機械学習をトレーニング]
機械学習の発話のトレーニングのステータス	機械学習トレーニングのステータスを取得します。	機械学習をトレーニング	[テストおよびトレーニング] の [機械学習をトレーニング]
機械学習の発話のエクスポート	ボットの機械学習の発話をエクスポートします。	発話のエクスポート	[テストおよびトレーニング] の [発話のエクスポート]
機械学習の発話のエクスポートのステータス	機械学習の発話のエクスポートコピーのダウンロードリンクを取得します。	発話のエクスポート	[テストおよびトレーニング] の [発話のエクスポート]
FAQトレーニング	ナレッジグラフのトレーニングを開始します。	FAQをトレーニング	[テストおよびトレーニング] の [トレーニングFAQ]
NLPトレーニングステータス	FAQトレーニングのステータスを取得します。	FAQをトレーニング	[テストおよびトレーニング] の [トレーニングFAQ]
ファイルまたはURLからの抽出	ファイルまたはURLを使用してFAQを抽出します。	ナレッジグラフを管理	[ナレッジグラフを管理] の [ナレッジグラフを管理]
抽出履歴を取得	ナレッジグラフの抽出履歴のリストを取得します。	ナレッジグラフを管理	[ナレッジグラフを管理] の [ナレッジグラフを管理]
抽出に関する質問を取得	ナレッジグラフの抽出質問のリストを取得します。	ナレッジグラフを管理	[ナレッジグラフを管理] の [ナレッジグラフを管理]
KnowledgeTasksを取得	ノードを含むナレッジタスクのリストを取得します。	ナレッジグラフを管理	[ナレッジグラフを管理] の [ナレッジグラフを管理]
抽出から質問を追加	抽出したものの中で特定の質問をナレッジグラフに追加します。	ナレッジグラフを管理	[ナレッジグラフを管理] の [ナレッジグラフを管理]
FAQを取得	[ナレッジタスク] で質問とノードのリストを取得します。	ナレッジグラフを管理	[ナレッジグラフを管理] の [ナレッジグラフを管理]
NLP設定を更新	NLPのしきい値や設定を更新します。	NLP設定	[テストおよびトレーニング] の [NLP設定]

ボット分析API

API	説明	関連するアプリのスコープ
		ボットビルダー	ボット管理
インテントを見つける	NLPエンジンおよびMLエンジンからインテントの認識結果やスコアリングを取得します。	インテントおよびエンティティの検出	[インテント検出] の [インテントおよびエンティティの検出]
会話履歴	ボットとユーザーの間で交わされた会話メッセージを、逆の時系列で取得します。	チャット履歴	[ボットの分析] の [チャット履歴]
デバッグログ	特定の会話のデバッグログを取得します。	デバッグログ	NA
ChangeLogsを取得	指定した日付の期間にボット定義に加えられた変更内容リストを取得します。	ログ履歴	[ログ管理] の [ボットの監査ログ]
セッション履歴	作成された会話セッションを取得します。	ボットセッション	[ログ] の [ボットセッション]
ダッシュボードウィジェットデータ	ボットに追加された特定のカスタムダッシュボードから、ウィジェットのデータ結果を取得します。	カスタムレポート	[カスタムレポート] の [カスタムレポート]
分析を取得	APIを使用して、インテント検出やタスクの実行に関するメトリクスデータを抽出します	メトリクス	NA
ユーザーエンゲージメントのトレンド	一定期間にボットと対話したユーザー数を、異なる時間間隔で提供します。	ユーザーエンゲージメントのトレンド	NA

管理者API

API	説明	関連するボット管理アプリのスコープ
ボットを取得	アカウントで利用可能なボットのリストを取得します	[プロファイル管理] の [ロール管理]
ロールをインポート	ボットや管理者のロールをアカウントにインポートします	[プロファイル管理] の [ロール管理]
ロールを取得	アカウントで利用可能なボットまたは管理者のロールのリストを取得します。	[プロファイル管理] の [ロール管理]
ユーザーロールの詳細を取得	アカウント内のすべてのユーザーおよびそれに関連するロールの完全な情報を取得します	[プロファイル管理] の [ロール管理]
グループを取得	アカウントで利用可能なグループおよびグループメンバーのリストを取得します	[プロファイル管理] の [ロール管理]
ロールをエクスポート	ボットや管理者のロールをアカウントからエクスポートします	[プロファイル管理] の [ロール管理]
BTロールを割り当てる	特定のボットのまとまったユーザーにボットのロールを割り当てます	[プロファイル管理] の [ロール管理]
管理者ロールを割り当てる	管理者ロールからユーザーまたはグループを追加・削除します	[プロファイル管理] の [ロール管理]
ユーザーアクセスを更新	ボットビルダーへのアクセス機能を追加または削除し、新しいボットを作成します	[プロファイル管理] の [ロール管理]
ユーザーを作成	アカウントにユーザーを追加します	[ユーザー管理] の [ユーザー管理]
ユーザー情報を取得	ユーザーの詳細を取得します	[ユーザー管理] の [ユーザー管理]
ユーザーを更新	ユーザーの詳細を更新します	[ユーザー管理] の [ユーザー管理]
ユーザーをアカウントから削除	アカウントからユーザーを削除します	[ユーザー管理] の [ユーザー管理]
顧客データを削除	顧客データを削除します	[プロファイル管理] の [ユーザーデータを削除]
顧客データステータスAPIを削除	顧客データの削除リクエストのステータスを取得します	[プロファイル管理] の [ユーザーデータを削除]
管理者コンソールの監査ログ	管理者コンソールの監査ログを取得します	[ログ管理] の [管理者コンソールの監査ログ]

データ（データテーブル）のアクセスAPI

API	説明	関連するアプリのスコープ
データを挿入	データテーブルにデータを挿入します	データテーブルへの書き込みのアクセス
大量のデータを挿入	データテーブルに大量のデータを挿入します	データテーブルへの書き込みのアクセス
データを更新	データテーブルのデータを更新します	データテーブルへの読み込みおよび書き込みのアクセス
データを削除	データテーブルからデータを削除します	データテーブルへの読み込みおよび削除のアクセス
テーブルデータを取得	データテーブルからデータを取得します	データテーブルへの読み込みのアクセス
ビューデータを取得	データビューからデータを取得します	テーブルビューへの読み込みのアクセス

On this Page

API List

Following is the list of APIs available from the Kore.ai Bots Platform. For details on the API functioning and usage instructions refer here.

These APIs are available for testing in your Postman setup, for configuration details see here.

Based on the functionality addressed, the APIs can be categorized as:

APIs related to the Bot Definition functionality, more
APIs related to NLP training, more
APIs aiding in Analyzing the bot performance and behavior, more
APIs related to the Admin Console functionality, more
APIs related to the data access from Data Tables, more

Bot Definition APIs

API	Description	Associated App Scope
		Bot Builder	Bot Admin
Upload File	To upload the `botdefinition`, `botconfig`, and `botfunction` file (if any) as well as the bot icon to the local server and get the file ID to be used in Import Bot API.	NA	Bot Import under Bot Definition
Import Bot as a New Bot	To create a new bot in the account owner’s Builder Tool using the File IDs generated by uploading the files.	NA	Bot Import under Bot Definition
Import Bot into an Existing Bot	To import bot definition file into an existing bot for upgrading to a new version or restoring to an earlier version	NA	Bot Import under Bot Definition
Bot Import Status	To get the status of the bot import request.	NA	Bot Import under Bot Definition
Install Sample Bot	To install a sample bot.	NA	Bot Create under Bot Definition
Bot Export	To export a bot definition and all associated components.	Bot Export	Bot Export under Bot Definition
Bot Export – Status	To get the status of Bot Export request and also provides the download link of the bot export copy after the export is completed.	Bot Export	Bot Export under Bot Definition
Enable Channel	To enable or update a channel for a bot.	NA	Channel Management under ChannelManagement
Publish Bot	To initiate a publish request for a bot.	NA	Publish under Bot Publish
Bot Variables Import	To import global and content variables into the bot.	Import Variables	NA
Batch Test Execution	To invoke the execution of a Batch Test suite.	Batch Tests Execution	NA
Batch Test Execution Status	To know the status of the of the execution against a unique Test Request Id	Batch Tests Execution	NA
Get Batch Test Suites	To get the list of Batch Test Suites available for a bot	Batch Tests Management	Batch Tests Management
Export Batch Test Suite	To export the test cases of a given Batch Test Suite	Batch Tests Management	Batch Tests Management
Import Batch Test Suite	To import a batch test wuite	Batch Tests Management	Batch Tests Management
Delete Batch Test Suite	To delete a Batch Test Suite	Batch Tests Management	Batch Tests Management
Delete Batch Test Suite Execution	To delete a specific execution of a Batch Test Suite	Batch Tests Management	Batch Tests Management

NLP Training APIs

API	Description	Associated App Scope
		Bot Builder	Bot Admin
ML Utterances Import	To import ML Utterances into a bot.	Utterances Import	Utterances Import under Test & Train
ML Utterances Import Status	To get the status of the ML utterances import request made through Import ML Utterances API.	Utterances Import	Utterances Import under Test & Train
ML Utterance Train	To initiate ML training of a bot.	Train ML	Train ML under Test & Train
ML Utterance Train Status	To get the status of the ML training.	Train ML	Train ML under Test & Train
ML Utterances Export	To export the ML utterances of a bot.	Utterances Export	Utterances Export under Test & Train
ML Utterances Export Status	To get the download link of the ML Utterances export copy.	Utterances Export	Utterances Export under Test & Train
FAQ Training	To initiate the training of the knowledge graph.	Train Faq	Train Faq under Test & Train
FAQ Training Status	To get the status of the FAQ training.	Train Faq	Train Faq under Test & Train
Extraction from file or URL	To extract FAQs using file or URL.	Manage Knowledge Graph	Manage Knowledge Graph under Manage Knowledge Graph
Get Extractions History	To get a list of KG Extractions history.	Manage Knowledge Graph	Manage Knowledge Graph under Manage Knowledge Graph
Get Extraction Question	To get a list of KG Extraction Questions.	Manage Knowledge Graph	Manage Knowledge Graph under Manage Knowledge Graph
Get KnowledgeTasks	To get a listing of knowledge Tasks along with the nodes.	Manage Knowledge Graph	Manage Knowledge Graph under Manage Knowledge Graph
Add Questions from Extraction	To add specific questions from extraction to the Knowledge Graph.	Manage Knowledge Graph	Manage Knowledge Graph under Manage Knowledge Graph
Get FAQs	To get a list of questions and nodes under the Knowledge task.	Manage Knowledge Graph	Manage Knowledge Graph under Manage Knowledge Graph
Update NLP Configurations	To update the NLP thresholds and configurations.	NLP Configurations	NLP Configurations under Test & Train

Bot Analytics APIs

API	Description	Associated App Scope
		Bot Builder	Bot Admin
Find Intent	To obtain the intent recognition result and the scoring from NLP and ML engines.	Intent and Entity Detection	Intent and Entity Detection under Intent Detection
Conversation History	To fetch the conversational messages between the bot and user in reverse chronological order.	Chat History	Chat History under Bot Analytics
Debug Logs	To get debug logs of a specific conversation.	Debug Logs	NA
Get ChangeLogs	To get the list of changes made to the bot definition for a given date period.	Logs History	Bot Audit Logs under Logs Admin
Sessions History	To retrieve the conversation sessions created.	Bot Sessions	Bot Sessions under Logs
Dashboard Widget Data	To get the data result of a widget from a specific Custom Dashboard added to a bot.	Custom Reports	Custom Reports under Custom Reports
Get Analytics	To extract the metrics data related to the intent detection and task performance using API	Metrics	NA
User Engagement Trend	To provide the number of users who have interacted with the bot in a given period across different time intervals.	User Engagement Trend	NA

Admin APIs

API	Description	Associated Bot Admin App Scope
Get Bots	To retrieve the list of bots available in an account	Role Management under Profile Management
Import Roles	To import bot or admin roles into an account	Role Management under Profile Management
Get Roles	To retrieve the list of bot or admin roles available in an account.	Role Management under Profile Management
Get User Roles Details	To get full information of all users and their associated roles in the account	Role Management under Profile Management
Get Groups	To get the list of groups and group members available in the account	Role Management under Profile Management
Export Roles	To export bot or admin roles from an account	Role Management under Profile Management
Assign BT Roles	To assign a bot role to a set of users in a specific bot	Role Management under Profile Management
Assign Admin Roles	To add or remove users or groups from admin roles	Role Management under Profile Management
Update User Access	To add or remove the ability to access bot builder, create new bots	Role Management under Profile Management
Create Users	To add users to an account	User Management under User Management
Get Users Information	To retrieve the user details	User Management under User Management
Update Users	To update user details	User Management under User Management
Remove Users from Account	To remove users from an account	User Management under User Management
Delete Customer Data	To delete customer data	Delete Users Data under Profile Management
Delete Customer Data Status API	To get the status of the Customer Data Delete request	Delete Users Data under Profile Management
Admin Console Audit Logs	To get admin console audit logs	Admin Console Audit Logs under Logs Admin

Data (Data Table) Access APIs

API	Description	Associated App Scope
Insert Data	To insert data into Data Table	Write access to the Data Table
Insert Bulk Data	To insert bulk data into Data Table	Write access to the Data Table
Update Data	To update data into Data Table	Read and Write access to the Data Table
Delete Data	To delete data from Data Table	Read and Delete access to the Data Table
Get Table Data	To get data from Data Table	Read access to the Data Table
Get View Data	To get data from Data View	Read access to the Table View

On this Page