はじめに
対話型AIプラットフォーム
チャットボットの概要
自然言語処理(NLP)
ボットの概念と用語
クイックスタートガイド
プラットフォームへのアクセス
ボットビルダーの操作
リリースノート
最新バージョン(英語)
以前のバージョン(英語)
廃止機能(英語)
コンセプト
設計
ストーリーボード
ダイアログタスク
ダイアログタスクとは
ダイアログビルダー
ノードタイプ
インテントノード
ダイアログノード
エンティティノード
フォームノード
確認ノード
ロジックノード
ボットアクションノード
サービスノード
Webhookノード
スクリプトノード
グループノード
エージェント転送ノード
ユーザープロンプト
音声通話プロパティ
イベント ハンドラー
ナレッジグラフ
ナレッジグラフの抽出
ナレッジグラフの構築
ボットにナレッジグラフを追加
グラフの作成
ナレッジグラフの構築
既存のソースからFAQを構築
特性、同義語、停止用語
変数ネームスペースの管理
更新
ノード間の質問と回答の移動
用語の編集と削除
質問と応答の編集
ナレッジグラフの分析
通知タスク
スモールトーク
デジタルスキル
デジタルフォーム
デジタルビュー
デジタルビューとは
パネル
ウィジェット
トレーニング
トレーニングとは
機械学習
機械学習とは
モデル検証
ファンダメンタルミーニング
ナレッジグラフ
示唆
ランキングおよび解決
NLPの詳細設定
NLPのガイドライン
インテリジェンス
インテリジェンスとは
コンテキスト
コンテキストインテント
割り込み
複数インテントの検出
エンティティの変更
デフォルトの会話
センチメント管理
トーン分析
テストとデバッグ
ボットと会話
発話テスト
バッチテスト
会話テスト
デプロイ
チャネル
公開
分析
ボットの分析
NLPメトリクス
会話フロー
Usage Metrics
封じ込め測定
カスタムダッシュボード
カスタムダッシュボードとは
メタタグ
カスタムダッシュボードとウィジェット
ユニバーサルボット
ユニバーサルボットとは
ユニバーサルボットの定義
ユニバーサルボットの作成
ユニバーサルボットのトレーニング
ユニバーサルボットのカスタマイズ
他言語の有効化
ストア
プラントと使用
Overview
Usage Plans
Support Plans
Invoices
管理
ボット認証
複数言語対応ボット
個人を特定できる情報の編集
ボット変数の使用
IVRのシステム連携
一般設定
ボット管理
ハウツー
会話スキルの設計
バンキングボットを作成
バンキングボット – 資金の振り替え
バンキングボット – 残高を更新
ナレッジグラフを構築
スマートアラートの予約方法
デジタルスキルの設計
デジタルフォームの設定方法
デジタルビューの設定方法
データテーブルのデータの追加方法
データテーブルのデータの更新方法
Add Data from Digital Forms
ボットのトレーニング
示唆の使用方法
インテントとエンティティのパターンの使用方法
コンテキスト切り替えの管理方法
ボットのデプロイ
エージェント転送の設定方法
ボット関数の使用方法
コンテンツ変数の使用方法
グローバル変数の使用方法
Web SDK Tutorial(英語)
Widget SDK Tutorial(英語)
ボットの分析
カスタムダッシュボードの作成方法
カスタムタグを使ってフィルタリング
管理
ボット管理者コンソール
ダッシュボード
ユーザーの管理
ユーザーの管理
グループの管理
ロール管理
ボット管理モジュール
登録
ユーザーの招待
招待状の一括送信
ユーザーデータのインポート
Active Directoryからユーザーを同期
セキュリティ/コンプライアンス
シングル サインオンの使用
セキュリティ設定
Billing(日本未対応)
  1. ホーム
  2. Docs
  3. Virtual Assistants
  4. API Guide
  5. Using XO Platform APIs

Using XO Platform APIs

The XO Platform allows you to develop Virtual Assistants using secured APIs. All key developer activities like creation, import and export, training, and publishing are available using these APIs. Key account management activities like managing XO Platform access, managing admin, and roles can also be performed via secured public APIs. For a complete list of APIs and usage instructions, refer here.

Authentication of the API requests involves the following two steps:

  1. Create an App: An App helps you create secure authentication credentials to access the XO Platform features. You can associate the app for enabling BotKit, APIs, SDKs, and Channels.
  2. Assign API Scopes to an App: Assigning API scopes to the app allows the app to access the Platform APIs securely:
    • XO Platform API Scopes: Developers can assign appropriate API Scopes to the app to access respective Platform features for a virtual assistant.
    • Bot Admin Console API Scopes: Account administrators can assign API Scopes to the app to access respective features in any virtual assistants built into their accounts on the Platform.

