以下は、Kore.aiボットプラットフォームで利用できる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 | 説明 | 関連するアプリのスコープ |
|---|---|---|
| データを挿入 | データテーブルにデータを挿入します | データテーブルへの書き込みのアクセス |
| 大量のデータを挿入 | データテーブルに大量のデータを挿入します | データテーブルへの書き込みのアクセス |
| データを更新 | データテーブルのデータを更新します | データテーブルへの読み込みおよび書き込みのアクセス |
| データを削除 | データテーブルからデータを削除します | データテーブルへの読み込みおよび削除のアクセス |
| テーブルデータを取得 | データテーブルからデータを取得します | データテーブルへの読み込みのアクセス |
| ビューデータを取得 | データビューからデータを取得します | テーブルビューへの読み込みのアクセス |