はじめに
対話型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. SDKs
  5. SDK App Registration

SDK App Registration

This topic describes how to register your application and generate credentials for your clients that are required to exchange messages between your application and the Kore.ai XO Platform.

When you register your app, you will need to select a security algorithm:

  • HS256 / HS512 – XO Platform generates and displays the Client ID and Client Secret necessary to generate the JWT token from your server.
  • RS256 / RS512 – Upload your public key to the platform and use the private key to generate the signature from your server.

To register an app:

  1. Open the assistant that you are working with.
  2. Select the Deploy tab from the top menu.
  3. From the left menu, click Channel > Web/Mobile Client.

  4. In the Select App drop-down list, select your existing app registration or click Create App to create a new app.

  5. In the Name field, enter the name for the app registration used in Bot Builder. For example, weather app.
  6. Select one of these scopes for the app:
    • Allow anonymous users to chat with the bot: Enables anonymous users to interact with the bot.
    • Auto register new users on Kore.ai Bots Platform: Select to control the auto-user registration in Kore.ai if the user assertion is unknown.
  7. In the JWT Signing Algorithms Used For Client App Authentication drop-down list, select one of the following security algorithms:
    • RS256/RS512: Select to enable the Public Key. The Private key, used for encryption, is provided by the user, and the Public key, used for decryption, is provided by the Platform. Both the keys have to be used for generating the token. The Public Key is used by the XO Platform to authenticate the client application.
    • HS256/HS512: Select to generate a Secret Key and a Client ID. The Client ID is required for app initialization, and the Secret Key is used by the XO Platform to authenticate the client application.
  8. (Optional) In the Push Notifications section, click Enable and then specify a URL to send the notifications.
  9. When you Enable the Push Notifications, you can select one of the following options to manage the notifications:
    • All Messages – Sends push notifications for all conversation messages to the client app.
    • Message Delivery Failures – Sends push notifications for failure scenarios such as WebSocket Disconnected, App is Killed, and Message Delivery Failure.
  10. To customize the display messages for the push notifications messages sent to the client app, select one of the following options:
    • Send Original Messages – Sends the actual conversation message as part of the push notification.
    • Show a standard message from standard responses – Sends a generic message instead of the original message.
    • Click Manage Responses to add custom messages in the push notification. To learn more about adding responses, see Default Standard Responses and Default Conversations.
  11. Click Save and then Create. The app registration details appear.
  12. To copy the app registration details to the clipboard for your application, you can click Copy for Bot Name, Bot ID, and Client ID. For Client Secret, click View, and then click Copy.
  13. In the Allow Alert Task Setup section, select Yes to enable your application users to set up their own alert tasks using the web client. By default, this setting is disabled for web client users, but mobile client users can always setup their own alerts.
  14. In the Enable Channel section, select Yes to enable the channel immediately after saving.
  15. Click Save to save the settings and close the Web/Mobile Client Channel page.

The Channel Information updated successfully message is displayed on the top-right corner of the page.

Once the app is registered, you can implement it using one of the methods presented under App Details, as follows:

  1. Share the URL with the users to interact with your virtual assistant.
  2. Embed HTML: Copy and paste the HTML code before the end of the BODY tag on every page of the application where you want to display the chat widget. Know more

SDK App Registration

This topic describes how to register your application and generate credentials for your clients that are required to exchange messages between your application and the Kore.ai XO Platform.

When you register your app, you will need to select a security algorithm:

  • HS256 / HS512 – XO Platform generates and displays the Client ID and Client Secret necessary to generate the JWT token from your server.
  • RS256 / RS512 – Upload your public key to the platform and use the private key to generate the signature from your server.

To register an app:

  1. Open the assistant that you are working with.
  2. Select the Deploy tab from the top menu.
  3. From the left menu, click Channel > Web/Mobile Client.

  4. In the Select App drop-down list, select your existing app registration or click Create App to create a new app.

  5. In the Name field, enter the name for the app registration used in Bot Builder. For example, weather app.
  6. Select one of these scopes for the app:
    • Allow anonymous users to chat with the bot: Enables anonymous users to interact with the bot.
    • Auto register new users on Kore.ai Bots Platform: Select to control the auto-user registration in Kore.ai if the user assertion is unknown.
  7. In the JWT Signing Algorithms Used For Client App Authentication drop-down list, select one of the following security algorithms:
    • RS256/RS512: Select to enable the Public Key. The Private key, used for encryption, is provided by the user, and the Public key, used for decryption, is provided by the Platform. Both the keys have to be used for generating the token. The Public Key is used by the XO Platform to authenticate the client application.
    • HS256/HS512: Select to generate a Secret Key and a Client ID. The Client ID is required for app initialization, and the Secret Key is used by the XO Platform to authenticate the client application.
  8. (Optional) In the Push Notifications section, click Enable and then specify a URL to send the notifications.
  9. When you Enable the Push Notifications, you can select one of the following options to manage the notifications:
    • All Messages – Sends push notifications for all conversation messages to the client app.
    • Message Delivery Failures – Sends push notifications for failure scenarios such as WebSocket Disconnected, App is Killed, and Message Delivery Failure.
  10. To customize the display messages for the push notifications messages sent to the client app, select one of the following options:
    • Send Original Messages – Sends the actual conversation message as part of the push notification.
    • Show a standard message from standard responses – Sends a generic message instead of the original message.
    • Click Manage Responses to add custom messages in the push notification. To learn more about adding responses, see Default Standard Responses and Default Conversations.
  11. Click Save and then Create. The app registration details appear.
  12. To copy the app registration details to the clipboard for your application, you can click Copy for Bot Name, Bot ID, and Client ID. For Client Secret, click View, and then click Copy.
  13. In the Allow Alert Task Setup section, select Yes to enable your application users to set up their own alert tasks using the web client. By default, this setting is disabled for web client users, but mobile client users can always setup their own alerts.
  14. In the Enable Channel section, select Yes to enable the channel immediately after saving.
  15. Click Save to save the settings and close the Web/Mobile Client Channel page.

The Channel Information updated successfully message is displayed on the top-right corner of the page.

Once the app is registered, you can implement it using one of the methods presented under App Details, as follows:

  1. Share the URL with the users to interact with your virtual assistant.
  2. Embed HTML: Copy and paste the HTML code before the end of the BODY tag on every page of the application where you want to display the chat widget. Know more
メニュー