Creating and Managing Apps in XO Platform

Steps to create a Client App from the XO Platform:

  1. Go to Deploy > APIs & Extensions > Manage Apps.
  2. If you are creating an app for the first-time, click the Create App button. Otherwise, click the New App button.
  3. On the Create Client App page, enter a name for the app.
  4. Select Enforce JTI, JWE, or both as per your requirements to secure the connections with the Platform:
    • Enforce JTI (JWT ID) Claim – Once enabled, the Platform accepts the requests only from calls with the JTI Claim in the requests and those without JTI Claim are rejected.
    • Enforce JWE Encryption (Generating JWT token) – To access the XO Platform’s public APIs, the application making the API request requires authentication. Kore.ai uses the JWT (JSON Web Token) mechanism to handle the authentication. For a quick overview of the JWT token, read Introduction to JWT tokens.
  5. Click Next and Done.
    You are directed to the Manage Apps page, which lists all the apps associated with this virtual assistant.
     
  6. Click the app name or anywhere in the row to see the app’s details, such as Bot Name, Bot ID, Client ID, and Client Secret. Also, the App Usage column lists where this app is used – Web SDK, BotKit, APIs, WebHook and IVR Channels.
    Note: Use the Client ID and Client Secret of the client app from above to generate a JWT token. This token must be passed as a part of each API request for authorization.
  7. To delete apps, click the Delete icon against the respective app.
    Note: Only the Bot Owner can delete an app.

Creating and Managing Apps in Bots Admin Console

Steps to create a Client App from the Bot Admin Console:

  1. Log in to the Admin Console.
  2. Go to Security & Control > API Scopes.
  3. On the API Scopes page, click New.
  4. Click the Manage Apps link to create a new app.
  5. Click New App and then do the following:
    • Enter a name.
    • Select Enforce JTI, JWE, or both as per your requirements.
  6. Click Save.

Data Tables

Access control from the Data Tables module is different from the XO Platform and Bot Admin Console access controls.

You can define apps to securely access the data from data tables and data views.

  • You can create one or more apps, Learn more.
  • These apps can be used for:
    • Accessing the data tables and views over public APIs.
    • Accessing the data tables and views using Service Node.
    • Accessing the export and import API for the definition of data table and views.
  • You can grant this app read, write, and delete permissions to each table and view separately, Learn more.

Associating API Scopes

Once you create a client app, you can associate it with API scopes.

Adding API Scopes in the XO Platform

Steps to associate API Scopes to a Client App from the XO Platform:

  1. Go to Deploy > API & EXTENSIONs > API Scopes and click Create API Scope.
  2. On the New API Scope Mapping page, from the App drop-down list, select an existing client app for authentication.
  3. The app’s Client ID and Client Secret are displayed on the screen. Copy these values.

  4. Under the Scopes section, select the appropriate scopes to allow the client app to access the respective APIs. (If appropriate scopes are not selected, then the client apps cannot access the APIs).
  5. Click Save.

Adding API Scopes in the Bots Admin Console

Steps to associate API Scopes to a Client App from the Bot Admin Console:

  1. Log in to the Admin Console.
  2. Go to Security & Control > API Scopes.
  3. On the API Scopes page, click New.
  4. On the New API Scope Mapping page, from the App drop-down list, select an existing client app for authentication.
  5. Click the Manage Apps link to create a new app.
  6. Once you select an app, the Client ID and Client Secret appear. Copy these values.
  7. Under the Scopes section, select the appropriate Scopes to allow the client app to access the respective APIs.Learn more.
  8. Click Save. The app and associated scopes are listed on the API Scopes page.
  9. If you want to delete an app and its associated API Scope, click the Delete icon against the respective app.

List of Available API Scopes

SCOPE DESCRIPTION
Intent and Entity Detection Assign this scope to allow intent and entity detection from an utterance using secured APIs.
User Engagement Trend To retrieve the user engagement trend.
Batch Tests Execution To execute Batch Test Suites and get results.
Batch Tests Management To create, modify and delete Batch Test Suites and results.
Chat History Assign this scope to retrieve chat transcripts of this assistant using secured APIs.
Debug Logs Assign this scope to retrieve debug logs of this assistant using secured APIs.
Bot Export Export definition of a selected assistant.
Import Variables Assign this scope to import variables of this assistant using secured APIs.
Export Variables Assign this scope to export variables of this assistant using secured APIs.
Proactive Messages To proactively send messages to the end-users via the supported channels.
Train ML To match a given utterance against the NL model to identify possible intents and entities present in the utterance.
Train FAQ To match a given FAQ against the FAQ model.
Utterances Import To import utterances for a task.
Utterances Export To export utterances for a task.
Logs History To retrieve the change logs for the particular assistant.
Bot Sessions Assign this scope to retrieve conversation sessions.
Billing Sessions Assign this scope to retrieve billing sessions.
Custom Reports To retrieve the data associated with custom widgets and reports.
RCS Message Events Assign this scope for opting in users to RCS Business Messaging channel and sending broadcast messages.
Metrics Assign this scope to retrieve Metrics information related to Intents Found, Intents not Found, Failed Tasks, Successful Tasks and Performance Logs.
Manage Knowledge Graph To export the complete definition of the Knowledge Graph of this assistant.
NLP Configurations Assign this scope to update the NLP thresholds and configurations.
Update FAQs Assign this scope to update the FAQ Responses and FAQ Status.
Note: Once enabled, the API Scopes must be Published. Follow the Publish process to ensure that the API Scopes are selected.

Generating the JWT Token

Once you have associated the API scopes with a client app, you must generate the JWT token for API requests.

Steps to generate the token:

  1. Visit https://developer.kore.ai/tools/jwt/.
  2. In the Algorithm drop-down list, select HS256.
  3. Scroll down to the Decoded section, and update the Playload and the Secret.
      1. Replace the content of the Payload field with the code block shown below, and add the Client ID of the app copied in the previous section.
        {
        "sub": "1234567890",
        "appId": "add-Client-ID-here"
        }
    Note: The XO Platform validates the token only when it is entered exactly as “appId”. Don’t use “App ID”, “appid”, or “app ID”.
  4. In the Verify Signature field, replace your-256-bit-secret with the Client Secret copied in the previous section.
  • Click Copy JWT to copy the generated token. You can pass this token as a part of the API request for authorization.

Using XO Platform APIs

The XO Platform allows you to develop Virtual Assistants using secured APIs. All key developer activities like creation, import and export, training, and publishing are available using these APIs. Key account management activities like managing XO Platform access, managing admin, and roles can also be performed via secured public APIs. For a complete list of APIs and usage instructions, refer here.

Authentication of the API requests involves the following two steps:

  1. Create an App: An App helps you create secure authentication credentials to access the XO Platform features. You can associate the app for enabling BotKit, APIs, SDKs, and Channels.
  2. Assign API Scopes to an App: Assigning API scopes to the app allows the app to access the Platform APIs securely:
    • XO Platform API Scopes: Developers can assign appropriate API Scopes to the app to access respective Platform features for a virtual assistant.
    • Bot Admin Console API Scopes: Account administrators can assign API Scopes to the app to access respective features in any virtual assistants built into their accounts on the Platform.

Creating and Managing Apps in XO Platform

Steps to create a Client App from the XO Platform:

  1. Go to Deploy > APIs & Extensions > Manage Apps.
  2. If you are creating an app for the first-time, click the Create App button. Otherwise, click the New App button.
  3. On the Create Client App page, enter a name for the app.
  4. Select Enforce JTI, JWE, or both as per your requirements to secure the connections with the Platform:
    • Enforce JTI (JWT ID) Claim – Once enabled, the Platform accepts the requests only from calls with the JTI Claim in the requests and those without JTI Claim are rejected.
    • Enforce JWE Encryption (Generating JWT token) – To access the XO Platform’s public APIs, the application making the API request requires authentication. Kore.ai uses the JWT (JSON Web Token) mechanism to handle the authentication. For a quick overview of the JWT token, read Introduction to JWT tokens.
  5. Click Next and Done.
    You are directed to the Manage Apps page, which lists all the apps associated with this virtual assistant.
     
  6. Click the app name or anywhere in the row to see the app’s details, such as Bot Name, Bot ID, Client ID, and Client Secret. Also, the App Usage column lists where this app is used – Web SDK, BotKit, APIs, WebHook and IVR Channels.
    Note: Use the Client ID and Client Secret of the client app from above to generate a JWT token. This token must be passed as a part of each API request for authorization.
  7. To delete apps, click the Delete icon against the respective app.
    Note: Only the Bot Owner can delete an app.

Creating and Managing Apps in Bots Admin Console

Steps to create a Client App from the Bot Admin Console:

  1. Log in to the Admin Console.
  2. Go to Security & Control > API Scopes.
  3. On the API Scopes page, click New.
  4. Click the Manage Apps link to create a new app.
  5. Click New App and then do the following:
    • Enter a name.
    • Select Enforce JTI, JWE, or both as per your requirements.
  6. Click Save.

Data Tables

Access control from the Data Tables module is different from the XO Platform and Bot Admin Console access controls.

You can define apps to securely access the data from data tables and data views.

  • You can create one or more apps, Learn more.
  • These apps can be used for:
    • Accessing the data tables and views over public APIs.
    • Accessing the data tables and views using Service Node.
    • Accessing the export and import API for the definition of data table and views.
  • You can grant this app read, write, and delete permissions to each table and view separately, Learn more.

Associating API Scopes

Once you create a client app, you can associate it with API scopes.

Adding API Scopes in the XO Platform

Steps to associate API Scopes to a Client App from the XO Platform:

  1. Go to Deploy > API & EXTENSIONs > API Scopes and click Create API Scope.
  2. On the New API Scope Mapping page, from the App drop-down list, select an existing client app for authentication.
  3. The app’s Client ID and Client Secret are displayed on the screen. Copy these values.

  4. Under the Scopes section, select the appropriate scopes to allow the client app to access the respective APIs. (If appropriate scopes are not selected, then the client apps cannot access the APIs).
  5. Click Save.

Adding API Scopes in the Bots Admin Console

Steps to associate API Scopes to a Client App from the Bot Admin Console:

  1. Log in to the Admin Console.
  2. Go to Security & Control > API Scopes.
  3. On the API Scopes page, click New.
  4. On the New API Scope Mapping page, from the App drop-down list, select an existing client app for authentication.
  5. Click the Manage Apps link to create a new app.
  6. Once you select an app, the Client ID and Client Secret appear. Copy these values.
  7. Under the Scopes section, select the appropriate Scopes to allow the client app to access the respective APIs.Learn more.
  8. Click Save. The app and associated scopes are listed on the API Scopes page.
  9. If you want to delete an app and its associated API Scope, click the Delete icon against the respective app.

List of Available API Scopes

SCOPE DESCRIPTION
Intent and Entity Detection Assign this scope to allow intent and entity detection from an utterance using secured APIs.
User Engagement Trend To retrieve the user engagement trend.
Batch Tests Execution To execute Batch Test Suites and get results.
Batch Tests Management To create, modify and delete Batch Test Suites and results.
Chat History Assign this scope to retrieve chat transcripts of this assistant using secured APIs.
Debug Logs Assign this scope to retrieve debug logs of this assistant using secured APIs.
Bot Export Export definition of a selected assistant.
Import Variables Assign this scope to import variables of this assistant using secured APIs.
Export Variables Assign this scope to export variables of this assistant using secured APIs.
Proactive Messages To proactively send messages to the end-users via the supported channels.
Train ML To match a given utterance against the NL model to identify possible intents and entities present in the utterance.
Train FAQ To match a given FAQ against the FAQ model.
Utterances Import To import utterances for a task.
Utterances Export To export utterances for a task.
Logs History To retrieve the change logs for the particular assistant.
Bot Sessions Assign this scope to retrieve conversation sessions.
Billing Sessions Assign this scope to retrieve billing sessions.
Custom Reports To retrieve the data associated with custom widgets and reports.
RCS Message Events Assign this scope for opting in users to RCS Business Messaging channel and sending broadcast messages.
Metrics Assign this scope to retrieve Metrics information related to Intents Found, Intents not Found, Failed Tasks, Successful Tasks and Performance Logs.
Manage Knowledge Graph To export the complete definition of the Knowledge Graph of this assistant.
NLP Configurations Assign this scope to update the NLP thresholds and configurations.
Update FAQs Assign this scope to update the FAQ Responses and FAQ Status.
Note: Once enabled, the API Scopes must be Published. Follow the Publish process to ensure that the API Scopes are selected.

Generating the JWT Token

Once you have associated the API scopes with a client app, you must generate the JWT token for API requests.

Steps to generate the token:

  1. Visit https://developer.kore.ai/tools/jwt/.
  2. In the Algorithm drop-down list, select HS256.
  3. Scroll down to the Decoded section, and update the Playload and the Secret.
      1. Replace the content of the Payload field with the code block shown below, and add the Client ID of the app copied in the previous section.
        {
        "sub": "1234567890",
        "appId": "add-Client-ID-here"
        }
    Note: The XO Platform validates the token only when it is entered exactly as “appId”. Don’t use “App ID”, “appid”, or “app ID”.
  4. In the Verify Signature field, replace your-256-bit-secret with the Client Secret copied in the previous section.
  • Click Copy JWT to copy the generated token. You can pass this token as a part of the API request for authorization.
メニュー